diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index 57c7e4b50e470..48c3df88ce75c 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -147,7 +147,7 @@ tags: x-displayName: Security detections - description: Endpoint Exceptions API allows you to manage detection rule endpoint exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met. name: Security Endpoint Exceptions API - x-displayName: Security endpoint exceptions + x-displayName: Security Elastic Endpoint exceptions - description: Interact with and manage endpoints running the Elastic Defend integration. name: Security Endpoint Management API x-displayName: Security endpoint management @@ -10148,7 +10148,7 @@ paths: - Security Detections API /api/endpoint_list: post: - description: Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned. + description: Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a `list_id` of `endpoint_list`. If the Elastic Endpoint exception list already exists, your request will return an empty response. operationId: CreateEndpointList responses: '200': @@ -10183,12 +10183,12 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list + summary: Create an Elastic Endpoint rule exception list tags: - Security Endpoint Exceptions API /api/endpoint_list/items: delete: - description: Delete an endpoint exception list item using the `id` or `item_id` field. + description: Delete an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: DeleteEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -10242,11 +10242,11 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Delete an endpoint exception list item + summary: Delete an Elastic Endpoint exception list item tags: - Security Endpoint Exceptions API get: - description: Get the details of an endpoint exception list item using the `id` or `item_id` field. + description: Get the details of an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: ReadEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -10302,11 +10302,11 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Get an endpoint exception list item + summary: Get an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API post: - description: Create an endpoint exception list item, and associate it with the endpoint exception list. + description: Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. operationId: CreateEndpointListItem requestBody: content: @@ -10381,11 +10381,11 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list item + summary: Create an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API put: - description: Update an endpoint exception list item using the `id` or `item_id` field. + description: Update an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: UpdateEndpointListItem requestBody: content: @@ -10465,12 +10465,12 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Update an endpoint exception list item + summary: Update an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API /api/endpoint_list/items/_find: get: - description: Get a list of all endpoint exception list items. + description: Get a list of all Elastic Endpoint exception list items. operationId: FindEndpointListItems parameters: - description: | @@ -10570,7 +10570,7 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Get endpoint exception list items + summary: Get Elastic Endpoint exception list items tags: - Security Endpoint Exceptions API /api/endpoint/action: @@ -65086,7 +65086,7 @@ components: example: This list tracks allowlisted values. type: string Security_Endpoint_Exceptions_API_ExceptionListHumanId: - description: Exception list's human readable string identifier, e.g. `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 @@ -67671,7 +67671,7 @@ components: example: This list tracks allowlisted values. type: string Security_Exceptions_API_ExceptionListHumanId: - description: Exception list's human readable string identifier, e.g. `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 8a3d068b6dc55..053b82b1fd500 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -174,7 +174,7 @@ tags: x-displayName: Security detections - description: Endpoint Exceptions API allows you to manage detection rule endpoint exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met. name: Security Endpoint Exceptions API - x-displayName: Security endpoint exceptions + x-displayName: Security Elastic Endpoint exceptions - description: Interact with and manage endpoints running the Elastic Defend integration. name: Security Endpoint Management API x-displayName: Security endpoint management @@ -12307,7 +12307,7 @@ paths: - saved objects /api/endpoint_list: post: - description: Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned. + description: Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a `list_id` of `endpoint_list`. If the Elastic Endpoint exception list already exists, your request will return an empty response. operationId: CreateEndpointList responses: '200': @@ -12342,12 +12342,12 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list + summary: Create an Elastic Endpoint rule exception list tags: - Security Endpoint Exceptions API /api/endpoint_list/items: delete: - description: Delete an endpoint exception list item using the `id` or `item_id` field. + description: Delete an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: DeleteEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -12401,11 +12401,11 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Delete an endpoint exception list item + summary: Delete an Elastic Endpoint exception list item tags: - Security Endpoint Exceptions API get: - description: Get the details of an endpoint exception list item using the `id` or `item_id` field. + description: Get the details of an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: ReadEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -12461,11 +12461,11 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Get an endpoint exception list item + summary: Get an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API post: - description: Create an endpoint exception list item, and associate it with the endpoint exception list. + description: Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. operationId: CreateEndpointListItem requestBody: content: @@ -12540,11 +12540,11 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list item + summary: Create an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API put: - description: Update an endpoint exception list item using the `id` or `item_id` field. + description: Update an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: UpdateEndpointListItem requestBody: content: @@ -12624,12 +12624,12 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Update an endpoint exception list item + summary: Update an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API /api/endpoint_list/items/_find: get: - description: Get a list of all endpoint exception list items. + description: Get a list of all Elastic Endpoint exception list items. operationId: FindEndpointListItems parameters: - description: | @@ -12729,7 +12729,7 @@ paths: schema: $ref: '#/components/schemas/Security_Endpoint_Exceptions_API_SiemErrorResponse' description: Internal server error - summary: Get endpoint exception list items + summary: Get Elastic Endpoint exception list items tags: - Security Endpoint Exceptions API /api/endpoint/action: @@ -74649,7 +74649,7 @@ components: example: This list tracks allowlisted values. type: string Security_Endpoint_Exceptions_API_ExceptionListHumanId: - description: Exception list's human readable string identifier, e.g. `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 @@ -77234,7 +77234,7 @@ components: example: This list tracks allowlisted values. type: string Security_Exceptions_API_ExceptionListHumanId: - description: Exception list's human readable string identifier, e.g. `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml index cdc9004ce7e60..5f91b017e4bb1 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml @@ -8,8 +8,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: CreateEndpointList - summary: Create an endpoint exception list - description: Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned. + summary: Create an Elastic Endpoint rule exception list + description: Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a `list_id` of `endpoint_list`. If the Elastic Endpoint exception list already exists, your request will return an empty response. responses: 200: description: Successful response diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list_item/create_endpoint_list_item.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list_item/create_endpoint_list_item.schema.yaml index 6948df21afbbc..6b2b4cee0e2d6 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list_item/create_endpoint_list_item.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/create_endpoint_list_item/create_endpoint_list_item.schema.yaml @@ -8,8 +8,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: CreateEndpointListItem - summary: Create an endpoint exception list item - description: Create an endpoint exception list item, and associate it with the endpoint exception list. + summary: Create an Elastic Endpoint rule exception list item + description: Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. requestBody: description: Exception list item's properties required: true diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml index ae1010573e5ef..976e578cc7bd8 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml @@ -8,8 +8,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: DeleteEndpointListItem - summary: Delete an endpoint exception list item - description: Delete an endpoint exception list item using the `id` or `item_id` field. + summary: Delete an Elastic Endpoint exception list item + description: Delete an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. parameters: - name: id in: query diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/find_endpoint_list_item/find_endpoint_list_item.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/find_endpoint_list_item/find_endpoint_list_item.schema.yaml index 400851ac52543..eb80087940495 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/find_endpoint_list_item/find_endpoint_list_item.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/find_endpoint_list_item/find_endpoint_list_item.schema.yaml @@ -8,8 +8,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: FindEndpointListItems - summary: Get endpoint exception list items - description: Get a list of all endpoint exception list items. + summary: Get Elastic Endpoint exception list items + description: Get a list of all Elastic Endpoint exception list items. parameters: - name: filter in: query diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/read_endpoint_list_item/read_endpoint_list_item.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/read_endpoint_list_item/read_endpoint_list_item.schema.yaml index 0b64bac231df5..31a9ebc7b452c 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/read_endpoint_list_item/read_endpoint_list_item.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/read_endpoint_list_item/read_endpoint_list_item.schema.yaml @@ -8,8 +8,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: ReadEndpointListItem - summary: Get an endpoint exception list item - description: Get the details of an endpoint exception list item using the `id` or `item_id` field. + summary: Get an Elastic Endpoint rule exception list item + description: Get the details of an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. parameters: - name: id in: query diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/update_endpoint_list_item/update_endpoint_list_item.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/update_endpoint_list_item/update_endpoint_list_item.schema.yaml index 1fbe40d2b94ee..e2b108f5e493e 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/update_endpoint_list_item/update_endpoint_list_item.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/api/update_endpoint_list_item/update_endpoint_list_item.schema.yaml @@ -8,8 +8,8 @@ paths: x-labels: [serverless, ess] x-codegen-enabled: true operationId: UpdateEndpointListItem - summary: Update an endpoint exception list item - description: Update an endpoint exception list item using the `id` or `item_id` field. + summary: Update an Elastic Endpoint rule exception list item + description: Update an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. requestBody: description: Exception list item's properties required: true diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml index 92f60194938e9..ce5df63434956 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml @@ -14,9 +14,10 @@ paths: /api/endpoint_list: post: description: >- - Create an endpoint exception list, which groups endpoint exception list - items. If an endpoint exception list already exists, an empty response - is returned. + Create the exception list for Elastic Endpoint rule exceptions. When you + create the exception list, it will have a `list_id` of `endpoint_list`. + If the Elastic Endpoint exception list already exists, your request will + return an empty response. operationId: CreateEndpointList responses: '200': @@ -51,14 +52,14 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list + summary: Create an Elastic Endpoint rule exception list tags: - Security Endpoint Exceptions API /api/endpoint_list/items: delete: description: >- - Delete an endpoint exception list item using the `id` or `item_id` - field. + Delete an Elastic Endpoint exception list item, specified by the `id` or + `item_id` field. operationId: DeleteEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -112,13 +113,13 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Delete an endpoint exception list item + summary: Delete an Elastic Endpoint exception list item tags: - Security Endpoint Exceptions API get: description: >- - Get the details of an endpoint exception list item using the `id` or - `item_id` field. + Get the details of an Elastic Endpoint exception list item, specified by + the `id` or `item_id` field. operationId: ReadEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -174,13 +175,13 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Get an endpoint exception list item + summary: Get an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API post: description: >- - Create an endpoint exception list item, and associate it with the - endpoint exception list. + Create an Elastic Endpoint exception list item, and associate it with + the Elastic Endpoint exception list. operationId: CreateEndpointListItem requestBody: content: @@ -255,13 +256,13 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list item + summary: Create an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API put: description: >- - Update an endpoint exception list item using the `id` or `item_id` - field. + Update an Elastic Endpoint exception list item, specified by the `id` or + `item_id` field. operationId: UpdateEndpointListItem requestBody: content: @@ -341,12 +342,12 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Update an endpoint exception list item + summary: Update an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API /api/endpoint_list/items/_find: get: - description: Get a list of all endpoint exception list items. + description: Get a list of all Elastic Endpoint exception list items. operationId: FindEndpointListItems parameters: - description: > @@ -448,7 +449,7 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Get endpoint exception list items + summary: Get Elastic Endpoint exception list items tags: - Security Endpoint Exceptions API components: @@ -529,9 +530,7 @@ components: example: This list tracks allowlisted values. type: string ExceptionListHumanId: - description: >- - Exception list's human readable string identifier, e.g. - `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 @@ -973,4 +972,4 @@ tags: exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met. name: Security Endpoint Exceptions API - x-displayName: Security endpoint exceptions + x-displayName: Security Elastic Endpoint exceptions diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml index 33a0034c48070..f347eb89214b7 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml @@ -14,9 +14,10 @@ paths: /api/endpoint_list: post: description: >- - Create an endpoint exception list, which groups endpoint exception list - items. If an endpoint exception list already exists, an empty response - is returned. + Create the exception list for Elastic Endpoint rule exceptions. When you + create the exception list, it will have a `list_id` of `endpoint_list`. + If the Elastic Endpoint exception list already exists, your request will + return an empty response. operationId: CreateEndpointList responses: '200': @@ -51,14 +52,14 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list + summary: Create an Elastic Endpoint rule exception list tags: - Security Endpoint Exceptions API /api/endpoint_list/items: delete: description: >- - Delete an endpoint exception list item using the `id` or `item_id` - field. + Delete an Elastic Endpoint exception list item, specified by the `id` or + `item_id` field. operationId: DeleteEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -112,13 +113,13 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Delete an endpoint exception list item + summary: Delete an Elastic Endpoint exception list item tags: - Security Endpoint Exceptions API get: description: >- - Get the details of an endpoint exception list item using the `id` or - `item_id` field. + Get the details of an Elastic Endpoint exception list item, specified by + the `id` or `item_id` field. operationId: ReadEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -174,13 +175,13 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Get an endpoint exception list item + summary: Get an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API post: description: >- - Create an endpoint exception list item, and associate it with the - endpoint exception list. + Create an Elastic Endpoint exception list item, and associate it with + the Elastic Endpoint exception list. operationId: CreateEndpointListItem requestBody: content: @@ -255,13 +256,13 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Create an endpoint exception list item + summary: Create an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API put: description: >- - Update an endpoint exception list item using the `id` or `item_id` - field. + Update an Elastic Endpoint exception list item, specified by the `id` or + `item_id` field. operationId: UpdateEndpointListItem requestBody: content: @@ -341,12 +342,12 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Update an endpoint exception list item + summary: Update an Elastic Endpoint rule exception list item tags: - Security Endpoint Exceptions API /api/endpoint_list/items/_find: get: - description: Get a list of all endpoint exception list items. + description: Get a list of all Elastic Endpoint exception list items. operationId: FindEndpointListItems parameters: - description: > @@ -448,7 +449,7 @@ paths: schema: $ref: '#/components/schemas/SiemErrorResponse' description: Internal server error - summary: Get endpoint exception list items + summary: Get Elastic Endpoint exception list items tags: - Security Endpoint Exceptions API components: @@ -529,9 +530,7 @@ components: example: This list tracks allowlisted values. type: string ExceptionListHumanId: - description: >- - Exception list's human readable string identifier, e.g. - `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 @@ -973,4 +972,4 @@ tags: exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met. name: Security Endpoint Exceptions API - x-displayName: Security endpoint exceptions + x-displayName: Security Elastic Endpoint exceptions diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/scripts/openapi_bundle.js b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/scripts/openapi_bundle.js index c54e162b6462e..c7d0bd2ddbc89 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/scripts/openapi_bundle.js +++ b/x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common/scripts/openapi_bundle.js @@ -29,7 +29,7 @@ const ROOT = resolve(__dirname, '..'); tags: [ { name: 'Security Endpoint Exceptions API', - 'x-displayName': 'Security endpoint exceptions', + 'x-displayName': 'Security Elastic Endpoint exceptions', description: "Endpoint Exceptions API allows you to manage detection rule endpoint exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.", }, @@ -54,7 +54,7 @@ const ROOT = resolve(__dirname, '..'); tags: [ { name: 'Security Endpoint Exceptions API', - 'x-displayName': 'Security endpoint exceptions', + 'x-displayName': 'Security Elastic Endpoint exceptions', description: "Endpoint Exceptions API allows you to manage detection rule endpoint exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.", }, diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.gen.ts b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.gen.ts index 1f4e41bdce711..e2d4b402c11de 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.gen.ts +++ b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.gen.ts @@ -27,7 +27,7 @@ export type ExceptionListId = z.infer; export const ExceptionListId = z.string().min(1).superRefine(isNonEmptyString); /** - * Exception list's human readable string identifier, e.g. `trusted-linux-processes`. + * The exception list's human readable string identifier, `endpoint_list`. */ export type ExceptionListHumanId = z.infer; export const ExceptionListHumanId = z.string().min(1).superRefine(isNonEmptyString); diff --git a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.schema.yaml b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.schema.yaml index e1c2a9088e2a9..6f445bbc25d78 100644 --- a/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.schema.yaml +++ b/x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.schema.yaml @@ -17,7 +17,7 @@ components: type: string minLength: 1 format: nonempty - description: Exception list's human readable string identifier, e.g. `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: 'simple_list' ExceptionListType: 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 d204554b865da..b8150110f0510 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 @@ -2869,9 +2869,7 @@ components: example: This list tracks allowlisted values. type: string ExceptionListHumanId: - description: >- - Exception list's human readable string identifier, e.g. - `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 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 98bff7145de56..b42b1f64de794 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 @@ -2869,9 +2869,7 @@ components: example: This list tracks allowlisted values. type: string ExceptionListHumanId: - description: >- - Exception list's human readable string identifier, e.g. - `trusted-linux-processes`. + description: The exception list's human readable string identifier, `endpoint_list`. example: simple_list format: nonempty minLength: 1 diff --git a/x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts b/x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts index d8c06801ab5b9..9827e48ad5a00 100644 --- a/x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts +++ b/x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts @@ -32,7 +32,7 @@ export function SecuritySolutionApiProvider({ getService }: FtrProviderContext) return { /** - * Create an endpoint exception list, which groups endpoint exception list items. If an endpoint exception list already exists, an empty response is returned. + * Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a `list_id` of `endpoint_list`. If the Elastic Endpoint exception list already exists, your request will return an empty response. */ createEndpointList(kibanaSpace: string = 'default') { return supertest @@ -42,7 +42,7 @@ export function SecuritySolutionApiProvider({ getService }: FtrProviderContext) .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana'); }, /** - * Create an endpoint exception list item, and associate it with the endpoint exception list. + * Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. */ createEndpointListItem(props: CreateEndpointListItemProps, kibanaSpace: string = 'default') { return supertest @@ -53,7 +53,7 @@ export function SecuritySolutionApiProvider({ getService }: FtrProviderContext) .send(props.body as object); }, /** - * Delete an endpoint exception list item using the `id` or `item_id` field. + * Delete an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. */ deleteEndpointListItem(props: DeleteEndpointListItemProps, kibanaSpace: string = 'default') { return supertest @@ -64,7 +64,7 @@ export function SecuritySolutionApiProvider({ getService }: FtrProviderContext) .query(props.query); }, /** - * Get a list of all endpoint exception list items. + * Get a list of all Elastic Endpoint exception list items. */ findEndpointListItems(props: FindEndpointListItemsProps, kibanaSpace: string = 'default') { return supertest @@ -75,7 +75,7 @@ export function SecuritySolutionApiProvider({ getService }: FtrProviderContext) .query(props.query); }, /** - * Get the details of an endpoint exception list item using the `id` or `item_id` field. + * Get the details of an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. */ readEndpointListItem(props: ReadEndpointListItemProps, kibanaSpace: string = 'default') { return supertest @@ -86,7 +86,7 @@ export function SecuritySolutionApiProvider({ getService }: FtrProviderContext) .query(props.query); }, /** - * Update an endpoint exception list item using the `id` or `item_id` field. + * Update an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. */ updateEndpointListItem(props: UpdateEndpointListItemProps, kibanaSpace: string = 'default') { return supertest