[8.7] [DOCS] Add responses components in connector open API specification (#153136) (#153909)

# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Add responses components in connector open API specification
(#153136)](https://github.com/elastic/kibana/pull/153136)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-03-29T02:28:43Z","message":"[DOCS]
Add responses components in connector open API specification
(#153136)","sha":"782a3d5e4285470763acb2c20aa3407b60c6fe06","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorsManagement","v8.8.0","v8.7.1"],"number":153136,"url":"https://github.com/elastic/kibana/pull/153136","mergeCommit":{"message":"[DOCS]
Add responses components in connector open API specification
(#153136)","sha":"782a3d5e4285470763acb2c20aa3407b60c6fe06"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/153136","number":153136,"mergeCommit":{"message":"[DOCS]
Add responses components in connector open API specification
(#153136)","sha":"782a3d5e4285470763acb2c20aa3407b60c6fe06"}},{"branch":"8.7","label":"v8.7.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2023-03-29 00:24:16 -04:00 committed by GitHub
parent 3a33952eb3
commit 510b3078da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 262 additions and 475 deletions

View file

@ -98,7 +98,7 @@ Any modifications made to this file will be overwritten.
<a href="#connector_response_properties">connector_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="deleteConnector"/>
@ -146,7 +146,7 @@ Any modifications made to this file will be overwritten.
<a href="#"></a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
<h4 class="field-label">404</h4>
Object is not found.
<a href="#getConnector_404_response">getConnector_404_response</a>
@ -198,7 +198,7 @@ Any modifications made to this file will be overwritten.
<a href="#connector_response_properties">connector_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
<h4 class="field-label">404</h4>
Object is not found.
<a href="#getConnector_404_response">getConnector_404_response</a>
@ -262,7 +262,7 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getConnectors"/>
@ -320,7 +320,7 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyCreateConnector"/>
@ -394,7 +394,7 @@ Any modifications made to this file will be overwritten.
<a href="#action_response_properties">action_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyDeleteConnector"/>
@ -442,7 +442,7 @@ Any modifications made to this file will be overwritten.
<a href="#"></a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyGetConnector"/>
@ -499,7 +499,7 @@ Any modifications made to this file will be overwritten.
<a href="#action_response_properties">action_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyGetConnectorTypes"/>
@ -553,7 +553,7 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyGetConnectors"/>
@ -608,7 +608,7 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyRunConnector"/>
@ -679,7 +679,7 @@ Any modifications made to this file will be overwritten.
<a href="#legacyRunConnector_200_response">legacyRunConnector_200_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyUpdateConnector"/>
@ -755,7 +755,7 @@ Any modifications made to this file will be overwritten.
<a href="#action_response_properties">action_response_properties</a>
<h4 class="field-label">404</h4>
Object is not found.
<a href="#404_response">404_response</a>
<a href="#Not_found_response">Not_found_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="runConnector"/>
@ -826,7 +826,7 @@ Any modifications made to this file will be overwritten.
<a href="#runConnector_200_response">runConnector_200_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="updateConnector"/>
@ -897,10 +897,10 @@ Any modifications made to this file will be overwritten.
<a href="#updateConnector_400_response">updateConnector_400_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
<a href="#Unauthorized_response">Unauthorized_response</a>
<h4 class="field-label">404</h4>
Object is not found.
<a href="#404_response">404_response</a>
<a href="#Not_found_response">Not_found_response</a>
</div> <!-- method -->
<hr/>
@ -909,8 +909,6 @@ Any modifications made to this file will be overwritten.
<h3>Table of Contents</h3>
<ol>
<li><a href="#401_response"><code>401_response</code> - Unsuccessful rule API response</a></li>
<li><a href="#404_response"><code>404_response</code> - </a></li>
<li><a href="#Alert_identifier_mapping"><code>Alert_identifier_mapping</code> - Alert identifier mapping</a></li>
<li><a href="#Case_comment_mapping"><code>Case_comment_mapping</code> - Case comment mapping</a></li>
<li><a href="#Case_description_mapping"><code>Case_description_mapping</code> - Case description mapping</a></li>
@ -924,11 +922,13 @@ Any modifications made to this file will be overwritten.
<li><a href="#Legacy_get_connector_types_response_body_properties_inner"><code>Legacy_get_connector_types_response_body_properties_inner</code> - </a></li>
<li><a href="#Legacy_run_connector_request_body_properties"><code>Legacy_run_connector_request_body_properties</code> - Legacy run connector request body properties</a></li>
<li><a href="#Legacy_update_connector_request_body_properties"><code>Legacy_update_connector_request_body_properties</code> - Legacy update connector request body properties</a></li>
<li><a href="#Not_found_response"><code>Not_found_response</code> - Not found response</a></li>
<li><a href="#Rule_name_mapping"><code>Rule_name_mapping</code> - Rule name mapping</a></li>
<li><a href="#Run_connector_request_body_properties"><code>Run_connector_request_body_properties</code> - Run connector request body properties</a></li>
<li><a href="#Run_connector_request_body_properties_params"><code>Run_connector_request_body_properties_params</code> - </a></li>
<li><a href="#Severity_mapping"><code>Severity_mapping</code> - Severity mapping</a></li>
<li><a href="#Subaction_parameters"><code>Subaction_parameters</code> - Subaction parameters</a></li>
<li><a href="#Unauthorized_response"><code>Unauthorized_response</code> - Unauthorized response</a></li>
<li><a href="#Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a></li>
<li><a href="#action_response_properties"><code>action_response_properties</code> - Action response properties</a></li>
<li><a href="#config_properties_cases_webhook"><code>config_properties_cases_webhook</code> - Connector request properties for Webhook - Case Management connector</a></li>
@ -1028,32 +1028,6 @@ Any modifications made to this file will be overwritten.
<li><a href="#update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a></li>
</ol>
<div class="model">
<h3><a name="401_response"><code>401_response</code> - Unsuccessful rule API response</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">Unauthorized</div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">401</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="404_response"><code>404_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">Not Found</div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">404</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Alert_identifier_mapping"><code>Alert_identifier_mapping</code> - Alert identifier mapping</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Mapping for the alert ID.</div>
@ -1194,6 +1168,19 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The updated secrets configuration for the connector. Secrets properties vary depending on the connector type. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Not_found_response"><code>Not_found_response</code> - Not found response</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">Not Found</div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">404</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Rule_name_mapping"><code>Rule_name_mapping</code> - Rule name mapping</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Mapping for the name of the alert's rule.</div>
@ -1246,6 +1233,19 @@ Any modifications made to this file will be overwritten.
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams">run_connector_subaction_pushtoservice_subActionParams</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Unauthorized_response"><code>Unauthorized_response</code> - Unauthorized response</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">Unauthorized</div>
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">401</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the connector type.</div>

View file

@ -130,14 +130,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -185,14 +178,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
},
"404": {
"description": "Object is not found.",
@ -248,14 +234,7 @@
"description": "Indicates a successful call."
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
},
"404": {
"description": "Object is not found.",
@ -387,24 +366,10 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
},
"404": {
"description": "Object is not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404_response"
}
}
}
"$ref": "#/components/responses/404"
}
},
"servers": [
@ -498,14 +463,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -605,14 +563,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -795,14 +746,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -842,14 +786,7 @@
"description": "Indicates a successful call."
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -876,24 +813,10 @@
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
"$ref": "#/components/responses/200_actions"
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -949,24 +872,10 @@
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
"$ref": "#/components/responses/200_actions"
},
"404": {
"description": "Object is not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404_response"
}
}
}
"$ref": "#/components/responses/404"
}
},
"servers": [
@ -1010,14 +919,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -1073,24 +975,10 @@
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
"$ref": "#/components/responses/200_actions"
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -1163,14 +1051,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -1263,14 +1144,7 @@
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
"$ref": "#/components/responses/401"
}
},
"servers": [
@ -3318,29 +3192,6 @@
"propertyName": "connector_type_id"
}
},
"401_response": {
"type": "object",
"title": "Unsuccessful rule API response",
"properties": {
"error": {
"type": "string",
"example": "Unauthorized",
"enum": [
"Unauthorized"
]
},
"message": {
"type": "string"
},
"statusCode": {
"type": "integer",
"example": 401,
"enum": [
401
]
}
}
},
"update_connector_request_cases_webhook": {
"title": "Update Webhook - Case Managment connector request",
"type": "object",
@ -3519,29 +3370,6 @@
}
}
},
"404_response": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Not Found",
"enum": [
"Not Found"
]
},
"message": {
"type": "string",
"example": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
},
"statusCode": {
"type": "integer",
"example": 404,
"enum": [
404
]
}
}
},
"connector_types": {
"title": "Connector types",
"type": "string",
@ -4626,6 +4454,79 @@
"status": "ok"
}
}
},
"responses": {
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Unauthorized response",
"properties": {
"error": {
"type": "string",
"example": "Unauthorized",
"enum": [
"Unauthorized"
]
},
"message": {
"type": "string"
},
"statusCode": {
"type": "integer",
"example": 401,
"enum": [
401
]
}
}
}
}
}
},
"404": {
"description": "Object is not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Not found response",
"properties": {
"error": {
"type": "string",
"example": "Not Found",
"enum": [
"Not Found"
]
},
"message": {
"type": "string",
"example": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
},
"statusCode": {
"type": "integer",
"example": 404,
"enum": [
404
]
}
}
}
}
}
},
"200_actions": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
}
}
},
"security": [

View file

@ -67,11 +67,7 @@ paths:
createIndexConnectorResponse:
$ref: '#/components/examples/create_index_connector_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -98,11 +94,7 @@ paths:
getConnectorResponse:
$ref: '#/components/examples/get_connector_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
'404':
description: Object is not found.
content:
@ -136,11 +128,7 @@ paths:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
'404':
description: Object is not found.
content:
@ -214,17 +202,9 @@ paths:
type: integer
example: 400
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
'404':
description: Object is not found.
content:
application/json:
schema:
$ref: '#/components/schemas/404_response'
$ref: '#/components/responses/404'
servers:
- url: https://localhost:5601
servers:
@ -288,11 +268,7 @@ paths:
getConnectorsResponse:
$ref: '#/components/examples/get_connectors_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -359,11 +335,7 @@ paths:
getConnectorTypesResponse:
$ref: '#/components/examples/get_connector_types_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -463,11 +435,7 @@ paths:
runSwimlaneConnectorResponse:
$ref: '#/components/examples/run_swimlane_connector_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -489,11 +457,7 @@ paths:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
get:
@ -508,17 +472,9 @@ paths:
- $ref: '#/components/parameters/space_id'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
$ref: '#/components/responses/200_actions'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
put:
@ -552,17 +508,9 @@ paths:
description: The updated secrets configuration for the connector. Secrets properties vary depending on the connector type.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
$ref: '#/components/responses/200_actions'
'404':
description: Object is not found.
content:
application/json:
schema:
$ref: '#/components/schemas/404_response'
$ref: '#/components/responses/404'
servers:
- url: https://localhost:5601
servers:
@ -587,11 +535,7 @@ paths:
items:
$ref: '#/components/schemas/action_response_properties'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
post:
@ -627,17 +571,9 @@ paths:
The secrets configuration for the connector. Secrets configuration properties vary depending on the connector type. NOTE: Remember these values. You must provide them each time you update the connector.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
$ref: '#/components/responses/200_actions'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -684,11 +620,7 @@ paths:
type: string
description: The name of the connector type.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -742,11 +674,7 @@ paths:
type: string
description: The status of the action.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
$ref: '#/components/responses/401'
servers:
- url: https://localhost:5601
servers:
@ -2279,22 +2207,6 @@ components:
- $ref: '#/components/schemas/connector_response_properties_xmatters'
discriminator:
propertyName: connector_type_id
401_response:
type: object
title: Unsuccessful rule API response
properties:
error:
type: string
example: Unauthorized
enum:
- Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
enum:
- 401
update_connector_request_cases_webhook:
title: Update Webhook - Case Managment connector request
type: object
@ -2422,22 +2334,6 @@ components:
example: my-connector
secrets:
$ref: '#/components/schemas/secrets_properties_swimlane'
404_response:
type: object
properties:
error:
type: string
example: Not Found
enum:
- Not Found
message:
type: string
example: Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
statusCode:
type: integer
example: 404
enum:
- 404
connector_types:
title: Connector types
type: string
@ -3210,6 +3106,54 @@ components:
- commentId: 1
pushedDate: '2022-09-08T16:52:27.865Z'
status: ok
responses:
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
title: Unauthorized response
properties:
error:
type: string
example: Unauthorized
enum:
- Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
enum:
- 401
'404':
description: Object is not found.
content:
application/json:
schema:
type: object
title: Not found response
properties:
error:
type: string
example: Not Found
enum:
- Not Found
message:
type: string
example: Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
statusCode:
type: integer
example: 404
enum:
- 404
200_actions:
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
security:
- basicAuth: []
- apiKeyAuth: []

View file

@ -0,0 +1,5 @@
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../schemas/action_response_properties.yaml'

View file

@ -0,0 +1,19 @@
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
title: Unauthorized response
properties:
error:
type: string
example: Unauthorized
enum:
- Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
enum:
- 401

View file

@ -0,0 +1,20 @@
description: Object is not found.
content:
application/json:
schema:
type: object
title: Not found response
properties:
error:
type: string
example: Not Found
enum:
- Not Found
message:
type: string
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
statusCode:
type: integer
example: 404
enum:
- 404

View file

@ -1,15 +0,0 @@
type: object
title: Unsuccessful rule API response
properties:
error:
type: string
example: Unauthorized
enum:
- Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
enum:
- 401

View file

@ -1,15 +0,0 @@
type: object
properties:
error:
type: string
example: Not Found
enum:
- Not Found
message:
type: string
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
statusCode:
type: integer
example: 404
enum:
- 404

View file

@ -17,11 +17,7 @@ get:
items:
$ref: '../components/schemas/action_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
@ -60,17 +56,9 @@ post:
NOTE: Remember these values. You must provide them each time you update the connector.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/action_response_properties.yaml'
$ref: '../components/responses/200_actions.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -15,11 +15,7 @@ delete:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
@ -35,17 +31,9 @@ get:
- $ref: '../components/parameters/space_id.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/action_response_properties.yaml'
$ref: '../components/responses/200_actions.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
@ -80,17 +68,9 @@ put:
description: The updated secrets configuration for the connector. Secrets properties vary depending on the connector type.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/action_response_properties.yaml'
$ref: '../components/responses/200_actions.yaml'
'404':
description: Object is not found.
content:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
$ref: '../components/responses/404.yaml'
servers:
- url: https://localhost:5601

View file

@ -46,11 +46,7 @@ post:
type: string
description: The status of the action.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -49,11 +49,7 @@ post:
createIndexConnectorResponse:
$ref: '../components/examples/create_index_connector_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -19,11 +19,7 @@ get:
getConnectorResponse:
$ref: '../components/examples/get_connector_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
'404':
description: Object is not found.
content:
@ -59,11 +55,7 @@ delete:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
'404':
description: Object is not found.
content:
@ -145,17 +137,9 @@ put:
type: integer
example: 400
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
'404':
description: Object is not found.
content:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
$ref: '../components/responses/404.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -94,11 +94,7 @@ post:
runSwimlaneConnectorResponse:
$ref: '../components/examples/run_swimlane_connector_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -59,11 +59,7 @@ get:
getConnectorTypesResponse:
$ref: '../components/examples/get_connector_types_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -56,11 +56,7 @@ get:
getConnectorsResponse:
$ref: '../components/examples/get_connectors_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers:

View file

@ -39,11 +39,7 @@ get:
type: string
description: The name of the connector type.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
$ref: '../components/responses/401.yaml'
servers:
- url: https://localhost:5601
servers: