diff --git a/certified-connectors/Riverbed IQ Assist/README.md b/certified-connectors/Riverbed IQ Assist/README.md index c3e221f558..176d9d2fca 100644 --- a/certified-connectors/Riverbed IQ Assist/README.md +++ b/certified-connectors/Riverbed IQ Assist/README.md @@ -29,7 +29,7 @@ This operation runs endpoint analysis to diagnose a device issue. ### SuggestUserEndpointRemediation This operation suggests a remediation for a device based on diagnosis or symptoms. -### GetOperationId +### GetOperation This operation retrieves the status of a long-running operation initiated by one of the other operations. ## Known Issues and Limitations diff --git a/certified-connectors/Riverbed IQ Assist/apiDefinition.swagger.json b/certified-connectors/Riverbed IQ Assist/apiDefinition.swagger.json index 5add45fe49..33165d25f6 100644 --- a/certified-connectors/Riverbed IQ Assist/apiDefinition.swagger.json +++ b/certified-connectors/Riverbed IQ Assist/apiDefinition.swagger.json @@ -21,9 +21,9 @@ "Skill", "Operation" ], - "summary": "Retrieve Result or Status of Async Operation", - "description": "Use this endpoint to get the results of a long running operation returned by http 202", - "operationId": "GetOperationId", + "summary": "Poll Operation Status", + "description": "Use this endpoint to get the results of a long running operation returned by HTTP 202", + "operationId": "GetOperation", "produces": [ "application/json" ], @@ -35,7 +35,8 @@ "required": true, "type": "string", "x-ms-url-encoding": "single", - "x-ms-summary": "Operation ID" + "x-ms-summary": "Operation ID", + "x-ms-visibility": "important" } ], "responses": { @@ -75,26 +76,47 @@ { "in": "query", "name": "asynchttp", - "description": "Expect a 202 response and poll the returned location URI until completion", + "description": "Respond with a pollable status endpoint.", "type": "boolean", - "x-ms-summary": "Expect a 202 response and poll the returned location URI until completion" + "x-ms-summary": "Respond with a pollable status endpoint.", + "x-ms-visibility": "advanced" }, { "in": "body", "name": "body", - "description": "This is the request body", "required": true, "schema": { - "$ref": "#/definitions/FindUserEndpoint" + "type": "object", + "properties": { + "username": { + "title": "Username", + "description": "The username of the user.", + "type": "string", + "x-ms-visibility": "important" + }, + "email": { + "title": "Email Address", + "description": "User email address", + "type": "string", + "x-ms-visibility": "important" + }, + "displayName": { + "title": "Display Name", + "description": "User Display Name", + "type": "string", + "x-ms-visibility": "important" + } + }, + "additionalProperties": false }, - "x-ms-summary": "This is the request body" + "x-ms-visibility": "important" } ], "responses": { "200": { "description": "The output generated from the action", "schema": { - "$ref": "#/definitions/SkillOutput" + "$ref": "#/definitions/FindUserEndpointResponse" } }, "202": { @@ -124,26 +146,53 @@ { "in": "query", "name": "asynchttp", - "description": "Expect a 202 response and poll the returned location URI until completion", + "description": "Respond with a pollable status endpoint.", "type": "boolean", - "x-ms-summary": "Expect a 202 response and poll the returned location URI until completion" + "x-ms-summary": "Respond with a pollable status endpoint.", + "x-ms-visibility": "advanced" }, { "in": "body", "name": "body", - "description": "This is the request body", "required": true, "schema": { - "$ref": "#/definitions/CreateTicket" + "type": "object", + "properties": { + "shortDescription": { + "title": "Short Description", + "description": "Short description of the issue", + "type": "string", + "x-ms-visibility": "important" + }, + "description": { + "title": "Description", + "description": "Detailed description of the issue", + "type": "string", + "x-ms-visibility": "important" + }, + "username": { + "title": "Username", + "description": "Username related to the issue", + "type": "string", + "x-ms-visibility": "important" + }, + "deviceName": { + "title": "Device Name", + "description": "Device name related to the issue", + "type": "string", + "x-ms-visibility": "important" + } + }, + "additionalProperties": false }, - "x-ms-summary": "This is the request body" + "x-ms-visibility": "important" } ], "responses": { "200": { "description": "The output generated from the action", "schema": { - "$ref": "#/definitions/SkillOutput" + "$ref": "#/definitions/CreateTicketResponse" } }, "202": { @@ -173,26 +222,45 @@ { "in": "query", "name": "asynchttp", - "description": "Expect a 202 response and poll the returned location URI until completion", + "description": "Respond with a pollable status endpoint.", "type": "boolean", - "x-ms-summary": "Expect a 202 response and poll the returned location URI until completion" + "x-ms-summary": "Respond with a pollable status endpoint.", + "x-ms-visibility": "advanced" }, { "in": "body", "name": "body", - "description": "This is the request body", "required": true, "schema": { - "$ref": "#/definitions/GetRemediationRunStatus" + "required": [ + "deviceName", + "runReferenceId" + ], + "type": "object", + "properties": { + "deviceName": { + "title": "Device Name", + "description": "Device name related to the issue", + "type": "string", + "x-ms-visibility": "important" + }, + "runReferenceId": { + "title": "Run Reference ID", + "description": "Identifier of a run of a remediation", + "type": "string", + "x-ms-visibility": "important" + } + }, + "additionalProperties": false }, - "x-ms-summary": "This is the request body" + "x-ms-visibility": "important" } ], "responses": { "200": { "description": "The output generated from the action", "schema": { - "$ref": "#/definitions/SkillOutput" + "$ref": "#/definitions/GetRemediationRunStatusResponse" } }, "202": { @@ -222,26 +290,45 @@ { "in": "query", "name": "asynchttp", - "description": "Expect a 202 response and poll the returned location URI until completion", + "description": "Respond with a pollable status endpoint.", "type": "boolean", - "x-ms-summary": "Expect a 202 response and poll the returned location URI until completion" + "x-ms-summary": "Respond with a pollable status endpoint.", + "x-ms-visibility": "advanced" }, { "in": "body", "name": "body", - "description": "This is the request body", "required": true, "schema": { - "$ref": "#/definitions/StartEndpointRemediation" + "required": [ + "deviceName", + "remediationId" + ], + "type": "object", + "properties": { + "deviceName": { + "title": "Device Name", + "description": "The name of the device experiencing a problem or related to an incident that requires diagnosis.", + "type": "string", + "x-ms-visibility": "important" + }, + "remediationId": { + "title": "Remediation ID", + "description": "The ID of the remediation action to start.", + "type": "string", + "x-ms-visibility": "important" + } + }, + "additionalProperties": false }, - "x-ms-summary": "This is the request body" + "x-ms-visibility": "important" } ], "responses": { "200": { "description": "The output generated from the action", "schema": { - "$ref": "#/definitions/SkillOutput" + "$ref": "#/definitions/StartEndpointRemediationResponse" } }, "202": { @@ -271,26 +358,38 @@ { "in": "query", "name": "asynchttp", - "description": "Expect a 202 response and poll the returned location URI until completion", + "description": "Respond with a pollable status endpoint.", "type": "boolean", - "x-ms-summary": "Expect a 202 response and poll the returned location URI until completion" + "x-ms-summary": "Respond with a pollable status endpoint.", + "x-ms-visibility": "advanced" }, { "in": "body", "name": "body", - "description": "This is the request body", "required": true, "schema": { - "$ref": "#/definitions/DiagnoseEndpoint" + "required": [ + "deviceName" + ], + "type": "object", + "properties": { + "deviceName": { + "title": "Device Name", + "description": "The name of the device experiencing a problem or related to an incident that requires diagnosis.", + "type": "string", + "x-ms-visibility": "important" + } + }, + "additionalProperties": false }, - "x-ms-summary": "This is the request body" + "x-ms-visibility": "important" } ], "responses": { "200": { "description": "The output generated from the action", "schema": { - "$ref": "#/definitions/SkillOutput" + "$ref": "#/definitions/DiagnoseEndpointResponse" } }, "202": { @@ -320,26 +419,46 @@ { "in": "query", "name": "asynchttp", - "description": "Expect a 202 response and poll the returned location URI until completion", + "description": "Respond with a pollable status endpoint.", "type": "boolean", - "x-ms-summary": "Expect a 202 response and poll the returned location URI until completion" + "x-ms-summary": "Respond with a pollable status endpoint.", + "x-ms-visibility": "advanced" }, { "in": "body", "name": "body", - "description": "This is the request body", "required": true, "schema": { - "$ref": "#/definitions/SuggestEndpointRemediation" + "description": "This object is used to request a suggested remediation action for a device.", + "required": [ + "deviceName", + "issue" + ], + "type": "object", + "properties": { + "deviceName": { + "title": "Device Name", + "description": "The name of the device that the remediation action should be applied to.", + "type": "string", + "x-ms-visibility": "important" + }, + "issue": { + "title": "Issue", + "description": "The issue experienced by the user that will influence the suggested remediation action.", + "type": "string", + "x-ms-visibility": "important" + } + }, + "additionalProperties": false }, - "x-ms-summary": "This is the request body" + "x-ms-visibility": "important" } ], "responses": { "200": { "description": "The output generated from the action", "schema": { - "$ref": "#/definitions/SkillOutput" + "$ref": "#/definitions/SuggestEndpointRemediationResponse" } }, "202": { @@ -353,73 +472,70 @@ } }, "definitions": { - "CreateTicket": { + "CreateTicketResponse": { + "description": "The object contains the ticket reference number.", "type": "object", "properties": { - "shortDescription": { - "description": "Short description of the issue", - "type": "string" - }, - "description": { - "description": "Detailed description of the issue", - "type": "string" - }, - "username": { - "description": "Username related to the issue", - "type": "string" + "errorMessage": { + "description": "If the request fails, then this property will be populated with error details.", + "type": "string", + "x-ms-visibility": "important" }, - "deviceName": { - "description": "Device name related to the issue", - "type": "string" + "response": { + "description": "Ticket reference ID", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false }, - "DiagnoseEndpoint": { - "required": [ - "deviceName" - ], + "DiagnoseEndpointResponse": { + "description": "The object contains a diagnosis related to a problem on a device.", "type": "object", "properties": { - "deviceName": { - "description": "The name of the device experiencing a problem or related to an incident that requires diagnosis.", - "type": "string" + "errorMessage": { + "description": "If the request fails, then this property will be populated with error details.", + "type": "string", + "x-ms-visibility": "important" + }, + "response": { + "description": "Device diagnosis", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false }, - "FindUserEndpoint": { + "FindUserEndpointResponse": { + "description": "The object contains the device name, hostname, or endpoint name.", "type": "object", "properties": { - "username": { - "description": "The username of the user.", - "type": "string" - }, - "email": { - "description": "User email address", - "type": "string" + "errorMessage": { + "description": "If the request fails, then this property will be populated with error details.", + "type": "string", + "x-ms-visibility": "important" }, - "displayName": { - "description": "User Display Name", - "type": "string" + "response": { + "description": "Device name", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false }, - "GetRemediationRunStatus": { - "required": [ - "deviceName", - "runReferenceId" - ], + "GetRemediationRunStatusResponse": { + "description": "The object contains the current status of the remediation run.", "type": "object", "properties": { - "deviceName": { - "description": "Device name related to the issue", - "type": "string" + "errorMessage": { + "description": "If the request fails, then this property will be populated with error details.", + "type": "string", + "x-ms-visibility": "important" }, - "runReferenceId": { - "description": "Device name related to the issue", - "type": "string" + "response": { + "description": "Remediation execution status", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false @@ -428,15 +544,18 @@ "type": "object", "properties": { "operationId": { - "type": "string" + "type": "string", + "x-ms-visibility": "important" }, "location": { "format": "uri", - "type": "string" + "type": "string", + "x-ms-visibility": "important" }, "retryAfter": { - "format": "int32", - "type": "integer" + "format": "date-time", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false @@ -447,47 +566,47 @@ "properties": { "errorMessage": { "description": "If the request fails, then this property will be populated with error details.", - "type": "string" + "type": "string", + "x-ms-visibility": "important" }, "response": { "description": "The result from the tool, action, or skill invocation.", - "type": "string" + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false }, - "StartEndpointRemediation": { - "required": [ - "deviceName", - "remediationId" - ], + "StartEndpointRemediationResponse": { + "description": "The object contains reference to the remediation run.", "type": "object", "properties": { - "deviceName": { - "description": "The name of the device experiencing a problem or related to an incident that requires diagnosis.", - "type": "string" + "errorMessage": { + "description": "If the request fails, then this property will be populated with error details.", + "type": "string", + "x-ms-visibility": "important" }, - "remediationId": { - "description": "The ID of the remediation action to start.", - "type": "string" + "response": { + "description": "Remediation execution ID", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false }, - "SuggestEndpointRemediation": { - "description": "This object is used to request a suggested remediation action for a device.", - "required": [ - "deviceName" - ], + "SuggestEndpointRemediationResponse": { + "description": "The object contains a list of remediation actions that are suggested for the device.", "type": "object", "properties": { - "deviceName": { - "description": "The name of the device that the remediation action should be applied to.", - "type": "string" + "errorMessage": { + "description": "If the request fails, then this property will be populated with error details.", + "type": "string", + "x-ms-visibility": "important" }, - "issue": { - "description": "The issue experienced by the user that will influence the suggested remediation action.", - "type": "string" + "response": { + "description": "Remediation recommendations", + "type": "string", + "x-ms-visibility": "important" } }, "additionalProperties": false