Updated flavors doc

Flavor with special characters in flavor ID is not allowed to create

Closes-Bug: 1920938
Change-Id: I600ae07f7fb039c9ccf461c4bf74ae42d9a3744f
This commit is contained in:
Amit Uniyal 2022-09-16 10:49:09 +00:00
parent 797779688f
commit b7356303cd
2 changed files with 12 additions and 2 deletions

View File

@ -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),

View File

@ -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