openstack/nova
Code Issues Proposed changes
a4e15e329f
nova/api-ref/source/servers-action-evacuate.inc

45 lines
1.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 -*-
add tags to files for the content verification phase This adds a set of tags in comments to the beginning of files so that we can process them according to the documentation here: https://wiki.openstack.org/wiki/NovaAPIRef Part of bp:api-ref-in-rst Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:10:51 -04:00
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
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
Evacuate Server (Evacuate Action)
=================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
Evacuates a server from a failed host to a new one.
Specify the ``evacuate`` action in the request body.
Fix sample file path for 4 files This fix sample file path and status code of evacuate Part of bp:api-ref-in-rst Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
Normal response codes: 200
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
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
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
- tenant_id: tenant_id
- server_id: server_id
- evacuate: evacuate
- host: host
Change adminPass for several server actions adminPass has incorrect reference, thus every input param are same ,but actually they are different. updated it with its correct link reference. Part of bp:api-ref-in-rst Change-Id: Ie981a0912768effbe796bfc1d26d4972ba667b90
2016-03-23 22:49:44 +08:00
- adminPass: adminPass_evacuate_rebuild
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
**Example Evacuate Server (Evacuate Action): JSON request**
Fix sample file path for 4 files This fix sample file path and status code of evacuate Part of bp:api-ref-in-rst Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.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
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
**Example Evacuate Server (Evacuate Action): JSON request**
Fix sample file path for 4 files This fix sample file path and status code of evacuate Part of bp:api-ref-in-rst Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +09:00
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-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
Copy Permalink