Add description for resource class creation

POST /placement/resource_classes with incorrect format body
of the resource class name lead to something like:

JSON does not validate: u'_FPGA' does not match '^CUSTOM\\_[A-Z0-9_]+$'
with return code 400

we should add this into doc

Change-Id: Iab264f6d731a5f757a992d9bd148e7eb30922b9d
This commit is contained in:
jichenjc 2017-09-25 08:23:21 +08:00 committed by Matt Riedemann
parent ac75c747d0
commit 5f5c94d38d
1 changed files with 7 additions and 1 deletions

View File

@ -37,12 +37,18 @@ Create resource class
.. rest_method:: POST /resource_classes
Create a new resource class.
Create a new resource class. The new class must be a *custom* resource class,
prefixed with `CUSTOM_` and distinct from the
`standard <https://docs.openstack.org/os-traits/latest/>`__
resource classes.
Normal Response Codes: 201
Error response codes: badRequest(400), conflict(409)
A `400 BadRequest` response code will be returned if the resource class
does not have prefix `CUSTOM_`.
A `409 Conflict` response code will
be returned if another resource class exists with the provided name.