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

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

Assisted volume snapshots (os-assisted-volume-snapshots)

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

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

Creates and deletes snapshots through an emulator/hypervisor. Only qcow2

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

file format is supported.

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

This API is only implemented by the libvirt compute driver.

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

An internal snapshot that lacks storage such as NFS or GlusterFS can use

an emulator/hypervisor to add the snapshot feature.

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

This is used to enable snapshot of volumes on backends such as NFS or

GlusterFS by storing data as qcow2 files on these volumes.

This API is only ever called by Cinder, where it is used to create a snapshot

for drivers that extend the remotefs Cinder driver.

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

Create Assisted Volume Snapshots

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

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 /os-assisted-volume-snapshots

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

Creates an assisted volume snapshot.

Normal response codes: 200

method verification of os-assisted-volume-snapshots Verified the API document for os-assisted-volume-snapshots with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: I9357377750e7c373c283edd73cbf65ad42c22e66

2016年05月10日 23:01:56 +00:00

Error response codes: badRequest(400),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

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

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

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

- snapshot: snapshot

- volume_id: volume_id

- create_info: create_info

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

- create_info.snapshot_id: snapshot_id

- create_info.type: type-os-assisted-volume-snapshot

- create_info.new_file: new_file

- create_info.id: create_info_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

**Example Create Assisted Volume Snapshots: JSON request**

.. literalinclude:: ../../doc/api_samples/os-assisted-volume-snapshots/snapshot-create-assisted-req.json

: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

.. rest_parameters:: parameters.yaml

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

- snapshot: snapshot

- id: create_info_id_resp

- volumeId: volume_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 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 Create Assisted Volume Snapshots: 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

.. literalinclude:: ../../doc/api_samples/os-assisted-volume-snapshots/snapshot-create-assisted-resp.json

:language: javascript

Delete Assisted Volume Snapshot

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

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 /os-assisted-volume-snapshots/{snapshot_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

Deletes an assisted volume snapshot.

To make this request, add the ``delete_info`` query parameter to the URI, as follows:

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

DELETE /os-assisted-volume-snapshots/421752a6-acf6-4b2d-bc7a-119f9148cd8c?delete_info='{"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c"}'

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

method verification of os-assisted-volume-snapshots Verified the API document for os-assisted-volume-snapshots with source for methods available and response codes. Part of bp:api-ref-in-rst Change-Id: I9357377750e7c373c283edd73cbf65ad42c22e66

2016年05月10日 23:01:56 +00:00

Error response codes: badRequest(400), 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

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

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

- delete_info: delete_info

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

--------

api-ref: verify assisted-volume-snapshots.inc This completes the verification of os-assisted-volume-snapshots.inc for all required area(parameter, example, body) Part of bp:api-ref-in-rst Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b

2016年06月08日 19:19:02 +09:00

api-ref: unify the no response output in delete operation Change-Id: Ia90a5ef1cd1b432e68130313960a015b45fe63e0 Implements: blueprint api-ref-in-rst

2016年07月25日 16:13:45 +08:00

There is no body content for the response of a successful DELETE query

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

92 lines 2.5 KiB PHP Raw Normal View History Unescape Escape

92 lines

2.5 KiB

PHP

Raw Normal View History