cinder/api-ref/source/v2/volumes-v2-snapshots-actions.inc
Sean McGinnis 2e5a91da72 Use rest_status_code for api-ref response codes
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.

https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code

Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
2018-03-08 21:59:37 -06:00

40 lines
775 B
ReStructuredText

.. -*- rst -*-
====================================
Snapshot actions (snapshots, action)
====================================
Administrator only. Resets status for a snapshot.
Reset a snapshot's status
=========================
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
Resets the status. Specify the ``os-reset_status`` action in the request body.
Response codes
~~~~~~~~~~~~~~
.. rest_status_code:: success ../status.yaml
- 202
Request
-------
.. rest_parameters:: parameters.yaml
- status: status_2
- os-reset_status: os-reset_status
- project_id: project_id_path
- snapshot_id: snapshot_id
Request Example
---------------
.. literalinclude:: ./samples/snapshot-status-reset-request.json
:language: javascript