API-REF documentation for profile-type-ops API

This adds API document for profile-type-ops

Change-Id: I2d9cba28d47238dc593a532df81aa6362453c4b1
This commit is contained in:
tengqm 2016-12-24 23:05:42 -05:00
parent 0ede0e10c1
commit bc907e53e9
3 changed files with 69 additions and 0 deletions

View File

@ -834,6 +834,14 @@ oname:
description: |
The name of an object associated with the event.
operations:
type: object
in: body
required: True
description: |
A dictionary containing the description of operations (and parameters)
supported by a profile type.
otype:
type: string
in: body

View File

@ -90,3 +90,49 @@ Response Example
.. literalinclude:: samples/profile-type-show-response.json
:language: javascript
List profile type operations
============================
.. rest_method:: GET /v1/profile-types/{profile_type}/ops
- min_version: 1.4
List operations and parameters supported by a profile type.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 403
- 404
- 503
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- profile_type: profile_type_url
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- operations: operations
Response Example
----------------
.. literalinclude:: samples/profile-type-ops-response.json
:language: javascript

View File

@ -0,0 +1,15 @@
{
"operations": {
"reboot": {
"description": "reboot the specified VM instance",
"parameters": {
"type": {
"default": "SOFT",
"description": "Type of reboot requested",
"required": false,
"type": "String"
}
}
}
}
}