From ebd68b3d1e29beddb77704cb3f294a2f90f7334f Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 6 Aug 2019 18:40:48 -0400 Subject: [PATCH] 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 --- api-ref/source/parameters.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 41cd1a672c..fdadca4177 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -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