Skip to content

[Security Solution] Omit Solution from tags and titles in Security Solution's OpenAPI bundles #193669

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 3 commits into from
Sep 24, 2024
Merged

[Security Solution] Omit Solution from tags and titles in Security Solution's OpenAPI bundles #193669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ff211a
fix Security Solution OpenAPI tag name
maximpn Sep 23, 2024
856ffb6
update result bundles
maximpn Sep 23, 2024
3e518b5
Merge branch 'main' into fix-security-solution-openapi-tags
maximpn Sep 24, 2024
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,623 changes: 3,155 additions & 4,468 deletions oas_docs/output/kibana.serverless.staging.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7,845 changes: 3,256 additions & 4,589 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 @@ -53,7 +53,7 @@ paths:
description: Internal server error
summary: Create an endpoint exception list
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items:
delete:
description: >-
Expand Down Expand Up @@ -114,7 +114,7 @@ paths:
description: Internal server error
summary: Delete an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
get:
description: >-
Get the details of an endpoint exception list item using the `id` or
Expand Down Expand Up @@ -176,7 +176,7 @@ paths:
description: Internal server error
summary: Get an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
post:
description: >-
Create an endpoint exception list item, and associate it with the
Expand Down Expand Up @@ -257,7 +257,7 @@ paths:
description: Internal server error
summary: Create an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
put:
description: >-
Update an endpoint exception list item using the `id` or `item_id`
Expand Down Expand Up @@ -343,7 +343,7 @@ paths:
description: Internal server error
summary: Update an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items/_find:
get:
description: Get a list of all endpoint exception list items.
Expand Down Expand Up @@ -450,7 +450,7 @@ paths:
description: Internal server error
summary: Get endpoint exception list items
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
components:
schemas:
EndpointList:
Expand Down Expand Up @@ -884,4 +884,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 @@ -53,7 +53,7 @@ paths:
description: Internal server error
summary: Create an endpoint exception list
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items:
delete:
description: >-
Expand Down Expand Up @@ -114,7 +114,7 @@ paths:
description: Internal server error
summary: Delete an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
get:
description: >-
Get the details of an endpoint exception list item using the `id` or
Expand Down Expand Up @@ -176,7 +176,7 @@ paths:
description: Internal server error
summary: Get an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
post:
description: >-
Create an endpoint exception list item, and associate it with the
Expand Down Expand Up @@ -257,7 +257,7 @@ paths:
description: Internal server error
summary: Create an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
put:
description: >-
Update an endpoint exception list item using the `id` or `item_id`
Expand Down Expand Up @@ -343,7 +343,7 @@ paths:
description: Internal server error
summary: Update an endpoint exception list item
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
/api/endpoint_list/items/_find:
get:
description: Get a list of all endpoint exception list items.
Expand Down Expand Up @@ -450,7 +450,7 @@ paths:
description: Internal server error
summary: Get endpoint exception list items
tags:
- Security Solution Endpoint Exceptions API
- Security Endpoint Exceptions API
components:
schemas:
EndpointList:
Expand Down Expand Up @@ -884,4 +884,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 @@ -76,7 +76,7 @@ paths:
description: Internal server error response
summary: Create rule exception list items
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists:
delete:
description: Delete an exception list using the `id` or `list_id` field.
Expand Down Expand Up @@ -141,7 +141,7 @@ paths:
description: Internal server error response
summary: Delete an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
get:
description: Get the details of an exception list using the `id` or `list_id` field.
operationId: ReadExceptionList
Expand Down Expand Up @@ -205,7 +205,7 @@ paths:
description: Internal server error response
summary: Get exception list details
tags:
- Security Solution Exceptions API
- Security Exceptions API
post:
description: >
An exception list groups exception items and can be associated with
Expand Down Expand Up @@ -295,7 +295,7 @@ paths:
description: Internal server error response
summary: Create an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
put:
description: Update an exception list using the `id` or `list_id` field.
operationId: UpdateExceptionList
Expand Down Expand Up @@ -376,7 +376,7 @@ paths:
description: Internal server error response
summary: Update an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_duplicate:
post:
description: Duplicate an existing exception list.
Expand Down Expand Up @@ -446,7 +446,7 @@ paths:
description: Internal server error response
summary: Duplicate an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_export:
post:
description: Export an exception list and its associated items to an NDJSON file.
Expand Down Expand Up @@ -526,7 +526,7 @@ paths:
description: Internal server error response
summary: Export an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_find:
get:
description: Get a list of all exception lists.
Expand Down Expand Up @@ -647,7 +647,7 @@ paths:
description: Internal server error response
summary: Get exception lists
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/_import:
post:
description: Import an exception list and its associated items from an NDJSON file.
Expand Down Expand Up @@ -763,7 +763,7 @@ paths:
description: Internal server error response
summary: Import an exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/items:
delete:
description: Delete an exception list item using the `id` or `item_id` field.
Expand Down Expand Up @@ -828,7 +828,7 @@ paths:
description: Internal server error response
summary: Delete an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
get:
description: >-
Get the details of an exception list item using the `id` or `item_id`
Expand Down Expand Up @@ -894,7 +894,7 @@ paths:
description: Internal server error response
summary: Get an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
post:
description: >
Create an exception item and associate it with the specified exception
Expand Down Expand Up @@ -988,7 +988,7 @@ paths:
description: Internal server error response
summary: Create an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
put:
description: Update an exception list item using the `id` or `item_id` field.
operationId: UpdateExceptionListItem
Expand Down Expand Up @@ -1080,7 +1080,7 @@ paths:
description: Internal server error response
summary: Update an exception list item
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/items/_find:
get:
description: Get a list of all exception list items in the specified list.
Expand Down Expand Up @@ -1217,7 +1217,7 @@ paths:
description: Internal server error response
summary: Get exception list items
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exception_lists/summary:
get:
description: Get a summary of the specified exception list.
Expand Down Expand Up @@ -1301,7 +1301,7 @@ paths:
description: Internal server error response
summary: Get an exception list summary
tags:
- Security Solution Exceptions API
- Security Exceptions API
/api/exceptions/shared:
post:
description: >
Expand Down Expand Up @@ -1373,7 +1373,7 @@ paths:
description: Internal server error response
summary: Create a shared exception list
tags:
- Security Solution Exceptions API
- Security Exceptions API
components:
schemas:
CreateExceptionListItemComment:
Expand Down Expand Up @@ -1903,4 +1903,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