[8.x] Remove anonymous combinatorial types from cases api spec (#194782) (#195348)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Remove anonymous combinatorial types from cases api spec
(#194782)](https://github.com/elastic/kibana/pull/194782)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Toby
Brain","email":"tobio85@gmail.com"},"sourceCommit":{"committedDate":"2024-10-08T06:12:43Z","message":"Remove
anonymous combinatorial types from cases api spec (#194782)\n\n##
Summary\r\n\r\nThese type definitions cause code generation to fail with
one of the\r\nmore popular Go generators due
to\r\nhttps://github.com/oapi-codegen/oapi-codegen/issues/1496.\r\n\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [x] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [x] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[x] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[x] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[x] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n###
For maintainers\r\n\r\n- [ ] This was checked for breaking API changes
and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"05f19d08ebfa367985c9e3431dc1b114a4d34535","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor"],"title":"Remove
anonymous combinatorial types from cases api
spec","number":194782,"url":"https://github.com/elastic/kibana/pull/194782","mergeCommit":{"message":"Remove
anonymous combinatorial types from cases api spec (#194782)\n\n##
Summary\r\n\r\nThese type definitions cause code generation to fail with
one of the\r\nmore popular Go generators due
to\r\nhttps://github.com/oapi-codegen/oapi-codegen/issues/1496.\r\n\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [x] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [x] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[x] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[x] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[x] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n###
For maintainers\r\n\r\n- [ ] This was checked for breaking API changes
and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"05f19d08ebfa367985c9e3431dc1b114a4d34535"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194782","number":194782,"mergeCommit":{"message":"Remove
anonymous combinatorial types from cases api spec (#194782)\n\n##
Summary\r\n\r\nThese type definitions cause code generation to fail with
one of the\r\nmore popular Go generators due
to\r\nhttps://github.com/oapi-codegen/oapi-codegen/issues/1496.\r\n\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [x] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [x] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[x] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[x] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[x] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n###
For maintainers\r\n\r\n- [ ] This was checked for breaking API changes
and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"05f19d08ebfa367985c9e3431dc1b114a4d34535"}}]}]
BACKPORT-->

Co-authored-by: Toby Brain <tobio85@gmail.com>
This commit is contained in:
Kibana Machine 2024-10-08 18:56:40 +11:00 committed by GitHub
parent 0bdfdbfbf0
commit ab9048fe3b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
37 changed files with 314 additions and 301 deletions

View file

@ -6941,7 +6941,7 @@ paths:
- $ref: '#/components/parameters/Cases_category'
- $ref: '#/components/parameters/Cases_defaultSearchOperator'
- $ref: '#/components/parameters/Cases_from'
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
- $ref: '#/components/parameters/Cases_page_index'
- $ref: '#/components/parameters/Cases_page_size'
- $ref: '#/components/parameters/Cases_reporters'
@ -7389,7 +7389,7 @@ paths:
operationId: getCasesByAlertDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_alert_id'
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -7430,7 +7430,7 @@ paths:
where the cases were created.
operationId: getCaseConfigurationDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -7561,7 +7561,7 @@ paths:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
updated_at:
@ -7609,7 +7609,7 @@ paths:
post:
description: >
Case settings include external connection details, custom fields, and
templates. Connectors are used to interface with external systems. You
templates. Connectors are used to interface with external systems. You
must create a connector before you can use it in your cases. If you set
a default connector, it is automatically selected when you create cases
in Kibana. If you use the create case API, however, you must still
@ -7757,7 +7757,7 @@ paths:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
updated_at:
@ -7953,7 +7953,7 @@ paths:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
updated_at:
@ -8062,7 +8062,7 @@ paths:
returned by this API is unchanged.
operationId: getCaseReportersDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -8117,7 +8117,7 @@ paths:
privileges, depending on the owner of the cases you're seeking.
operationId: getCaseStatusDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -8150,7 +8150,7 @@ paths:
privileges, depending on the owner of the cases you're seeking.
operationId: getCaseTagsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -24210,11 +24210,8 @@ components:
name: assignees
schema:
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_case_id:
description: >-
The identifier for the case. To retrieve case IDs, use the find cases
@ -24231,12 +24228,8 @@ components:
name: category
schema:
oneOf:
- example: my-category
type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_case_category'
- $ref: '#/components/schemas/Cases_case_categories'
Cases_comment_id:
description: >
The identifier for the comment. To retrieve comment IDs, use the get
@ -24313,7 +24306,7 @@ components:
required: true
schema:
type: string
Cases_owner:
Cases_owner_filter:
description: >
A filter to limit the response to a specific set of applications. If
this parameter is omitted, the response contains information about all
@ -24323,10 +24316,8 @@ components:
name: owner
schema:
oneOf:
- $ref: '#/components/schemas/Cases_owner'
- $ref: '#/components/schemas/Cases_owners'
- items:
$ref: '#/components/schemas/Cases_owners'
type: array
Cases_page_index:
description: The page number to return.
in: query
@ -24351,11 +24342,8 @@ components:
name: reporters
schema:
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_search:
description: >-
An Elasticsearch simple_query_string query that filters the objects in
@ -24371,9 +24359,7 @@ components:
schema:
oneOf:
- $ref: '#/components/schemas/Cases_searchFieldsType'
- items:
$ref: '#/components/schemas/Cases_searchFieldsType'
type: array
- $ref: '#/components/schemas/Cases_searchFieldsTypeArray'
Cases_severity:
description: The severity of the case.
in: query
@ -24430,11 +24416,8 @@ components:
name: tags
schema:
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_to:
description: >
Returns only cases that were created before a specific date. The date
@ -24835,7 +24818,7 @@ components:
index:
$ref: '#/components/schemas/Cases_alert_indices'
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
rule:
$ref: '#/components/schemas/Cases_rule'
type:
@ -24873,7 +24856,7 @@ components:
maxLength: 30000
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
type:
description: The type of comment.
enum:
@ -24930,7 +24913,7 @@ components:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
pushed_at:
example: null
format: date-time
@ -25073,6 +25056,11 @@ components:
maxItems: 10
nullable: true
type: array
Cases_case_categories:
items:
$ref: '#/components/schemas/Cases_case_category'
maxItems: 100
type: array
Cases_case_category:
description: A word or phrase that categorizes the case.
maxLength: 50
@ -25234,7 +25222,7 @@ components:
example: 66b9aa00-94fa-11ea-9f74-e7e108796192
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
settings:
$ref: '#/components/schemas/Cases_settings'
severity:
@ -25766,7 +25754,7 @@ components:
description:
$ref: '#/components/schemas/Cases_case_description'
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
settings:
$ref: '#/components/schemas/Cases_settings'
severity:
@ -25820,7 +25808,7 @@ components:
example: elastic
nullable: true
type: string
Cases_owners:
Cases_owner:
description: >
The application that owns the cases: Stack Management, Observability, or
Elastic Security.
@ -25830,6 +25818,10 @@ components:
- securitySolution
example: cases
type: string
Cases_owners:
items:
$ref: '#/components/schemas/Cases_owner'
type: array
Cases_payload_alert_comment:
type: object
properties:
@ -25851,7 +25843,7 @@ components:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
rule:
type: object
properties:
@ -26081,7 +26073,7 @@ components:
description:
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
settings:
$ref: '#/components/schemas/Cases_settings'
severity:
@ -26150,7 +26142,7 @@ components:
comment:
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
type:
enum:
- user
@ -26180,6 +26172,10 @@ components:
- description
- title
type: string
Cases_searchFieldsTypeArray:
items:
$ref: '#/components/schemas/Cases_searchFieldsType'
type: array
Cases_set_case_configuration_request:
description: >-
External connection details, such as the closure type and default
@ -26266,7 +26262,7 @@ components:
minItems: 0
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
required:
@ -26285,6 +26281,13 @@ components:
type: boolean
required:
- syncAlerts
Cases_string:
type: string
Cases_string_array:
items:
$ref: '#/components/schemas/Cases_string'
maxItems: 100
type: array
Cases_template_tags:
description: >
The words and phrases that help categorize templates. It can be an empty
@ -26397,7 +26400,7 @@ components:
index:
$ref: '#/components/schemas/Cases_alert_indices'
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
rule:
$ref: '#/components/schemas/Cases_rule'
type:
@ -26641,7 +26644,7 @@ components:
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
type:
description: The type of comment.
enum:
@ -26701,7 +26704,7 @@ components:
example: 22fd3e30-03b1-11ed-920c-974bfa104448
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
payload:
oneOf:
- $ref: '#/components/schemas/Cases_payload_alert_comment'
@ -26788,7 +26791,7 @@ components:
- full_name
- username
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
payload:
oneOf:
- $ref: '#/components/schemas/Cases_payload_alert_comment'
@ -26833,7 +26836,7 @@ components:
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
pushed_at:
example: null
format: date-time

View file

@ -6941,7 +6941,7 @@ paths:
- $ref: '#/components/parameters/Cases_category'
- $ref: '#/components/parameters/Cases_defaultSearchOperator'
- $ref: '#/components/parameters/Cases_from'
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
- $ref: '#/components/parameters/Cases_page_index'
- $ref: '#/components/parameters/Cases_page_size'
- $ref: '#/components/parameters/Cases_reporters'
@ -7389,7 +7389,7 @@ paths:
operationId: getCasesByAlertDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_alert_id'
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -7430,7 +7430,7 @@ paths:
where the cases were created.
operationId: getCaseConfigurationDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -7561,7 +7561,7 @@ paths:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
updated_at:
@ -7609,7 +7609,7 @@ paths:
post:
description: >
Case settings include external connection details, custom fields, and
templates. Connectors are used to interface with external systems. You
templates. Connectors are used to interface with external systems. You
must create a connector before you can use it in your cases. If you set
a default connector, it is automatically selected when you create cases
in Kibana. If you use the create case API, however, you must still
@ -7757,7 +7757,7 @@ paths:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
updated_at:
@ -7953,7 +7953,7 @@ paths:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
updated_at:
@ -8062,7 +8062,7 @@ paths:
returned by this API is unchanged.
operationId: getCaseReportersDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -8117,7 +8117,7 @@ paths:
privileges, depending on the owner of the cases you're seeking.
operationId: getCaseStatusDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -8150,7 +8150,7 @@ paths:
privileges, depending on the owner of the cases you're seeking.
operationId: getCaseTagsDefaultSpace
parameters:
- $ref: '#/components/parameters/Cases_owner'
- $ref: '#/components/parameters/Cases_owner_filter'
responses:
'200':
content:
@ -24210,11 +24210,8 @@ components:
name: assignees
schema:
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_case_id:
description: >-
The identifier for the case. To retrieve case IDs, use the find cases
@ -24231,12 +24228,8 @@ components:
name: category
schema:
oneOf:
- example: my-category
type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_case_category'
- $ref: '#/components/schemas/Cases_case_categories'
Cases_comment_id:
description: >
The identifier for the comment. To retrieve comment IDs, use the get
@ -24313,7 +24306,7 @@ components:
required: true
schema:
type: string
Cases_owner:
Cases_owner_filter:
description: >
A filter to limit the response to a specific set of applications. If
this parameter is omitted, the response contains information about all
@ -24323,10 +24316,8 @@ components:
name: owner
schema:
oneOf:
- $ref: '#/components/schemas/Cases_owner'
- $ref: '#/components/schemas/Cases_owners'
- items:
$ref: '#/components/schemas/Cases_owners'
type: array
Cases_page_index:
description: The page number to return.
in: query
@ -24351,11 +24342,8 @@ components:
name: reporters
schema:
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_search:
description: >-
An Elasticsearch simple_query_string query that filters the objects in
@ -24371,9 +24359,7 @@ components:
schema:
oneOf:
- $ref: '#/components/schemas/Cases_searchFieldsType'
- items:
$ref: '#/components/schemas/Cases_searchFieldsType'
type: array
- $ref: '#/components/schemas/Cases_searchFieldsTypeArray'
Cases_severity:
description: The severity of the case.
in: query
@ -24430,11 +24416,8 @@ components:
name: tags
schema:
oneOf:
- type: string
- items:
type: string
maxItems: 100
type: array
- $ref: '#/components/schemas/Cases_string'
- $ref: '#/components/schemas/Cases_string_array'
Cases_to:
description: >
Returns only cases that were created before a specific date. The date
@ -24835,7 +24818,7 @@ components:
index:
$ref: '#/components/schemas/Cases_alert_indices'
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
rule:
$ref: '#/components/schemas/Cases_rule'
type:
@ -24873,7 +24856,7 @@ components:
maxLength: 30000
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
type:
description: The type of comment.
enum:
@ -24930,7 +24913,7 @@ components:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
pushed_at:
example: null
format: date-time
@ -25073,6 +25056,11 @@ components:
maxItems: 10
nullable: true
type: array
Cases_case_categories:
items:
$ref: '#/components/schemas/Cases_case_category'
maxItems: 100
type: array
Cases_case_category:
description: A word or phrase that categorizes the case.
maxLength: 50
@ -25234,7 +25222,7 @@ components:
example: 66b9aa00-94fa-11ea-9f74-e7e108796192
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
settings:
$ref: '#/components/schemas/Cases_settings'
severity:
@ -25766,7 +25754,7 @@ components:
description:
$ref: '#/components/schemas/Cases_case_description'
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
settings:
$ref: '#/components/schemas/Cases_settings'
severity:
@ -25820,7 +25808,7 @@ components:
example: elastic
nullable: true
type: string
Cases_owners:
Cases_owner:
description: >
The application that owns the cases: Stack Management, Observability, or
Elastic Security.
@ -25830,6 +25818,10 @@ components:
- securitySolution
example: cases
type: string
Cases_owners:
items:
$ref: '#/components/schemas/Cases_owner'
type: array
Cases_payload_alert_comment:
type: object
properties:
@ -25851,7 +25843,7 @@ components:
type: string
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
rule:
type: object
properties:
@ -26081,7 +26073,7 @@ components:
description:
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
settings:
$ref: '#/components/schemas/Cases_settings'
severity:
@ -26150,7 +26142,7 @@ components:
comment:
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
type:
enum:
- user
@ -26180,6 +26172,10 @@ components:
- description
- title
type: string
Cases_searchFieldsTypeArray:
items:
$ref: '#/components/schemas/Cases_searchFieldsType'
type: array
Cases_set_case_configuration_request:
description: >-
External connection details, such as the closure type and default
@ -26266,7 +26262,7 @@ components:
minItems: 0
type: array
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
templates:
$ref: '#/components/schemas/Cases_templates'
required:
@ -26285,6 +26281,13 @@ components:
type: boolean
required:
- syncAlerts
Cases_string:
type: string
Cases_string_array:
items:
$ref: '#/components/schemas/Cases_string'
maxItems: 100
type: array
Cases_template_tags:
description: >
The words and phrases that help categorize templates. It can be an empty
@ -26397,7 +26400,7 @@ components:
index:
$ref: '#/components/schemas/Cases_alert_indices'
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
rule:
$ref: '#/components/schemas/Cases_rule'
type:
@ -26641,7 +26644,7 @@ components:
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
type:
description: The type of comment.
enum:
@ -26701,7 +26704,7 @@ components:
example: 22fd3e30-03b1-11ed-920c-974bfa104448
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
payload:
oneOf:
- $ref: '#/components/schemas/Cases_payload_alert_comment'
@ -26788,7 +26791,7 @@ components:
- full_name
- username
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
payload:
oneOf:
- $ref: '#/components/schemas/Cases_payload_alert_comment'
@ -26833,7 +26836,7 @@ components:
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
type: string
owner:
$ref: '#/components/schemas/Cases_owners'
$ref: '#/components/schemas/Cases_owner'
pushed_at:
example: null
format: date-time

View file

@ -191,7 +191,7 @@
"$ref": "#/components/parameters/from"
},
{
"$ref": "#/components/parameters/owner"
"$ref": "#/components/parameters/owner_filter"
},
{
"$ref": "#/components/parameters/page_index"
@ -297,7 +297,7 @@
"$ref": "#/components/parameters/alert_id"
},
{
"$ref": "#/components/parameters/owner"
"$ref": "#/components/parameters/owner_filter"
}
],
"responses": {
@ -354,7 +354,7 @@
],
"parameters": [
{
"$ref": "#/components/parameters/owner"
"$ref": "#/components/parameters/owner_filter"
}
],
"responses": {
@ -501,7 +501,7 @@
}
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"templates": {
"$ref": "#/components/schemas/templates"
@ -572,7 +572,7 @@
"post": {
"summary": "Add case settings",
"operationId": "setCaseConfigurationDefaultSpace",
"description": "Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.\n",
"description": "Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.\n",
"tags": [
"cases"
],
@ -737,7 +737,7 @@
}
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"templates": {
"$ref": "#/components/schemas/templates"
@ -977,7 +977,7 @@
}
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"templates": {
"$ref": "#/components/schemas/templates"
@ -1055,7 +1055,7 @@
],
"parameters": [
{
"$ref": "#/components/parameters/owner"
"$ref": "#/components/parameters/owner_filter"
}
],
"responses": {
@ -1128,7 +1128,7 @@
],
"parameters": [
{
"$ref": "#/components/parameters/owner"
"$ref": "#/components/parameters/owner_filter"
}
],
"responses": {
@ -1176,7 +1176,7 @@
],
"parameters": [
{
"$ref": "#/components/parameters/owner"
"$ref": "#/components/parameters/owner_filter"
}
],
"responses": {
@ -1904,14 +1904,10 @@
"schema": {
"oneOf": [
{
"type": "string"
"$ref": "#/components/schemas/string"
},
{
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100
"$ref": "#/components/schemas/string_array"
}
]
}
@ -1923,15 +1919,10 @@
"schema": {
"oneOf": [
{
"type": "string",
"example": "my-category"
"$ref": "#/components/schemas/case_category"
},
{
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100
"$ref": "#/components/schemas/case_categories"
}
]
}
@ -1955,20 +1946,17 @@
"example": "now-1d"
}
},
"owner": {
"owner_filter": {
"in": "query",
"name": "owner",
"description": "A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.\n",
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/owners"
}
"$ref": "#/components/schemas/owners"
}
]
},
@ -2002,14 +1990,10 @@
"schema": {
"oneOf": [
{
"type": "string"
"$ref": "#/components/schemas/string"
},
{
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100
"$ref": "#/components/schemas/string_array"
}
]
},
@ -2033,10 +2017,7 @@
"$ref": "#/components/schemas/searchFieldsType"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/searchFieldsType"
}
"$ref": "#/components/schemas/searchFieldsTypeArray"
}
]
}
@ -2109,14 +2090,10 @@
"schema": {
"oneOf": [
{
"type": "string"
"$ref": "#/components/schemas/string"
},
{
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100
"$ref": "#/components/schemas/string_array"
}
]
},
@ -2612,7 +2589,7 @@
"type": "string",
"maxLength": 30000
},
"owners": {
"owner": {
"type": "string",
"description": "The application that owns the cases: Stack Management, Observability, or Elastic Security.\n",
"enum": [
@ -2711,7 +2688,7 @@
"$ref": "#/components/schemas/case_description"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"settings": {
"$ref": "#/components/schemas/settings"
@ -2863,7 +2840,7 @@
}
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"pushed_at": {
"type": "string",
@ -2988,7 +2965,7 @@
"example": "8af6ac20-74f6-11ea-b83a-553aecdb28b6"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"pushed_at": {
"type": "string",
@ -3337,7 +3314,7 @@
"example": "66b9aa00-94fa-11ea-9f74-e7e108796192"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"settings": {
"$ref": "#/components/schemas/settings"
@ -3525,6 +3502,29 @@
}
}
},
"string": {
"type": "string"
},
"string_array": {
"type": "array",
"items": {
"$ref": "#/components/schemas/string"
},
"maxItems": 100
},
"case_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/case_category"
},
"maxItems": 100
},
"owners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/owner"
}
},
"searchFieldsType": {
"type": "string",
"description": "The fields to perform the `simple_query_string` parsed query against.",
@ -3533,6 +3533,12 @@
"title"
]
},
"searchFieldsTypeArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/searchFieldsType"
}
},
"closure_types": {
"type": "string",
"description": "Indicates whether a case is automatically closed when it is pushed to external systems (`close-by-pushing`) or not automatically closed (`close-by-user`).",
@ -3767,7 +3773,7 @@
}
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"templates": {
"$ref": "#/components/schemas/templates"
@ -3911,7 +3917,7 @@
"$ref": "#/components/schemas/alert_indices"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"rule": {
"$ref": "#/components/schemas/rule"
@ -3938,7 +3944,7 @@
"example": "A new comment."
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"type": {
"type": "string",
@ -4053,7 +4059,7 @@
"$ref": "#/components/schemas/alert_indices"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"rule": {
"$ref": "#/components/schemas/rule"
@ -4090,7 +4096,7 @@
"example": "8af6ac20-74f6-11ea-b83a-553aecdb28b6"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"type": {
"type": "string",
@ -4179,7 +4185,7 @@
]
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"rule": {
"type": "object",
@ -4415,7 +4421,7 @@
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"settings": {
"$ref": "#/components/schemas/settings"
@ -4517,7 +4523,7 @@
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"type": {
"type": "string",
@ -4613,7 +4619,7 @@
]
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"payload": {
"oneOf": [
@ -4724,7 +4730,7 @@
"example": "22fd3e30-03b1-11ed-920c-974bfa104448"
},
"owner": {
"$ref": "#/components/schemas/owners"
"$ref": "#/components/schemas/owner"
},
"payload": {
"oneOf": [

View file

@ -116,7 +116,7 @@ paths:
- $ref: '#/components/parameters/category'
- $ref: '#/components/parameters/defaultSearchOperator'
- $ref: '#/components/parameters/from'
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/owner_filter'
- $ref: '#/components/parameters/page_index'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/reporters'
@ -173,7 +173,7 @@ paths:
- cases
parameters:
- $ref: '#/components/parameters/alert_id'
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/owner_filter'
responses:
'200':
description: Indicates a successful call.
@ -209,7 +209,7 @@ paths:
tags:
- cases
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/owner_filter'
responses:
'200':
description: Indicates a successful call.
@ -320,7 +320,7 @@ paths:
type: string
example: summary
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
templates:
$ref: '#/components/schemas/templates'
updated_at:
@ -367,7 +367,7 @@ paths:
summary: Add case settings
operationId: setCaseConfigurationDefaultSpace
description: |
Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.
Case settings include external connection details, custom fields, and templates. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details. You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on where you are creating cases.
tags:
- cases
parameters:
@ -488,7 +488,7 @@ paths:
type: string
example: summary
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
templates:
$ref: '#/components/schemas/templates'
updated_at:
@ -658,7 +658,7 @@ paths:
type: string
example: summary
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
templates:
$ref: '#/components/schemas/templates'
updated_at:
@ -710,7 +710,7 @@ paths:
tags:
- cases
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/owner_filter'
responses:
'200':
description: Indicates a successful call.
@ -760,7 +760,7 @@ paths:
tags:
- cases
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/owner_filter'
responses:
'200':
description: Indicates a successful call.
@ -790,7 +790,7 @@ paths:
tags:
- cases
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/owner_filter'
responses:
'200':
description: Indicates a successful call.
@ -1237,23 +1237,16 @@ components:
Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API.
schema:
oneOf:
- type: string
- type: array
items:
type: string
maxItems: 100
- $ref: '#/components/schemas/string'
- $ref: '#/components/schemas/string_array'
category:
in: query
name: category
description: Filters the returned cases by category.
schema:
oneOf:
- type: string
example: my-category
- type: array
items:
type: string
maxItems: 100
- $ref: '#/components/schemas/case_category'
- $ref: '#/components/schemas/case_categories'
defaultSearchOperator:
in: query
name: defaultSearchOperator
@ -1270,17 +1263,15 @@ components:
schema:
type: string
example: now-1d
owner:
owner_filter:
in: query
name: owner
description: |
A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.
schema:
oneOf:
- $ref: '#/components/schemas/owner'
- $ref: '#/components/schemas/owners'
- type: array
items:
$ref: '#/components/schemas/owners'
example: cases
page_index:
in: query
@ -1305,11 +1296,8 @@ components:
description: Filters the returned cases by the user name of the reporter.
schema:
oneOf:
- type: string
- type: array
items:
type: string
maxItems: 100
- $ref: '#/components/schemas/string'
- $ref: '#/components/schemas/string_array'
example: elastic
search:
in: query
@ -1324,9 +1312,7 @@ components:
schema:
oneOf:
- $ref: '#/components/schemas/searchFieldsType'
- type: array
items:
$ref: '#/components/schemas/searchFieldsType'
- $ref: '#/components/schemas/searchFieldsTypeArray'
severity:
in: query
name: severity
@ -1382,11 +1368,8 @@ components:
description: Filters the returned cases by tags.
schema:
oneOf:
- type: string
- type: array
items:
type: string
maxItems: 100
- $ref: '#/components/schemas/string'
- $ref: '#/components/schemas/string_array'
example: tag-1
to:
in: query
@ -1770,7 +1753,7 @@ components:
description: The description for the case.
type: string
maxLength: 30000
owners:
owner:
type: string
description: |
The application that owns the cases: Stack Management, Observability, or Elastic Security.
@ -1840,7 +1823,7 @@ components:
description:
$ref: '#/components/schemas/case_description'
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
settings:
$ref: '#/components/schemas/settings'
severity:
@ -1954,7 +1937,7 @@ components:
type: string
example: .internal.alerts-security.alerts-default-000001
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
pushed_at:
type: string
format: date-time
@ -2048,7 +2031,7 @@ components:
type: string
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
pushed_at:
type: string
format: date-time
@ -2304,7 +2287,7 @@ components:
type: string
example: 66b9aa00-94fa-11ea-9f74-e7e108796192
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
settings:
$ref: '#/components/schemas/settings'
severity:
@ -2430,12 +2413,32 @@ components:
version:
description: The current version of the case. To determine this value, use the get case or find cases APIs.
type: string
string:
type: string
string_array:
type: array
items:
$ref: '#/components/schemas/string'
maxItems: 100
case_categories:
type: array
items:
$ref: '#/components/schemas/case_category'
maxItems: 100
owners:
type: array
items:
$ref: '#/components/schemas/owner'
searchFieldsType:
type: string
description: The fields to perform the `simple_query_string` parsed query against.
enum:
- description
- title
searchFieldsTypeArray:
type: array
items:
$ref: '#/components/schemas/searchFieldsType'
closure_types:
type: string
description: Indicates whether a case is automatically closed when it is pushed to external systems (`close-by-pushing`) or not automatically closed (`close-by-user`).
@ -2612,7 +2615,7 @@ components:
- text
- toggle
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
templates:
$ref: '#/components/schemas/templates'
update_case_configuration_request:
@ -2721,7 +2724,7 @@ components:
index:
$ref: '#/components/schemas/alert_indices'
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
rule:
$ref: '#/components/schemas/rule'
type:
@ -2741,7 +2744,7 @@ components:
maxLength: 30000
example: A new comment.
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
type:
type: string
description: The type of comment.
@ -2824,7 +2827,7 @@ components:
index:
$ref: '#/components/schemas/alert_indices'
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
rule:
$ref: '#/components/schemas/rule'
type:
@ -2854,7 +2857,7 @@ components:
The identifier for the comment. To retrieve comment IDs, use the get comments API.
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
type:
type: string
description: The type of comment.
@ -2913,7 +2916,7 @@ components:
items:
type: string
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
rule:
type: object
properties:
@ -3085,7 +3088,7 @@ components:
description:
type: string
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
settings:
$ref: '#/components/schemas/settings'
severity:
@ -3152,7 +3155,7 @@ components:
comment:
type: string
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
type:
type: string
enum:
@ -3226,7 +3229,7 @@ components:
- full_name
- username
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
payload:
oneOf:
- $ref: '#/components/schemas/payload_alert_comment'
@ -3293,7 +3296,7 @@ components:
type: string
example: 22fd3e30-03b1-11ed-920c-974bfa104448
owner:
$ref: '#/components/schemas/owners'
$ref: '#/components/schemas/owner'
payload:
oneOf:
- $ref: '#/components/schemas/payload_alert_comment'

View file

@ -6,8 +6,5 @@ description: >
These identifiers can be found by using the suggest user profile API.
schema:
oneOf:
- type: string
- type: array
items:
type: string
maxItems: 100
- $ref: '../schemas/string.yaml'
- $ref: '../schemas/string_array.yaml'

View file

@ -3,9 +3,5 @@ name: category
description: Filters the returned cases by category.
schema:
oneOf:
- type: string
example: my-category
- type: array
items:
type: string
maxItems: 100
- $ref: '../schemas/case_category.yaml'
- $ref: '../schemas/case_categories.yaml'

View file

@ -6,8 +6,6 @@ description: >
that the user has access to read.
schema:
oneOf:
- $ref: '../schemas/owner.yaml'
- $ref: '../schemas/owners.yaml'
- type: array
items:
$ref: '../schemas/owners.yaml'
example: cases
example: cases

View file

@ -3,9 +3,6 @@ name: reporters
description: Filters the returned cases by the user name of the reporter.
schema:
oneOf:
- type: string
- type: array
items:
type: string
maxItems: 100
- $ref: '../schemas/string.yaml'
- $ref: '../schemas/string_array.yaml'
example: elastic

View file

@ -4,6 +4,4 @@ description: The fields to perform the simple_query_string parsed query against.
schema:
oneOf:
- $ref: 'searchFieldsType.yaml'
- type: array
items:
$ref: 'searchFieldsType.yaml'
- $ref: 'searchFieldsTypeArray.yaml'

View file

@ -0,0 +1,3 @@
type: array
items:
$ref: 'searchFieldsType.yaml'

View file

@ -3,9 +3,6 @@ name: tags
description: Filters the returned cases by tags.
schema:
oneOf:
- type: string
- type: array
items:
type: string
maxItems: 100
- $ref: '../schemas/string.yaml'
- $ref: '../schemas/string_array.yaml'
example: tag-1

View file

@ -13,12 +13,12 @@ properties:
index:
$ref: 'alert_indices.yaml'
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
rule:
$ref: 'rule.yaml'
type:
type:
description: The type of comment.
type: string
example: alert
enum:
- alert
- alert

View file

@ -8,8 +8,8 @@ properties:
maxLength: 30000
example: A new comment.
owner:
$ref: 'owners.yaml'
type:
$ref: 'owner.yaml'
type:
type: string
description: The type of comment.
example: user
@ -18,4 +18,4 @@ properties:
required:
- comment
- owner
- type
- type

View file

@ -29,7 +29,7 @@ properties:
type: string
example: .internal.alerts-security.alerts-default-000001
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
pushed_at:
type: string
format: date-time
@ -68,4 +68,4 @@ properties:
$ref: 'user_properties.yaml'
version:
type: string
example: WzMwNDgsMV0=
example: WzMwNDgsMV0=

View file

@ -0,0 +1,4 @@
type: array
items:
$ref: './case_category.yaml'
maxItems: 100

View file

@ -45,7 +45,7 @@ mappings:
type: string
example: summary
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
templates:
$ref: 'templates.yaml'
updated_at:

View file

@ -100,7 +100,7 @@ properties:
type: string
example: 66b9aa00-94fa-11ea-9f74-e7e108796192
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
settings:
$ref: 'settings.yaml'
severity:

View file

@ -24,7 +24,7 @@ properties:
description:
$ref: 'case_description.yaml'
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
settings:
$ref: 'settings.yaml'
severity:

View file

@ -0,0 +1,9 @@
type: string
description: >
The application that owns the cases: Stack Management, Observability, or
Elastic Security.
enum:
- cases
- observability
- securitySolution
example: cases

View file

@ -1,9 +1,3 @@
type: string
description: >
The application that owns the cases: Stack Management, Observability, or
Elastic Security.
enum:
- cases
- observability
- securitySolution
example: cases
type: array
items:
$ref: './owner.yaml'

View file

@ -18,7 +18,7 @@ properties:
items:
type: string
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
rule:
type: object
properties:
@ -26,4 +26,4 @@ properties:
type:
type: string
enum:
- alert
- alert

View file

@ -2,24 +2,24 @@ type: object
properties:
assignees:
$ref: 'assignees.yaml'
connector:
connector:
type: object
properties:
$ref: 'connector_properties.yaml'
description:
type: string
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
settings:
$ref: 'settings.yaml'
severity:
$ref: 'case_severity.yaml'
status:
status:
$ref: 'case_status.yaml'
tags:
tags:
type: array
items:
type: string
example: ["tag-1"]
title:
type: string
type: string

View file

@ -6,8 +6,8 @@ properties:
comment:
type: string
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
type:
type: string
enum:
- user
- user

View file

@ -33,6 +33,6 @@ properties:
properties:
$ref: 'case_configure_customfields.yaml'
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
templates:
$ref: 'templates.yaml'

View file

@ -0,0 +1 @@
type: string

View file

@ -0,0 +1,4 @@
type: array
items:
$ref: './string.yaml'
maxItems: 100

View file

@ -21,10 +21,10 @@ properties:
index:
$ref: 'alert_indices.yaml'
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
rule:
$ref: 'rule.yaml'
type:
type:
description: The type of comment.
type: string
enum:
@ -35,4 +35,4 @@ properties:
The current comment version. To retrieve version values, use the get
comments API.
type: string
example: Wzk1LDFd
example: Wzk1LDFd

View file

@ -14,8 +14,8 @@ properties:
get comments API.
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
owner:
$ref: 'owners.yaml'
type:
$ref: 'owner.yaml'
type:
type: string
description: The type of comment.
enum:
@ -32,4 +32,4 @@ required:
- id
- owner
- type
- version
- version

View file

@ -32,7 +32,7 @@ properties:
type: string
example: 22fd3e30-03b1-11ed-920c-974bfa104448
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
payload:
oneOf:
- $ref: 'payload_alert_comment.yaml'

View file

@ -35,7 +35,7 @@ properties:
- full_name
- username
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
payload:
oneOf:
- $ref: 'payload_alert_comment.yaml'

View file

@ -16,7 +16,7 @@ properties:
type: string
example: 8af6ac20-74f6-11ea-b83a-553aecdb28b6
owner:
$ref: 'owners.yaml'
$ref: 'owner.yaml'
pushed_at:
type: string
format: date-time
@ -24,7 +24,7 @@ properties:
example: null
pushed_by:
$ref: 'case_response_pushed_by_properties.yaml'
type:
type:
type: string
example: user
enum:
@ -38,4 +38,4 @@ properties:
$ref: 'case_response_updated_by_properties.yaml'
version:
type: string
example: WzIwNDMxLDFd
example: WzIwNDMxLDFd

View file

@ -12,7 +12,7 @@ get:
- $ref: '../components/parameters/category.yaml'
- $ref: '../components/parameters/defaultSearchOperator.yaml'
- $ref: '../components/parameters/from.yaml'
- $ref: '../components/parameters/owner.yaml'
- $ref: '../components/parameters/owner_filter.yaml'
- $ref: '../components/parameters/page_index.yaml'
- $ref: '../components/parameters/page_size.yaml'
- $ref: '../components/parameters/reporters.yaml'

View file

@ -10,7 +10,7 @@ get:
- cases
parameters:
- $ref: ../components/parameters/alert_id.yaml
- $ref: '../components/parameters/owner.yaml'
- $ref: '../components/parameters/owner_filter.yaml'
responses:
'200':
description: Indicates a successful call.
@ -19,7 +19,7 @@ get:
schema:
type: array
maxItems: 10000
items:
items:
type: object
properties:
id:
@ -36,4 +36,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
$ref: '../components/schemas/4xx_response.yaml'

View file

@ -9,7 +9,7 @@ get:
tags:
- cases
parameters:
- $ref: '../components/parameters/owner.yaml'
- $ref: '../components/parameters/owner_filter.yaml'
responses:
'200':
description: Indicates a successful call.
@ -17,7 +17,7 @@ get:
application/json:
schema:
type: array
items:
items:
type: object
properties:
$ref: '../components/schemas/case_configure_response_properties.yaml'
@ -35,7 +35,7 @@ post:
summary: Add case settings
operationId: setCaseConfigurationDefaultSpace
description: >
Case settings include external connection details, custom fields, and templates.
Case settings include external connection details, custom fields, and templates.
Connectors are used to interface with external systems.
You must create a connector before you can use it in your cases.
If you set a default connector, it is automatically selected when you create cases in Kibana.
@ -70,4 +70,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
$ref: '../components/schemas/4xx_response.yaml'

View file

@ -9,7 +9,7 @@ get:
tags:
- cases
parameters:
- $ref: '../components/parameters/owner.yaml'
- $ref: '../components/parameters/owner_filter.yaml'
responses:
'200':
description: Indicates a successful call.
@ -34,4 +34,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
$ref: '../components/schemas/4xx_response.yaml'

View file

@ -9,7 +9,7 @@ get:
tags:
- cases
parameters:
- $ref: '../components/parameters/owner.yaml'
- $ref: '../components/parameters/owner_filter.yaml'
responses:
'200':
description: Indicates a successful call.

View file

@ -7,7 +7,7 @@ get:
tags:
- cases
parameters:
- $ref: '../components/parameters/owner.yaml'
- $ref: '../components/parameters/owner_filter.yaml'
responses:
'200':
description: Indicates a successful call.
@ -26,4 +26,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/4xx_response.yaml'
$ref: '../components/schemas/4xx_response.yaml'