Skip to content

[8.x] [Security Solution] Omit Solution from tags and titles in Security Solution's OpenAPI bundles (#193669) #194088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maximpn merged 1 commit into from
Sep 26, 2024
Merged

[8.x] [Security Solution] Omit Solution from tags and titles in Security Solution's OpenAPI bundles (#193669) #194088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7,601 changes: 3,144 additions & 4,457 deletions oas_docs/output/kibana.serverless.staging.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7,823 changes: 3,245 additions & 4,578 deletions oas_docs/output/kibana.staging.yaml
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions ...docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
description: Endpoint Exceptions API allow you to manage Endpoint lists.
title: Security Solution Endpoint Exceptions API (Elastic Cloud and self-hosted)
title: Security Endpoint Exceptions API (Elastic Cloud and self-hosted)
version: '2023-10-31'
servers:
- url: 'http://{kibana_host}:{port}'
Expand Down Expand Up @@ -50,7 +50,7 @@ paths:
description: Internal server error
summary: Creates an endpoint list
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items:
delete:
operationId: DeleteEndpointListItem
Expand Down Expand Up @@ -108,7 +108,7 @@ paths:
description: Internal server error
summary: Deletes an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
get:
operationId: ReadEndpointListItem
parameters:
Expand Down Expand Up @@ -167,7 +167,7 @@ paths:
description: Internal server error
summary: Reads an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
post:
operationId: CreateEndpointListItem
requestBody:
Expand Down Expand Up @@ -245,7 +245,7 @@ paths:
description: Internal server error
summary: Creates an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
put:
operationId: UpdateEndpointListItem
requestBody:
Expand Down Expand Up @@ -328,7 +328,7 @@ paths:
description: Internal server error
summary: Updates an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items/_find:
get:
operationId: FindEndpointListItems
Expand Down Expand Up @@ -434,7 +434,7 @@ paths:
description: Internal server error
summary: Finds endpoint list items
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
components:
schemas:
EndpointList:
Expand Down Expand Up @@ -868,4 +868,4 @@ tags:
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 Solution Endpoint Exceptions API
name: Security Endpoint Exceptions API
16 changes: 8 additions & 8 deletions ...enapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
description: Endpoint Exceptions API allow you to manage Endpoint lists.
title: Security Solution Endpoint Exceptions API (Elastic Cloud Serverless)
title: Security Endpoint Exceptions API (Elastic Cloud Serverless)
version: '2023-10-31'
servers:
- url: 'http://{kibana_host}:{port}'
Expand Down Expand Up @@ -50,7 +50,7 @@ paths:
description: Internal server error
summary: Creates an endpoint list
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items:
delete:
operationId: DeleteEndpointListItem
Expand Down Expand Up @@ -108,7 +108,7 @@ paths:
description: Internal server error
summary: Deletes an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
get:
operationId: ReadEndpointListItem
parameters:
Expand Down Expand Up @@ -167,7 +167,7 @@ paths:
description: Internal server error
summary: Reads an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
post:
operationId: CreateEndpointListItem
requestBody:
Expand Down Expand Up @@ -245,7 +245,7 @@ paths:
description: Internal server error
summary: Creates an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
put:
operationId: UpdateEndpointListItem
requestBody:
Expand Down Expand Up @@ -328,7 +328,7 @@ paths:
description: Internal server error
summary: Updates an endpoint list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items/_find:
get:
operationId: FindEndpointListItems
Expand Down Expand Up @@ -434,7 +434,7 @@ paths:
description: Internal server error
summary: Finds endpoint list items
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
components:
schemas:
EndpointList:
Expand Down Expand Up @@ -868,4 +868,4 @@ tags:
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 Solution Endpoint Exceptions API
name: Security Endpoint Exceptions API
8 changes: 4 additions & 4 deletions packages/kbn-securitysolution-endpoint-exceptions-common/scripts/openapi_bundle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ const ROOT = resolve(__dirname, '..');
includeLabels: ['serverless'],
prototypeDocument: {
info: {
title: 'Security Solution Endpoint Exceptions API (Elastic Cloud Serverless)',
title: 'Security Endpoint Exceptions API (Elastic Cloud Serverless)',
description: 'Endpoint Exceptions API allow you to manage Endpoint lists.',
},
tags: [
{
name: 'Security Solution Endpoint Exceptions API',
name: 'Security Endpoint Exceptions API',
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.",
},
Expand All @@ -48,12 +48,12 @@ const ROOT = resolve(__dirname, '..');
includeLabels: ['ess'],
prototypeDocument: {
info: {
title: 'Security Solution Endpoint Exceptions API (Elastic Cloud and self-hosted)',
title: 'Security Endpoint Exceptions API (Elastic Cloud and self-hosted)',
description: 'Endpoint Exceptions API allow you to manage Endpoint lists.',
},
tags: [
{
name: 'Security Solution Endpoint Exceptions API',
name: 'Security Endpoint Exceptions API',
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.",
},
Expand Down
36 changes: 18 additions & 18 deletions ...s-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
Exceptions API allows you to manage detection rule exceptions to prevent a
rule from generating an alert from incoming events even when the rule's
other criteria are met.
title: Security Solution Exceptions API (Elastic Cloud and self-hosted)
title: Security Exceptions API (Elastic Cloud and self-hosted)
version: '2023-10-31'
servers:
- url: 'http://{kibana_host}:{port}'
Expand Down Expand Up @@ -75,7 +75,7 @@ paths:
description: Internal server error response
summary: Creates rule exception list items
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists:
delete:
operationId: DeleteExceptionList
Expand Down Expand Up @@ -139,7 +139,7 @@ paths:
description: Internal server error response
summary: Deletes an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
get:
operationId: ReadExceptionList
parameters:
Expand Down Expand Up @@ -202,7 +202,7 @@ paths:
description: Internal server error response
summary: Retrieves an exception list using its `id` or `list_id` field
tags:
- Security Solution Exceptions API
- Security Exceptions API
post:
operationId: CreateExceptionList
requestBody:
Expand Down Expand Up @@ -279,7 +279,7 @@ paths:
description: Internal server error response
summary: Creates an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
put:
operationId: UpdateExceptionList
requestBody:
Expand Down Expand Up @@ -359,7 +359,7 @@ paths:
description: Internal server error response
summary: Updates an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_duplicate:
post:
operationId: DuplicateExceptionList
Expand Down Expand Up @@ -428,7 +428,7 @@ paths:
description: Internal server error response
summary: Duplicates an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_export:
post:
description: Exports an exception list and its associated items to an .ndjson file
Expand Down Expand Up @@ -508,7 +508,7 @@ paths:
description: Internal server error response
summary: Exports an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_find:
get:
operationId: FindExceptionLists
Expand Down Expand Up @@ -628,7 +628,7 @@ paths:
description: Internal server error response
summary: Finds exception lists
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_import:
post:
description: Imports an exception list and associated items
Expand Down Expand Up @@ -744,7 +744,7 @@ paths:
description: Internal server error response
summary: Imports an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/items:
delete:
operationId: DeleteExceptionListItem
Expand Down Expand Up @@ -808,7 +808,7 @@ paths:
description: Internal server error response
summary: Deletes an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
get:
operationId: ReadExceptionListItem
parameters:
Expand Down Expand Up @@ -871,7 +871,7 @@ paths:
description: Internal server error response
summary: Gets an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
post:
operationId: CreateExceptionListItem
requestBody:
Expand Down Expand Up @@ -958,7 +958,7 @@ paths:
description: Internal server error response
summary: Creates an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
put:
operationId: UpdateExceptionListItem
requestBody:
Expand Down Expand Up @@ -1049,7 +1049,7 @@ paths:
description: Internal server error response
summary: Updates an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/items/_find:
get:
operationId: FindExceptionListItems
Expand Down Expand Up @@ -1185,7 +1185,7 @@ paths:
description: Internal server error response
summary: Finds exception list items
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/summary:
get:
operationId: ReadExceptionListSummary
Expand Down Expand Up @@ -1268,7 +1268,7 @@ paths:
description: Internal server error response
summary: Retrieves an exception list summary
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exceptions/shared:
post:
operationId: CreateSharedExceptionList
Expand Down Expand Up @@ -1327,7 +1327,7 @@ paths:
description: Internal server error response
summary: Creates a shared exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
components:
schemas:
CreateExceptionListItemComment:
Expand Down Expand Up @@ -1857,4 +1857,4 @@ tags:
Exceptions API allows you to manage detection rule exceptions to prevent a
rule from generating an alert from incoming events even when the rule's
other criteria are met.
name: Security Solution Exceptions API
name: Security Exceptions API
Loading