8c59991363
This consists of a duplicate of the [nova-]api-ref setup and conf.py along with tooling to fail the tox -edocs target when a route that is defined in nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not present in placement-api-ref/source/index.rst. tools/placement_api_docs.py will report which routes are missing. Though completely gameable (as demonstrated in the current lame index.rst) it's better than nothing and provides some useful structuring on what to do next. It's also the case that the 'docs' target in tox is not part of gating. The response for GET / is in place with the necessary parameters.yaml for it to be correctly described. The 'get-root.json' file provides the JSON of the expected response. The expectation is that later commits will add information for other urls and their JSON files will be named method-path-separated-by-dash.json with a request/response qualifier as necessary. Followup patches will add other routes. A new parameters.yaml is used instead of reusing the one from api-ref as there isn't a lot of expected overlap and having a separate file will ease eventual extraction. Running tox -eplacement-api-ref will generate the docs for review, with output in placement-api-ref/build/html/index.html. This will be hooked up with CI to deploy the generated docs, eventually. Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
941 B
941 B
- tocdepth
-
2
Placement API
This is a reference for the Openstack Placement API. To learn more about Openstack Placement API concepts, please refer to the Placement Introduction.
Versions
List Versions
Fetch information about all known major versions of the placement API, including information about the minimum and maximum microversions.
Note
At this time there is only one major version of the placement API: version 1.0.
Normal Response Codes: 200
Response
- versions: versions
- id: version_id
- min_version: version_min
- max_version: version_max
Response Example
get-root.json