openstack/nova - nova - OpenDev: Free Software Needs Free Tools

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: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

===================================================================

Servers with volume attachments (servers, os-volume\_attachments)

===================================================================

Attaches volumes that are created through the volume API to server

instances. Also, lists volume attachments for a server instance, shows

details for a volume attachment, and detaches a volume.

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

List volume attachments for an instance

=======================================

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}/os-volume_attachments

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

List volume attachments for an instance.

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)

Request

-------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

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

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

- server_id: server_id_path

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Response

--------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

- volumeAttachments: volumeAttachments

- device: device_resp

- id: attachment_id_resp

- serverId: server_id

- volumeId: volumeId_resp

api-ref: Example verification for os-volume_attachments.inc Change-Id: I1f5ba0453b0dc964f48471e4aecaaaa800699da1 Implements: blueprint api-ref-in-rst

2016年05月13日 14:40:24 +09:00

**Example List volume attachments for an instance: JSON response**

.. literalinclude:: ../../doc/api_samples/os-volumes/list-volume-attachments-resp.json

:language: javascript

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Attach a volume to an instance

==============================

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}/os-volume_attachments

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Attach a volume to an instance.

Normal response codes: 200

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)

Request

-------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

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

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

- server_id: server_id_path

- volumeAttachment: volumeAttachment

- volumeId: volumeId

- device: device

api-ref: Example verification for os-volume_attachments.inc Change-Id: I1f5ba0453b0dc964f48471e4aecaaaa800699da1 Implements: blueprint api-ref-in-rst

2016年05月13日 14:40:24 +09:00

**Example Attach a volume to an instance: JSON request**

.. literalinclude:: ../../doc/api_samples/os-volumes/attach-volume-to-server-req.json

:language: javascript

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Response

--------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

- volumeAttachment: volumeAttachment

- device: device_resp

- id: attachment_id_resp

- serverId: server_id

- volumeId: volumeId_resp

api-ref: Example verification for os-volume_attachments.inc Change-Id: I1f5ba0453b0dc964f48471e4aecaaaa800699da1 Implements: blueprint api-ref-in-rst

2016年05月13日 14:40:24 +09:00

**Example Attach a volume to an instance: JSON response**

.. literalinclude:: ../../doc/api_samples/os-volumes/attach-volume-to-server-resp.json

:language: javascript

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Show a detail of a volume attachment

====================================

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}/os-volume_attachments/{attachment_id}

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Show a detail of a volume attachment.

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)

Request

-------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

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

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

- server_id: server_id_path

- attachment_id: attachment_id

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Response

--------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

- volumeAttachment: volumeAttachment

- device: device_resp

- id: attachment_id_resp

- serverId: server_id

- volumeId: volumeId_resp

api-ref: Example verification for os-volume_attachments.inc Change-Id: I1f5ba0453b0dc964f48471e4aecaaaa800699da1 Implements: blueprint api-ref-in-rst

2016年05月13日 14:40:24 +09:00

**Example Show a detail of a volume attachment: JSON response**

.. literalinclude:: ../../doc/api_samples/os-volumes/volume-attachment-detail-resp.json

:language: javascript

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Update a volume attachment

==========================

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 /servers/{server_id}/os-volume_attachments/{attachment_id}

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Update a volume attachment.

Normal response codes: 202

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)

Request

-------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

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

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

- server_id: server_id_path

- attachment_id: attachment_id

- volumeAttachment: volumeAttachment

- volumeId: volumeId_swap

api-ref: Example verification for os-volume_attachments.inc Change-Id: I1f5ba0453b0dc964f48471e4aecaaaa800699da1 Implements: blueprint api-ref-in-rst

2016年05月13日 14:40:24 +09:00

**Example Update a volume attachment: JSON request**

.. literalinclude:: ../../doc/api_samples/os-volumes/update-volume-req.json

:language: javascript

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Response

--------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

No body is returned on successful request.

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Detach a volume from an instance

================================

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}/os-volume_attachments/{attachment_id}

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Detach a volume from an instance.

Normal response codes: 202

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)

Request

-------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

.. rest_parameters:: parameters.yaml

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

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

- server_id: server_id_path

- attachment_id: attachment_id

api-ref: Method verification for os-volume_attachments.inc Change-Id: I560908b28c1193622ee6e042322024fc6d0df5d6 Implements: blueprint api-ref-in-rst

2016年05月12日 08:19:24 +09:00

Response

--------

api-ref: Parameter verification for os-volume_attachments.inc Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741 Implements: blueprint api-ref-in-rst

2016年05月13日 12:51:09 +09:00

No body is returned on successful request.

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

182 lines 4.1 KiB PHP Raw Normal View History Unescape Escape

182 lines

4.1 KiB

PHP

Raw Normal View History