openstack
/
nova
Code Issues Proposed changes

api-ref: document valid GET /os-migrations?migration_type values 

There are only four valid values for the migration_type filter
when listing migrations so let's document them for the request
parameter. Note that the API jsonschema validation does not
restrict the values since the filter parameter pre-dated jsonschema
validation for query parameters. Specifying an invalid value would
just result in no results from the DB query.

Change-Id: I7fee254edefd524633af62d80cb47009b1cf010b
This commit is contained in:
Matt Riedemann 2019-08-06 18:40:48 -04:00
parent 92e1e0736d
commit ebd68b3d1e
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/source/parameters.yaml
View File

@ -1050,7 +1050,12 @@ migration_status:
type: string
migration_type:
description: |
The type of migration to filter.
The type of migration to filter. Valid values are:
* ``evacuation``
* ``live-migration``
* ``migration``
* ``resize``
in: query
required: false
type: string