JSON body examples of Placement API reference
are in the same directroy where *.inc files exist.
This patch moves JSON body examples to an isolated directory
in order to make it easier to maintain the API reference.
Change-Id: I8fd587100d22bd10dd4b2b2f1b25c5ecc7fc8537
The placement API reference documentation for POST /resource_classes [1]
said:
The new class must be a custom resource class, prefixed with CUSTOM_ and
distinct from the _standard_ resource classes.
...where _standard_ was a link to os-traits documentation [2]. Since we
don't have os-resource-classes (yet), this change set removes that
linkitude.
[1] https://developer.openstack.org/api-ref/placement/#create-resource-class
[2] https://docs.openstack.org/os-traits/latest/
Change-Id: I15fbed460598b7d603eca48cbaecf1036906f6c7
Closes-Bug: #1747095
The 'Location' parameters are missing in the follwoing APIs of
Placement API reference. So add them.
* POST /resource_providers
* POST /resource_classes
* PUT /resource_classes/{name} (microversion 1.7-)
* PUT /traits/{name}
Change-Id: Ieed5cb7d4697472ab46b2e80d6d2df68098c5631
Closes-Bug: #1733329
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
In the following resource class APIs,
the name of a resource class must start with 'CUSTOM_'.
If not, the request returns a 'Bad Request (400)' response code.
It should be described in the API reference. So add it.
* POST /resource_classes
* PUT /resource_classes/{name}
Change-Id: I132c532678bb74a460515067187fbf1e30885335
Closes-Bug: #1733308
This provides simple documentation of the path, request and response
body parameters when listing, creating, updating and deleting a resource
class.
Change-Id: I4038d116d53b68344282ef59f9f01753766d2ef8
