Skip to content

Commit

Permalink
[DOCS] Automate docs for get case APIs (elastic#144950)
Browse files Browse the repository at this point in the history
(cherry picked from commit 6804cff)
  • Loading branch information
lcawl committed Nov 10, 2022
1 parent 007f551 commit 64c9e6d
Show file tree
Hide file tree
Showing 11 changed files with 901 additions and 29 deletions.
543 changes: 540 additions & 3 deletions x-pack/plugins/cases/docs/openapi/bundled-min.json

Large diffs are not rendered by default.

341 changes: 338 additions & 3 deletions x-pack/plugins/cases/docs/openapi/bundled-min.yaml

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions x-pack/plugins/cases/docs/openapi/entrypoint-min.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,28 @@ paths:
$ref: 'paths/s@{spaceid}@api@cases.yaml'
# '/s/{spaceId}/api/cases/_find':
# $ref: 'paths/s@{spaceid}@api@cases@_find.yaml'
# '/s/{spaceId}/api/cases/alerts/{alertId}':
# $ref: 'paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml'
'/s/{spaceId}/api/cases/alerts/{alertId}':
$ref: 'paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml'
'/s/{spaceId}/api/cases/configure':
$ref: paths/s@{spaceid}@api@cases@configure.yaml
'/s/{spaceId}/api/cases/configure/{configurationId}':
$ref: paths/s@{spaceid}@api@cases@configure@{configurationid}.yaml
# '/s/{spaceId}/api/cases/configure/connectors/_find':
# $ref: paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml
# '/s/{spaceId}/api/cases/reporters':
# $ref: 'paths/s@{spaceid}@api@cases@reporters.yaml'
# '/s/{spaceId}/api/cases/status':
# $ref: 'paths/s@{spaceid}@api@cases@status.yaml'
# '/s/{spaceId}/api/cases/tags':
# $ref: 'paths/s@{spaceid}@api@cases@tags.yaml'
# '/s/{spaceId}/api/cases/{caseId}':
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}.yaml'
'/s/{spaceId}/api/cases/reporters':
$ref: 'paths/s@{spaceid}@api@cases@reporters.yaml'
'/s/{spaceId}/api/cases/status':
$ref: 'paths/s@{spaceid}@api@cases@status.yaml'
'/s/{spaceId}/api/cases/tags':
$ref: 'paths/s@{spaceid}@api@cases@tags.yaml'
'/s/{spaceId}/api/cases/{caseId}':
$ref: 'paths/s@{spaceid}@api@cases@{caseid}.yaml'
# '/s/{spaceId}/api/cases/{caseId}/alerts':
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}@alerts.yaml'
'/s/{spaceId}/api/cases/{caseId}/comments':
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments.yaml'
# '/s/{spaceId}/api/cases/{caseId}/comments/{commentId}':
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml'
'/s/{spaceId}/api/cases/{caseId}/comments/{commentId}':
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml'
'/s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push':
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@connector@{connectorid}@_push.yaml'
# '/s/{spaceId}/api/cases/{caseId}/user_actions':
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:
Expand Down Expand Up @@ -82,7 +82,7 @@ post:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ patch:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
summary: Aggregates and returns a list of case tags.
operationId: getCaseTags
description: >
You must have read privileges for the **Cases*** feature in the
You must have read privileges for the **Cases** feature in the
**Management**, **Observability**, or **Security** section of the Kibana
feature privileges, depending on the owner of the cases you're seeking.
tags:
Expand All @@ -22,7 +22,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ get:
operationId: getCaseComment
description: >
You must have `read` privileges for the **Cases** feature in the **Management**,
**Observability**, or **Security*** section of the Kibana feature privileges,
**Observability**, or **Security** section of the Kibana feature privileges,
depending on the owner of the cases with the comments you're seeking.
tags:
- cases
Expand All @@ -35,7 +35,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
oneOf:
- $ref: '../components/schemas/alert_comment_response_properties.yaml'
Expand Down

0 comments on commit 64c9e6d

Please sign in to comment.