diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index ba8e3f31c0ed6..2727aa2cca229 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -18278,7 +18278,6 @@ paths: '200': content: application/json: - description: Elasticsearch update by query or update by IDs response examples: add: value: @@ -18297,7 +18296,13 @@ paths: total: 1 updated: 1 version_conflicts: 0 - description: Indicates a successful call. + schema: + additionalProperties: true + description: Elasticsearch update by query response + type: object + description: | + Indicates a successful call. The body matches an Elasticsearch update-by-query response + (for example `took`, `updated`, `failures`). '400': content: application/json: @@ -25369,16 +25374,18 @@ paths: requestBody: content: application/json: + examples: + createSharedExceptionList: + value: + description: This is a sample detection type exception list. + list_id: simple_list + name: Sample Detection Exception List + namespace_type: single + os_types: + - linux + tags: + - malware schema: - example: - description: This is a sample detection type exception list. - list_id: simple_list - name: Sample Detection Exception List - namespace_type: single - os_types: - - linux - tags: - - malware type: object properties: description: diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 09ab5b232cf03..4a06721a66363 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -20827,7 +20827,6 @@ paths: '200': content: application/json: - description: Elasticsearch update by query or update by IDs response examples: add: value: @@ -20846,7 +20845,13 @@ paths: total: 1 updated: 1 version_conflicts: 0 - description: Indicates a successful call. + schema: + additionalProperties: true + description: Elasticsearch update by query response + type: object + description: | + Indicates a successful call. The body matches an Elasticsearch update-by-query response + (for example `took`, `updated`, `failures`). '400': content: application/json: @@ -28412,16 +28417,18 @@ paths: requestBody: content: application/json: + examples: + createSharedExceptionList: + value: + description: This is a sample detection type exception list. + list_id: simple_list + name: Sample Detection Exception List + namespace_type: single + os_types: + - linux + tags: + - malware schema: - example: - description: This is a sample detection type exception list. - list_id: simple_list - name: Sample Detection Exception List - namespace_type: single - os_types: - - linux - tags: - - malware type: object properties: description: diff --git a/src/platform/packages/private/kbn-validate-oas/src/oas_error_baseline.json b/src/platform/packages/private/kbn-validate-oas/src/oas_error_baseline.json index e29a388b64796..4b03ac5cc4c4f 100644 --- a/src/platform/packages/private/kbn-validate-oas/src/oas_error_baseline.json +++ b/src/platform/packages/private/kbn-validate-oas/src/oas_error_baseline.json @@ -1,4 +1,4 @@ { - "./oas_docs/output/kibana.yaml": 202, - "./oas_docs/output/kibana.serverless.yaml": 185 + "./oas_docs/output/kibana.yaml": 200, + "./oas_docs/output/kibana.serverless.yaml": 183 } \ No newline at end of file diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/create_shared_exceptions_list/create_shared_exceptions_list.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/create_shared_exceptions_list/create_shared_exceptions_list.schema.yaml index 221064a285037..827393a14ffa2 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/create_shared_exceptions_list/create_shared_exceptions_list.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/create_shared_exceptions_list/create_shared_exceptions_list.schema.yaml @@ -27,13 +27,15 @@ paths: required: - name - description - example: - list_id: simple_list - name: Sample Detection Exception List - description: This is a sample detection type exception list. - namespace_type: single - tags: [malware] - os_types: [linux] + examples: + createSharedExceptionList: + value: + list_id: simple_list + name: Sample Detection Exception List + description: This is a sample detection type exception list. + namespace_type: single + tags: [malware] + os_types: [linux] responses: 200: description: Successful response diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml index 469674d758aa1..efae9ff457ab2 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml @@ -2688,16 +2688,18 @@ paths: requestBody: content: application/json: + examples: + createSharedExceptionList: + value: + description: This is a sample detection type exception list. + list_id: simple_list + name: Sample Detection Exception List + namespace_type: single + os_types: + - linux + tags: + - malware schema: - example: - description: This is a sample detection type exception list. - list_id: simple_list - name: Sample Detection Exception List - namespace_type: single - os_types: - - linux - tags: - - malware type: object properties: description: diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/serverless/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/serverless/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml index d940d53121223..1a2825d112d62 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/serverless/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/serverless/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml @@ -2688,16 +2688,18 @@ paths: requestBody: content: application/json: + examples: + createSharedExceptionList: + value: + description: This is a sample detection type exception list. + list_id: simple_list + name: Sample Detection Exception List + namespace_type: single + os_types: + - linux + tags: + - malware schema: - example: - description: This is a sample detection type exception list. - list_id: simple_list - name: Sample Detection Exception List - namespace_type: single - os_types: - - linux - tags: - - malware type: object properties: description: diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.gen.ts b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.gen.ts index 0cec0df318866..7a4ae96db03b1 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.gen.ts +++ b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.gen.ts @@ -14,11 +14,16 @@ * version: 2023-10-31 */ -import type { z } from '@kbn/zod/v4'; -import { lazySchema } from '@kbn/zod/v4'; +import { z, lazySchema } from '@kbn/zod/v4'; import { SetAlertAssigneesBody } from '../model/set_alert_assignees_body.gen'; export const SetAlertAssigneesRequestBody = lazySchema(() => SetAlertAssigneesBody); export type SetAlertAssigneesRequestBody = z.infer; export type SetAlertAssigneesRequestBodyInput = z.input; + +/** + * Elasticsearch update by query response + */ +export const SetAlertAssigneesResponse = lazySchema(() => z.object({}).catchall(z.unknown())); +export type SetAlertAssigneesResponse = z.infer; diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.schema.yaml b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.schema.yaml index 2b2eeb63c8db3..f74cdf07e38e0 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/alert_assignees/set_alert_assignees_route.schema.yaml @@ -29,10 +29,15 @@ paths: $ref: '../model/set_alert_assignees_body.schema.yaml#/components/examples/SetAlertAssigneesBodyRemove' responses: 200: - description: Indicates a successful call. + description: | + Indicates a successful call. The body matches an Elasticsearch update-by-query response + (for example `took`, `updated`, `failures`). content: application/json: - description: Elasticsearch update by query or update by IDs response + schema: + type: object + additionalProperties: true + description: Elasticsearch update by query response examples: add: value: diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/quickstart_client.gen.ts b/x-pack/solutions/security/plugins/security_solution/common/api/quickstart_client.gen.ts index c2cf73f05e320..226a2e15a4422 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/quickstart_client.gen.ts +++ b/x-pack/solutions/security/plugins/security_solution/common/api/quickstart_client.gen.ts @@ -20,7 +20,10 @@ import { ELASTIC_HTTP_VERSION_HEADER } from '@kbn/core-http-common'; import { replaceParams } from '@kbn/openapi-common/shared'; import { catchAxiosErrorFormatAndThrow } from '@kbn/securitysolution-utils'; -import type { SetAlertAssigneesRequestBodyInput } from './detection_engine/alert_assignees/set_alert_assignees_route.gen'; +import type { + SetAlertAssigneesRequestBodyInput, + SetAlertAssigneesResponse, +} from './detection_engine/alert_assignees/set_alert_assignees_route.gen'; import type { SetAlertTagsRequestBodyInput, SetAlertTagsResponse, @@ -3234,7 +3237,7 @@ matching documents, and inspect execution logs. Pair `invocationCount` and `time async setAlertAssignees(props: SetAlertAssigneesProps) { this.log.info(`${new Date().toISOString()} Calling API SetAlertAssignees`); return this.kbnClient - .request({ + .request({ path: '/api/detection_engine/signals/assignees', headers: { [ELASTIC_HTTP_VERSION_HEADER]: '2023-10-31', diff --git a/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml index b2630bfbfeb9a..5da26a3c6a50b 100644 --- a/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml @@ -3847,7 +3847,6 @@ paths: '200': content: application/json: - description: Elasticsearch update by query or update by IDs response examples: add: value: @@ -3866,7 +3865,15 @@ paths: total: 1 updated: 1 version_conflicts: 0 - description: Indicates a successful call. + schema: + additionalProperties: true + description: Elasticsearch update by query response + type: object + description: > + Indicates a successful call. The body matches an Elasticsearch + update-by-query response + + (for example `took`, `updated`, `failures`). '400': content: application/json: diff --git a/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml index 744ddd6caba33..76eea67b1976e 100644 --- a/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml @@ -3459,7 +3459,6 @@ paths: '200': content: application/json: - description: Elasticsearch update by query or update by IDs response examples: add: value: @@ -3478,7 +3477,15 @@ paths: total: 1 updated: 1 version_conflicts: 0 - description: Indicates a successful call. + schema: + additionalProperties: true + description: Elasticsearch update by query response + type: object + description: > + Indicates a successful call. The body matches an Elasticsearch + update-by-query response + + (for example `took`, `updated`, `failures`). '400': content: application/json: