diff options
| author | Mahnoor Asghar <masghar.bese15seecs@seecs.edu.pk> | 2022-02-01 05:12:37 +0500 |
|---|---|---|
| committer | Mahnoor Asghar <masghar.bese15seecs@seecs.edu.pk> | 2022-03-17 01:22:44 +0500 |
| commit | 3e631a5931c9a3d53d78438339adfeeae5fa5a70 (patch) | |
| tree | f584f2f34b03f17297b655e27d8c30a6c1a0b11c /api-ref | |
| parent | 365a4545fe6606b1fda8f1387e851641de25cec8 (diff) | |
| download | ironic-3e631a5931c9a3d53d78438339adfeeae5fa5a70.tar.gz | |
Create API documentation from docstrings
Create a new Sphinx extension called 'web_api_docstring' to process
docstrings from the API classes, in order to generate API
documentation.
Story: 2009785
Task: 44291
Change-Id: Ia6b2b3741e2b1cbd29531c21795df4f0f0dc70ca
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/baremetal-api-v1-nodes.inc | 5 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 15 |
2 files changed, 14 insertions, 6 deletions
diff --git a/api-ref/source/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal-api-v1-nodes.inc index 44bae0014..2ebbd2c5d 100644 --- a/api-ref/source/baremetal-api-v1-nodes.inc +++ b/api-ref/source/baremetal-api-v1-nodes.inc @@ -153,11 +153,6 @@ Request .. literalinclude:: samples/node-create-request-dynamic.json :language: javascript -**Example Node creation request with a classic driver:** - -.. literalinclude:: samples/node-create-request-classic.json - :language: javascript - Response -------- diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index b3eb28f82..d0da64ec2 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -324,6 +324,13 @@ r_node_uuid: in: query required: false type: string +r_owner: + description: | + Filter the list of returned allocations, and only return those with + the specified owner. + in: query + required: false + type: string r_port_address: description: | Filter the list of returned Ports, and only return the ones with the @@ -412,7 +419,7 @@ sort_dir: type: string sort_key: description: | - Sorts the response by the this attribute value. + Sorts the response by this attribute value. Default is ``id``. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the server @@ -466,6 +473,12 @@ allocation_node: in: body required: true type: string +allocation_patch: + description: | + A JSON patch document to apply to the allocation. + in: body + required: true + type: JSON allocation_resource_class: description: | The resource class requested for the allocation. Can be ``null`` if |