openstack/nova
Code Issues Proposed changes
2eb358cdce
nova/api-ref/source/os-consoles.inc

141 lines
2.5 KiB
PHP
Raw Normal View History

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. -*- rst -*-
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
==================================================
XenServer VNC Proxy (XVP) consoles (os-consoles)
==================================================
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
Manages server XVP consoles.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
.. warning::
These APIs are only applicable when using the XenServer virt driver.
They were removed in the 21.0.0 (Ussuri) release.
Add description for /consoles /consoles is only used by Xenserver VNC Proxy, so we add a note in the api-ref doc. Related-Bug: 1682303 Change-Id: Id9b55068afa516fb089ce8ba1c1956e4c571a6a6
2017-03-29 01:33:40 +08:00
Complete method Verification of consoles verified the API doc for os-consoles and os-console-auth-token, Adjust GET/POST sequence in the doc Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: If03d3b23246cc8af639c4a08bb22129937efeaeb
2016-04-25 04:00:05 +08:00
Lists Consoles
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
==============
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /servers/{server_id}/consoles
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix 'server' and 'instance' occurrence in api-ref some api-ref have sentence like '..for a server instance' which is inconsistent and confusing as we use server for VM terminology. I think here 'instance' word is being considered object of server which is wrong. We should always mention server only. part of bp:api-ref-in-rst-pike Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
2017-03-27 09:22:10 +00:00
Lists all consoles for a server.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
Error response codes: unauthorized(401), forbidden(403), gone(410)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
.. rest_parameters:: parameters.yaml
- consoles: consoles
- console: console
- console_type: console_type
- id: console_id_in_body
|
**Example List Consoles**
Complete method Verification of consoles verified the API doc for os-consoles and os-console-auth-token, Adjust GET/POST sequence in the doc Also, remove some common error code like 500, 503 etc Part of bp:api-ref-in-rst Change-Id: If03d3b23246cc8af639c4a08bb22129937efeaeb
2016-04-25 04:00:05 +08:00
.. literalinclude:: ../../doc/api_samples/consoles/consoles-list-get-resp.json
:language: javascript
Create Console
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
==============
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: POST /servers/{server_id}/consoles
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix 'server' and 'instance' occurrence in api-ref some api-ref have sentence like '..for a server instance' which is inconsistent and confusing as we use server for VM terminology. I think here 'instance' word is being considered object of server which is wrong. We should always mention server only. part of bp:api-ref-in-rst-pike Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
2017-03-27 09:22:10 +00:00
Creates a console for a server.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
If successful, this method does not return a response body.
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Show Console Details
====================
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: GET /servers/{server_id}/consoles/{console_id}
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix 'server' and 'instance' occurrence in api-ref some api-ref have sentence like '..for a server instance' which is inconsistent and confusing as we use server for VM terminology. I think here 'instance' word is being considered object of server which is wrong. We should always mention server only. part of bp:api-ref-in-rst-pike Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
2017-03-27 09:22:10 +00:00
Shows console details for a server.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 200
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
- console_id: console_id
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
.. rest_parameters:: parameters.yaml
- console: console
- console_type: console_type
- host: console_host
- id: console_id_in_body
- instance_name: instance_name
- password: console_password
api-ref: Fix a 'port' parameter in os-consoles.inc In 'Show Console Details' API, 'port' is not a port ID but a port number. Change-Id: Iefdd9e9a68fc197a99b8c5e2e36a82c062caa35f Closes-Bug: #1632153
2016-10-11 08:28:13 +09:00
- port: port_number
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
|
**Example Show Console Details**
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix remaining json reference warnings This fixes the last json reference warning which exist. It also trims out the baremetal API calls that we don't support any more (we only have the readonly proxy). That was erroneously added to the compute API docs in refactors of api-site last cycle. Change-Id: I08be639b610304049b0959902ed8876559111274
2016-04-20 08:42:24 -04:00
.. literalinclude:: ../../doc/api_samples/consoles/consoles-get-resp.json
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
:language: javascript
api-ref: os-consoles.inc -Verified methods, examples, parameters, body text. -Added console, consoles parameters. Part of blueprint api-ref-in-rst Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-17 10:28:31 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Delete Console
==============
remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
2016-06-02 08:50:03 -04:00
.. rest_method:: DELETE /servers/{server_id}/consoles/{console_id}
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Fix 'server' and 'instance' occurrence in api-ref some api-ref have sentence like '..for a server instance' which is inconsistent and confusing as we use server for VM terminology. I think here 'instance' word is being considered object of server which is wrong. We should always mention server only. part of bp:api-ref-in-rst-pike Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
2017-03-27 09:22:10 +00:00
Deletes a console for a server.
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Normal response codes: 202
Remove 'os-consoles' API This exposes the 'nova-console' service via a REST API, a service that can only be used with XVP VNC consoles, which in turn require the 'nova-xvpvncproxy' service. We we would like to remove the 'nova-console' and 'nova-xvpvncproxy' services, so start here. Part of blueprint remove-xvpvncproxy Change-Id: I2ee3b8c44e5d85e9b3c811ed3c5e6cddc563054f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-10 15:13:06 +01:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Request
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
-------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
.. rest_parameters:: parameters.yaml
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
- server_id: server_id_path
[api-ref] Fix path parameter console_id Replace path parameter id with console_id in DELETE method. Change-Id: Id008784fd91b5f5b4974564643cb0086799f9a8a
2016-10-31 15:45:05 -04:00
- console_id: console_id
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
Response
move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-14 13:10:59 -04:00
--------
Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
2016-04-12 09:03:46 -04:00
API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-10-10 14:50:17 -04:00
If successful, this method does not return a response body.
Copy Permalink