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