api-ref: Parameter verification for os-volume_attachments.inc

Change-Id: I3789a4ad36e30728024f2aa122403b0e53b1e741
Implements: blueprint api-ref-in-rst
This commit is contained in:
Takashi NATSUME
2016-05-13 12:51:09 +09:00
committed by John Garbutt
parent 8bb1081fe3
commit 05b0da8062
2 changed files with 94 additions and 4 deletions
+61 -1
View File
@@ -1,5 +1,4 @@
.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
@@ -25,9 +24,22 @@ Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id_path
Response
--------
.. rest_parameters:: parameters.yaml
- volumeAttachments: volumeAttachments
- device: device_resp
- id: attachment_id_resp
- serverId: server_id
- volumeId: volumeId_resp
Attach a volume to an instance
==============================
@@ -42,9 +54,25 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNo
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id_path
- volumeAttachment: volumeAttachment
- volumeId: volumeId
- device: device
Response
--------
.. rest_parameters:: parameters.yaml
- volumeAttachment: volumeAttachment
- device: device_resp
- id: attachment_id_resp
- serverId: server_id
- volumeId: volumeId_resp
Show a detail of a volume attachment
====================================
@@ -59,9 +87,23 @@ Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id_path
- attachment_id: attachment_id
Response
--------
.. rest_parameters:: parameters.yaml
- volumeAttachment: volumeAttachment
- device: device_resp
- id: attachment_id_resp
- serverId: server_id
- volumeId: volumeId_resp
Update a volume attachment
==========================
@@ -76,9 +118,19 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNo
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id_path
- attachment_id: attachment_id
- volumeAttachment: volumeAttachment
- volumeId: volumeId_swap
Response
--------
No body is returned on successful request.
Detach a volume from an instance
================================
@@ -93,5 +145,13 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNo
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id_path
- attachment_id: attachment_id
Response
--------
No body is returned on successful request.
+33 -3
View File
@@ -793,6 +793,12 @@ alias:
in: body
required: true
type: string
attachment_id_resp:
description: |
The UUID of the attachment.
in: body
required: true
type: string
availability_zone:
description: |
The availability zone.
@@ -979,6 +985,12 @@ device:
in: body
required: false
type: string
device_resp:
description: |
Name of the device such as, ``/dev/vdb``.
in: body
required: true
type: string
device_name:
description: |
A path to the device for the volume that you want to use to boot the server.
@@ -2370,13 +2382,31 @@ volumeAttachment:
description: |
A dictionary representation of a volume attachment.
in: body
required: false
type: object
required: true
type: string
volumeAttachments:
description: |
List of the volume attachments.
in: body
required: true
type: array
volumeId:
description: |
The UUID of the volume to attach.
in: body
required: false
required: true
type: string
volumeId_resp:
description: |
The UUID of the attached volume.
in: body
required: true
type: string
volumeId_swap:
description: |
The UUID of the volume to attach instead of the attached volume.
in: body
required: true
type: string
volume_id:
description: |