diff options
| author | Amit Uniyal <auniyal@redhat.com> | 2022-09-16 10:49:09 +0000 |
|---|---|---|
| committer | Amit Uniyal <auniyal@redhat.com> | 2022-09-17 17:40:52 +0000 |
| commit | b7356303cdfd9df42b9fea7ab51cb85de7318dad (patch) | |
| tree | 891bfc29197485074b9885e228fc1c5e4206ec42 /api-ref | |
| parent | 797779688f0515cfa5eb58f935a376cbc08d33e4 (diff) | |
| download | nova-b7356303cdfd9df42b9fea7ab51cb85de7318dad.tar.gz | |
Updated flavors doc
Flavor with special characters in flavor ID is not allowed to create
Closes-Bug: 1920938
Change-Id: I600ae07f7fb039c9ccf461c4bf74ae42d9a3744f
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/flavors.inc | 9 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 5 |
2 files changed, 12 insertions, 2 deletions
diff --git a/api-ref/source/flavors.inc b/api-ref/source/flavors.inc index 0216ce2983..52577667ec 100644 --- a/api-ref/source/flavors.inc +++ b/api-ref/source/flavors.inc @@ -60,6 +60,15 @@ Creates a flavor. Creating a flavor is typically only available to administrators of a cloud because this has implications for scheduling efficiently in the cloud. +.. note:: + Flavors with special characters in the flavor ID, except the hyphen '-', + underscore '_', spaces and dots '.', are not permitted. + + Flavor IDs are meant to be UUIDs. Serialized strings separated/grouped by "-" + represent the default flavor ID or UUID. eg: 01cc74d8-4816-4bef-835b-e36ff188c406. + + Only for backward compatibility, an integer as a flavor ID is permitted. + Normal response codes: 200 Error response codes: badRequest(400), unauthorized(401), forbidden(403), diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index ad5e72fb9b..aba8185a4b 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -3129,8 +3129,9 @@ flavor_id_body_2_46: max_version: 2.46 flavor_id_body_create: description: | - The ID of the flavor. While people often make this look like an int, this - is really a string. If not provided, this defaults to a uuid. + Only alphanumeric characters with hyphen '-', underscore '_', spaces + and dots '.' are permitted. If an ID is not provided, then a default UUID + will be assigned. in: body required: false type: string |