openstack/nova
Code Issues Proposed changes
9569bc3552
nova/api-ref/source/os-hosts.inc

212 lines
4.1 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 -*-
==================
Hosts (os-hosts)
==================
api-ref host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
Manages physical hosts. Some virt drivers do not support all host
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
functions. For more information, see `nova virt support
matrix <http://docs.openstack.org/developer/nova/support-matrix.html>`__
api-ref host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
Policy defaults enable only users with the administrative role to perform
all os-hosts related operations. Cloud providers can change these permissions
through the ``policy.json`` file.
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
List Hosts
==========
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 /os-hosts
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
Lists hosts.
Normal response codes: 200
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Error response codes: unauthorized(401), forbidden(403)
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 host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
.. rest_parameters:: parameters.yaml
- hosts: hosts
- zone: host_zone
- host_name: host_name_body
- service: host_service
**Example List Hosts**
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
.. literalinclude:: ../../doc/api_samples/os-hosts/hosts-list-resp.json
:language: javascript
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Show Host 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
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 /os-hosts/{host_name}
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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Shows details for a host.
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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
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
- host_name: host_name
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 host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
.. rest_parameters:: parameters.yaml
- host: host_resource_array
- resource: host_resource
api-ref: Fix parameters in os-hosts.inc * Show Host Details - The parameters in 'resource' object are prefixed with 'resource.' instead of 'host.'. - The types of 'cpu', 'memory_mb' and 'disk_gb' are changed to 'integer'. - The descriptions of 'cpu', 'memory_mb' and 'disk_gb' are changed (clearer). * Update Host status - The 'status' and 'maintenance_mode' in request parameters are changed to 'body' parameters instead of 'path' parameters. - The 'status' and 'maintenance_mode' in request parameters are changed to either 'enable' or 'disable'. - The 'status' and 'maintenance_mode' in response parameters are changed to 'optional'. Change-Id: Ic6bffca8b1dfaa9284a72145f3e1f894acb306e3 Closes-Bug: #1653884
2017-01-04 14:22:55 +09:00
- resource.project: host_project
- resource.cpu: host_cpu
- resource.memory_mb: host_memory_mb
- resource.disk_gb: host_disk_gb
- resource.host: host_name_body
api-ref host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
**Example Show Host 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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
.. literalinclude:: ../../doc/api_samples/os-hosts/host-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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Update Host status
==================
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:: PUT /os-hosts/{host_name}
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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Enables, disables a host or put a host in maintenance or normal mode.
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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
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
- host_name: host_name
api-ref host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
- status: host_status_body_in
- maintenance_mode: host_maintenance_mode_in
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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
**Example Enable Host: JSON request**
.. literalinclude:: ../../doc/api_samples/os-hosts/host-put-maintenance-req.json
:language: javascript
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 host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
.. rest_parameters:: parameters.yaml
- host: host_name_body
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
- status: host_status_body
api-ref host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
- maintenance_mode: host_maintenance_mode
**Example Enable Host**
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
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
.. literalinclude:: ../../doc/api_samples/os-hosts/host-put-maintenance-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
Reboot Host
===========
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 /os-hosts/{host_name}/reboot
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
Reboots a host.
Normal response codes: 200
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
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
- host_name: host_name
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 host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
.. rest_parameters:: parameters.yaml
- host: host_name_body
- power_action: host_power_action
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Reboot Host: JSON response**
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 hosts and az api samples Those 2 files has incorrect api samples, this patch fixs it. Part of bp:api-ref-in-rst Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1
2016-03-23 13:58:30 +08:00
.. literalinclude:: ../../doc/api_samples/os-hosts/host-get-reboot.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
Shut Down Host
==============
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 /os-hosts/{host_name}/shutdown
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
Shuts down a host.
Normal response codes: 200
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
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
- host_name: host_name
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 host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
.. rest_parameters:: parameters.yaml
- host: host_name_body
- power_action: host_power_action
**Example Shut Down Host**
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 hosts and az api samples Those 2 files has incorrect api samples, this patch fixs it. Part of bp:api-ref-in-rst Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1
2016-03-23 13:58:30 +08:00
.. literalinclude:: ../../doc/api_samples/os-hosts/host-get-shutdown.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
Start Host
==========
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 /os-hosts/{host_name}/startup
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
Starts a host.
Normal response codes: 200
Complete Verification of os-hosts verified the API doc for os-hosts, 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: Id8c77d53a589d4203308b8135d5413d00d64d6f1
2016-04-24 08:06:42 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
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
- host_name: host_name
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 host verification (os-hosts.inc) This verify the os-hosts by adding more reponse param descriptions and body. Part of bp:api-ref-in-rst Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 12:48:03 +08:00
.. rest_parameters:: parameters.yaml
- host: host_name_body
- power_action: host_power_action
**Example Start Host**
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 hosts and az api samples Those 2 files has incorrect api samples, this patch fixs it. Part of bp:api-ref-in-rst Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1
2016-03-23 13:58:30 +08:00
.. literalinclude:: ../../doc/api_samples/os-hosts/host-get-startup.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
Copy Permalink