github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Lint case API specifications (#149641)

Browse source
This commit is contained in:
Lisa Cawley 2023-01-31 12:01:00 -08:00 • committed by GitHub
parent e534d87843
commit 502fb009cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 29 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api-generated/README.md
View file

@ -25,7 +25,7 @@ or a similar tool that can generate HTML output from OAS.
. Rename the output files. For example:
```
mv $GIT_HOME/kibana/docs/api-generated/rules/index.html $GIT_HOME/kibana/docs/api-generated/rules/rule-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/rules/index.html $GIT_HOME/kibana/docs/api-generated/rules/rule-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/cases/index.html $GIT_HOME/kibana/docs/api-generated/cases/case-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/connectors/index.html $GIT_HOME/kibana/docs/api-generated/connectors/connector-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/machine-learning/index.html $GIT_HOME/kibana/docs/api-generated/machine-learning/ml-apis-passthru.asciidoc

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

@ -78,7 +78,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -198,7 +198,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -306,7 +306,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -362,7 +362,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -410,7 +410,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -482,7 +482,6 @@ Any modifications made to this file will be overwritten.
<pre class="example"><code>{
"userActions" : [ {
"owner" : "cases",
"case_id" : "22df07d0-03b1-11ed-920c-974bfa104448",
"action" : "create",
"created_at" : "2022-05-13T09:16:17.416Z",
"id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
@ -497,7 +496,6 @@ Any modifications made to this file will be overwritten.
"version" : "WzM1ODg4LDFd"
}, {
"owner" : "cases",
"case_id" : "22df07d0-03b1-11ed-920c-974bfa104448",
"action" : "create",
"created_at" : "2022-05-13T09:16:17.416Z",
"id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
@ -1519,7 +1517,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -1639,7 +1637,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -1740,7 +1738,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -1862,7 +1860,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -1984,7 +1982,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -3001,7 +2999,6 @@ Any modifications made to this file will be overwritten.
<div class='model-description'></div>
<div class="field-items">
<div class="param">action </div><div class="param-desc"><span class="param-type"><a href="#actions">actions</a></span> </div>
<div class="param">case_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">comment_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">created_at </div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
<div class="param">created_by </div><div class="param-desc"><span class="param-type"><a href="#user_actions_response_properties_created_by">user_actions_response_properties_created_by</a></span> </div>
@ -3009,7 +3006,9 @@ Any modifications made to this file will be overwritten.
<div class="param">owner </div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
<div class="param">payload </div><div class="param-desc"><span class="param-type"><a href="#user_actions_response_properties_payload">user_actions_response_properties_payload</a></span> </div>
<div class="param">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#action_types">action_types</a></span> </div>
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of action. </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">assignees</div><div class="param-enum">create_case</div><div class="param-enum">comment</div><div class="param-enum">connector</div><div class="param-enum">description</div><div class="param-enum">pushed</div><div class="param-enum">tags</div><div class="param-enum">title</div><div class="param-enum">status</div><div class="param-enum">settings</div><div class="param-enum">severity</div>
</div> <!-- field-items -->
</div>
<div class="model">

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

@ -2111,9 +2111,9 @@
"description": "The page number to return.",
"schema": {
"type": "string",
"default": 1
"default": "1"
},
"example": 1
"example": "1"
},
{
"name": "perPage",
@ -2121,9 +2121,9 @@
"description": "The number of user actions to return per page.",
"schema": {
"type": "string",
"default": 20
"default": "20"
},
"example": 20
"example": "20"
},
{
"name": "sortOrder",
@ -2245,6 +2245,7 @@
},
"in": "header",
"name": "kbn-xsrf",
"description": "Cross-site request forgery protection",
"required": true
},
"space_id": {

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

@ -1309,15 +1309,15 @@ paths:
description: The page number to return.
schema:
type: string
default: 1
example: 1
default: '1'
example: '1'
- name: perPage
in: query
description: The number of user actions to return per page.
schema:
type: string
default: 20
example: 20
default: '20'
example: '20'
- name: sortOrder
in: query
description: Determines the sort order.
@ -1398,6 +1398,7 @@ components:
type: string
in: header
name: kbn-xsrf
description: Cross-site request forgery protection
required: true
space_id:
in: path

1
x-pack/plugins/cases/docs/openapi/components/headers/kbn_xsrf.yaml
View file

@ -2,4 +2,5 @@ schema:
type: string
in: header
name: kbn-xsrf
description: Cross-site request forgery protection
required: true

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

@ -15,15 +15,15 @@ get:
description: The page number to return.
schema:
type: string
default: 1
example: 1
default: "1"
example: "1"
- name: perPage
in: query
description: The number of user actions to return per page.
schema:
type: string
default: 20
example: 20
default: "20"
example: "20"
- name: sortOrder
in: query
description: Determines the sort order.