[api-ref]Adds API documentation for 'os-set_bootable' action
There is no document about update a volume's bootable status, so add the missing doc. Change-Id: If706205678cfd7a803e2d7733bec34494b47fc66 Partial-Bug: #1607539
This commit is contained in:
parent
1f7adde05b
commit
e9acdab687
@ -1199,6 +1199,12 @@ OS-SCH-HNT:scheduler_hints:
|
||||
in: body
|
||||
required: false
|
||||
type: object
|
||||
os-set_bootable:
|
||||
description: |
|
||||
The ``os-set_bootable`` action.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
os-set_image_metadata:
|
||||
description: |
|
||||
The ``os-set_image_metadata`` action.
|
||||
|
@ -0,0 +1,5 @@
|
||||
{
|
||||
"os-set_bootable": {
|
||||
"bootable": "True"
|
||||
}
|
||||
}
|
@ -369,3 +369,34 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update volume bootable status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
||||
|
||||
Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- volume_id: volume_id_path
|
||||
- os-set_bootable: os-set_bootable
|
||||
- bootable: bootable
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ./samples/volume-bootable-status-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -1437,6 +1437,12 @@ OS-SCH-HNT:scheduler_hints:
|
||||
in: body
|
||||
required: false
|
||||
type: object
|
||||
os-set_bootable:
|
||||
description: |
|
||||
The ``os-set_bootable`` action.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
os-set_image_metadata:
|
||||
description: |
|
||||
The ``os-set_image_metadata`` action.
|
||||
|
@ -0,0 +1,5 @@
|
||||
{
|
||||
"os-set_bootable": {
|
||||
"bootable": "True"
|
||||
}
|
||||
}
|
@ -365,3 +365,35 @@ Request Example
|
||||
.. literalinclude:: ./samples/volume-force-delete-request.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update a volume's bootable status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action
|
||||
|
||||
Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-set_bootable: os-set_bootable
|
||||
- bootable: bootable
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ./samples/volume-bootable-status-update-request.json
|
||||
:language: javascript
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user