github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Add 401 responses to case API specifications (#148857)

Browse source
This commit is contained in:
Lisa Cawley 2023-01-17 08:20:51 -08:00 • committed by GitHub
parent 8836e78460
commit 9e837b80dc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 619 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

94
docs/api-generated/cases/case-apis-passthru.asciidoc
View file

@ -160,6 +160,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#case_response_properties">case_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="createCase"/>
@ -277,6 +280,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#case_response_properties">case_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="deleteCase"/>
@ -315,11 +321,20 @@ Any modifications made to this file will be overwritten.
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">204</h4>
Indicates a successful call.
<a href="#"></a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="deleteCaseComment"/>
@ -356,11 +371,20 @@ Any modifications made to this file will be overwritten.
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">204</h4>
Indicates a successful call.
<a href="#"></a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="deleteCaseComments"/>
@ -395,11 +419,20 @@ Any modifications made to this file will be overwritten.
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">204</h4>
Indicates a successful call.
<a href="#"></a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getAllCaseComments"/>
@ -500,6 +533,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#case_response_properties">case_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCase"/>
@ -606,6 +642,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#case_response_properties">case_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseActivity"/>
@ -666,6 +705,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseAlerts"/>
@ -716,6 +758,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseComment"/>
@ -764,6 +809,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#getCaseComment_200_response">getCaseComment_200_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseConfiguration"/>
@ -849,6 +897,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseConnectors"/>
@ -905,6 +956,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseReporters"/>
@ -960,6 +1014,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseStatus"/>
@ -1014,6 +1071,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#getCaseStatus_200_response">getCaseStatus_200_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseTags"/>
@ -1064,6 +1124,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCases"/>
@ -1260,6 +1323,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#getCases_200_response">getCases_200_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCasesByAlert"/>
@ -1315,6 +1381,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="pushCase"/>
@ -1436,6 +1505,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#case_response_properties">case_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="setCaseConfiguration"/>
@ -1534,6 +1606,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#getCaseConfiguration_200_response_inner">getCaseConfiguration_200_response_inner</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="updateCase"/>
@ -1651,6 +1726,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="updateCaseComment"/>
@ -1770,6 +1848,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#case_response_properties">case_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="updateCaseConfiguration"/>
@ -1870,6 +1951,9 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#4xx_response">4xx_response</a>
</div> <!-- method -->
<hr/>
@ -1878,6 +1962,7 @@ Any modifications made to this file will be overwritten.
<h3>Table of Contents</h3>
<ol>
<li><a href="#4xx_response"><code>4xx_response</code> - Unsuccessful cases API response</a></li>
<li><a href="#Case_response_properties_for_comments_inner"><code>Case_response_properties_for_comments_inner</code> - </a></li>
<li><a href="#Case_response_properties_for_connectors"><code>Case_response_properties_for_connectors</code> - Case response properties for connectors</a></li>
<li><a href="#action_types"><code>action_types</code> - </a></li>
@ -1964,6 +2049,15 @@ Any modifications made to this file will be overwritten.
<li><a href="#user_comment_response_properties"><code>user_comment_response_properties</code> - Case response properties for user comments</a></li>
</ol>
<div class="model">
<h3><a name="4xx_response"><code>4xx_response</code> - Unsuccessful cases 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">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> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Case_response_properties_for_comments_inner"><code>Case_response_properties_for_comments_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>

237
x-pack/plugins/cases/docs/openapi/bundled.json
View file

@ -71,6 +71,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -107,6 +117,16 @@
"responses": {
"204": {
"description": "Indicates a successful call."
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -162,6 +182,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -419,6 +449,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -482,6 +522,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -649,6 +699,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -882,6 +942,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1104,6 +1174,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1184,6 +1264,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1253,6 +1343,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1310,6 +1410,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1373,6 +1483,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1428,6 +1548,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1477,6 +1607,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1540,6 +1680,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1569,6 +1719,16 @@
"responses": {
"204": {
"description": "Indicates a successful call."
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1625,6 +1785,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1659,6 +1829,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1698,6 +1878,16 @@
"responses": {
"204": {
"description": "Indicates a successful call."
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1746,6 +1936,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1807,6 +2007,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -1856,6 +2066,16 @@
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/4xx_response"
}
}
}
}
},
"servers": [
@ -3008,6 +3228,23 @@
}
}
},
"4xx_response": {
"type": "object",
"title": "Unsuccessful cases API response",
"properties": {
"error": {
"type": "string",
"example": "Unauthorized"
},
"message": {
"type": "string"
},
"statusCode": {
"type": "integer",
"example": 401
}
}
},
"update_case_request": {
"title": "Update case request",
"description": "The update case API request body varies depending on the type of connector.",

144
x-pack/plugins/cases/docs/openapi/bundled.yaml
View file

@ -45,6 +45,12 @@ paths:
examples:
createCaseResponse:
$ref: '#/components/examples/create_case_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
delete:
@ -67,6 +73,12 @@ paths:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
patch:
@ -99,6 +111,12 @@ paths:
examples:
updateCaseResponse:
$ref: '#/components/examples/update_case_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -257,6 +275,12 @@ paths:
examples:
findCaseResponse:
$ref: '#/components/examples/find_case_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -293,6 +317,12 @@ paths:
example:
- id: 06116b80-e1c3-11ec-be9b-9b1838238ee6
title: security_case
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -409,6 +439,12 @@ paths:
version:
type: string
example: WzIwNzMsMV0=
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
post:
@ -573,6 +609,12 @@ paths:
examples:
setCaseConfigResponse:
$ref: '#/components/examples/set_case_configuration_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -728,6 +770,12 @@ paths:
version:
type: string
example: WzIwNzMsMV0=
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -777,6 +825,12 @@ paths:
examples:
findConnectorResponse:
$ref: '#/components/examples/find_connector_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -820,6 +874,12 @@ paths:
examples:
getReportersResponse:
$ref: '#/components/examples/get_reporters_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -853,6 +913,12 @@ paths:
examples:
getStatusResponse:
$ref: '#/components/examples/get_status_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -888,6 +954,12 @@ paths:
examples:
getTagsResponse:
$ref: '#/components/examples/get_tags_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -920,6 +992,12 @@ paths:
examples:
getCaseResponse:
$ref: '#/components/examples/get_case_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -948,6 +1026,12 @@ paths:
examples:
getCaseAlertsResponse:
$ref: '#/components/examples/get_case_alerts_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -983,6 +1067,12 @@ paths:
examples:
createCaseCommentResponse:
$ref: '#/components/examples/add_comment_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
delete:
@ -999,6 +1089,12 @@ paths:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
patch:
@ -1031,6 +1127,12 @@ paths:
examples:
updateCaseCommentResponse:
$ref: '#/components/examples/update_comment_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
get:
@ -1051,6 +1153,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/case_response_properties'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -1071,6 +1179,12 @@ paths:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
get:
@ -1096,6 +1210,12 @@ paths:
examples:
getCaseCommentResponse:
$ref: '#/components/examples/get_comment_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -1129,6 +1249,12 @@ paths:
examples:
pushCaseResponse:
$ref: '#/components/examples/push_case_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -1157,6 +1283,12 @@ paths:
examples:
getCaseActivityResponse:
$ref: '#/components/examples/get_case_activity_response'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/4xx_response'
servers:
- url: https://localhost:5601
servers:
@ -2004,6 +2136,18 @@ components:
version:
type: string
example: WzUzMiwxXQ==
4xx_response:
type: object
title: Unsuccessful cases API response
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
update_case_request:
title: Update case request
description: The update case API request body varies depending on the type of connector.

11
x-pack/plugins/cases/docs/openapi/components/schemas/4xx_response.yaml Normal file
View file

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

18
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases.yaml
View file

@ -29,6 +29,12 @@ post:
examples:
createCaseResponse:
$ref: '../components/examples/create_case_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -55,6 +61,12 @@ delete:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -90,6 +102,12 @@ patch:
examples:
updateCaseResponse:
$ref: '../components/examples/update_case_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@_find.yaml
View file

@ -163,6 +163,12 @@ get:
examples:
findCaseResponse:
$ref: '../components/examples/find_case_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

8
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml
View file

@ -30,7 +30,13 @@ get:
description: The case title.
example:
- id: 06116b80-e1c3-11ec-be9b-9b1838238ee6
title: security_case
title: security_case
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

13
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure.yaml
View file

@ -21,6 +21,12 @@ get:
type: object
properties:
$ref: '../components/schemas/case_configure_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -90,8 +96,13 @@ post:
examples:
setCaseConfigResponse:
$ref: '../components/examples/set_case_configuration_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml
View file

@ -23,6 +23,12 @@ get:
examples:
findConnectorResponse:
$ref: '../components/examples/find_connector_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@configure@{configurationid}.yaml
View file

@ -50,6 +50,12 @@ patch:
type: object
properties:
$ref: '../components/schemas/case_configure_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@reporters.yaml
View file

@ -28,6 +28,12 @@ get:
examples:
getReportersResponse:
$ref: '../components/examples/get_reporters_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@status.yaml
View file

@ -28,6 +28,12 @@ get:
examples:
getStatusResponse:
$ref: '../components/examples/get_status_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

7
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@tags.yaml
View file

@ -30,7 +30,12 @@ get:
examples:
getTagsResponse:
$ref: '../components/examples/get_tags_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}.yaml
View file

@ -27,6 +27,12 @@ get:
examples:
getCaseResponse:
$ref: '../components/examples/get_case_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@alerts.yaml
View file

@ -23,6 +23,12 @@ get:
examples:
getCaseAlertsResponse:
$ref: '../components/examples/get_case_alerts_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

26
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments.yaml
View file

@ -31,6 +31,12 @@ post:
examples:
createCaseCommentResponse:
$ref: '../components/examples/add_comment_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -50,6 +56,12 @@ delete:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -86,6 +98,12 @@ patch:
examples:
updateCaseCommentResponse:
$ref: '../components/examples/update_comment_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -109,9 +127,13 @@ get:
application/json:
schema:
$ref: '../components/schemas/case_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

13
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml
View file

@ -15,6 +15,12 @@ delete:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
@ -43,8 +49,13 @@ get:
examples:
getCaseCommentResponse:
$ref: '../components/examples/get_comment_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@connector@{connectorid}@_push.yaml
View file

@ -30,6 +30,12 @@ post:
examples:
pushCaseResponse:
$ref: '../components/examples/push_case_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers:

6
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@user_actions.yaml
View file

@ -23,6 +23,12 @@ get:
examples:
getCaseActivityResponse:
$ref: '../components/examples/get_case_activity_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
servers:
- url: https://localhost:5601
servers: