Skip to content

Commit

Permalink
Updated flavors doc
Browse files Browse the repository at this point in the history
Flavor with special characters in flavor ID is not allowed to create

Closes-Bug: 1920938
Change-Id: I600ae07f7fb039c9ccf461c4bf74ae42d9a3744f
  • Loading branch information
Amit Uniyal committed Sep 17, 2022
1 parent 7977796 commit b735630
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
9 changes: 9 additions & 0 deletions api-ref/source/flavors.inc
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
5 changes: 3 additions & 2 deletions api-ref/source/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b735630

Please sign in to comment.