api-ref: console types.

Documentation change in api-ref.

type is added to the parameter lists of Get RDP console, Get serial console,
Get SPICE console, Get VNC console.

Closes-Bug: 1587117
Closes-Bug: 1587118
Closes-Bug: 1587119
Closes-Bug: 1587121

Change-Id: I73823fd6fb0886e2fff0da4838fe868f578bba6d
Signed-off-by: csatari <gergely.csatari@nokia.com>
This commit is contained in:
csatari 2016-06-14 15:49:16 +02:00
parent 05cab2666f
commit 32d45f15dc
3 changed files with 30 additions and 4 deletions

View File

@ -34,7 +34,7 @@ Request
- volume_id: volume_id
- create_info: create_info
- snapshot_id: snapshot_id
- type: type
- type: type-os-assisted-volume-snapshot
- new_file: new_file
**Example Create Assisted Volume Snapshots: JSON request**
@ -88,4 +88,3 @@ Query Parameters
Response
--------

View File

@ -2403,24 +2403,48 @@ os-getRDPConsole:
in: body
required: true
type: string
os-getRDPConsole-type:
description: |
The type of RDP console. The correct value is ``rdp-html5``.
in: body
required: true
type: string
os-getSerialConsole:
description: |
The action.
in: body
required: true
type: string
os-getSerialConsole-type:
description: |
The type of serial console. The correct value is ``serial``.
in: body
required: true
type: string
os-getSPICEConsole:
description: |
The action.
in: body
required: true
type: string
os-getSPICEConsole-type:
description: |
The type of SPICE console. The correct value is ``spice-html5``.
in: body
required: true
type: string
os-getVNCConsole:
description: |
The action.
in: body
required: true
type: string
os-getVNCConsole-type:
description: |
The type of VNC console. The correct value is ``novnc``.
in: body
required: true
type: string
os-resetState:
description: |
The action.
@ -3072,7 +3096,7 @@ trigger_crash_dump:
type: none
description: |
Specifies the trigger crash dump action should be run
type:
type-os-assisted-volume-snapshot:
description: |
The snapshot type. A valid value is ``qcow2``.
in: body

View File

@ -25,6 +25,7 @@ Request
- server_id: server_id
- os-getRDPConsole: os-getRDPConsole
- type: os-getRDPConsole-type
**Example Get Rdp Console (os-getRDPConsole Action): JSON request**
@ -61,6 +62,7 @@ Request
- server_id: server_id
- os-getSerialConsole: os-getSerialConsole
- type: os-getSerialConsole-type
**Example Get Serial Console (os-getSerialConsole Action): JSON request**
@ -97,6 +99,7 @@ Request
- server_id: server_id
- os-getSPICEConsole: os-getSPICEConsole
- type: os-getSPICEConsole-type
**Example Get Spice Console (os-getSPICEConsole Action): JSON request**
@ -133,6 +136,7 @@ Request
- server_id: server_id
- os-getVNCConsole: os-getVNCConsole
- type: os-getVNCConsole-type
**Example Get Vnc Console (os-getVNCConsole Action): JSON request**
@ -146,4 +150,3 @@ Response
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-resp.json
:language: javascript