api-ref: parameter verification os-agents
Change-Id: I7e319ec05489d87cdd5b4a486f3981fc8d8f90a9
This commit is contained in:
@@ -1,5 +1,4 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
.. needs:parameter_verification
|
|
||||||
.. needs:example_verification
|
.. needs:example_verification
|
||||||
.. needs:body_verification
|
.. needs:body_verification
|
||||||
|
|
||||||
@@ -30,18 +29,23 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- hypervisor: hypervisor_query
|
||||||
|
|
||||||
- agent_id: agent_id
|
|
||||||
- architecture: architecture
|
|
||||||
- hypervisor: hypervisor_type
|
|
||||||
- url: url
|
|
||||||
- md5hash: md5hash
|
|
||||||
- os: os
|
|
||||||
- version: version
|
|
||||||
|
|
||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- agents: agents
|
||||||
|
- agent_id: agent_id
|
||||||
|
- architecture: architecture
|
||||||
|
- hypervisor: hypervisor_type
|
||||||
|
- md5hash: md5hash
|
||||||
|
- os: os
|
||||||
|
- url: url
|
||||||
|
- version: version
|
||||||
|
|
||||||
**Example List Agent Builds: JSON response**
|
**Example List Agent Builds: JSON response**
|
||||||
|
|
||||||
.. literalinclude:: ../../doc/api_samples/os-agents/agents-get-resp.json
|
.. literalinclude:: ../../doc/api_samples/os-agents/agents-get-resp.json
|
||||||
@@ -63,13 +67,13 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- agent: agent
|
||||||
- hypervisor: hypervisor_type
|
- hypervisor: hypervisor_type
|
||||||
- architecture: architecture
|
|
||||||
- os: os
|
- os: os
|
||||||
- url: url
|
- architecture: architecture
|
||||||
- md5hash: md5hash
|
|
||||||
- version: version
|
- version: version
|
||||||
|
- md5hash: md5hash
|
||||||
|
- url: url
|
||||||
|
|
||||||
**Example Create Agent Build: JSON request**
|
**Example Create Agent Build: JSON request**
|
||||||
|
|
||||||
@@ -81,13 +85,14 @@ Response
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- hypervisor: hypervisor_type
|
- agent: agent
|
||||||
|
- agent_id: agent_id
|
||||||
- architecture: architecture
|
- architecture: architecture
|
||||||
|
- hypervisor: hypervisor_type
|
||||||
|
- md5hash: md5hash
|
||||||
- os: os
|
- os: os
|
||||||
- url: url
|
- url: url
|
||||||
- md5hash: md5hash
|
|
||||||
- version: version
|
- version: version
|
||||||
- agent_id: agent_id
|
|
||||||
|
|
||||||
**Example Create Agent Build: JSON response**
|
**Example Create Agent Build: JSON response**
|
||||||
|
|
||||||
@@ -112,6 +117,7 @@ Request
|
|||||||
|
|
||||||
|
|
||||||
- agent_build_id: agent_build_id
|
- agent_build_id: agent_build_id
|
||||||
|
- para: para
|
||||||
- url: url
|
- url: url
|
||||||
- md5hash: md5hash
|
- md5hash: md5hash
|
||||||
- version: version
|
- version: version
|
||||||
@@ -126,9 +132,10 @@ Response
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- agent: agent
|
||||||
- agent_id: agent_id_str
|
- agent_id: agent_id_str
|
||||||
- url: url
|
|
||||||
- md5hash: md5hash
|
- md5hash: md5hash
|
||||||
|
- url: url
|
||||||
- version: version
|
- version: version
|
||||||
|
|
||||||
**Example Update Agent Build: JSON response**
|
**Example Update Agent Build: JSON response**
|
||||||
@@ -158,3 +165,4 @@ Request
|
|||||||
Response
|
Response
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
There is no body content for the response of a successful DELETE query
|
||||||
|
@@ -387,6 +387,12 @@ host_query:
|
|||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
hypervisor_query:
|
||||||
|
description: |
|
||||||
|
Filters the response by a hypervisor type.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
image_query:
|
image_query:
|
||||||
description: |
|
description: |
|
||||||
Filters the response by an image, as a UUID.
|
Filters the response by an image, as a UUID.
|
||||||
@@ -717,6 +723,12 @@ adminPass_rescue:
|
|||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
agent:
|
||||||
|
description: |
|
||||||
|
The guest agent object.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
agent_id:
|
agent_id:
|
||||||
description: |
|
description: |
|
||||||
The agent ID.
|
The agent ID.
|
||||||
@@ -730,6 +742,12 @@ agent_id_str:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
agents:
|
||||||
|
description: |
|
||||||
|
A list of guest agent objects.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: array
|
||||||
aggregate:
|
aggregate:
|
||||||
description: |
|
description: |
|
||||||
The host aggregate object.
|
The host aggregate object.
|
||||||
@@ -2664,6 +2682,12 @@ overall_status:
|
|||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
para:
|
||||||
|
description: |
|
||||||
|
The parameter object.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
parent_group_id:
|
parent_group_id:
|
||||||
description: |
|
description: |
|
||||||
Security group ID.
|
Security group ID.
|
||||||
|
Reference in New Issue
Block a user