[Security Solution] Add missing Exceptions API OpenAPI specifications #185951

maximpn · 2024-06-11T13:42:19Z

Resolves: #183837

Summary

This PR adds missing OpenAPI specifications for Exceptions API which are the following

POST /api/exception_lists/_export
POST /api/exception_lists/_import
POST /api/exception_lists
GET /api/exception_lists
PUT /api/exception_lists
DELETE /api/exception_lists
GET /api/exception_lists/_find
POST /api/exception_lists/_duplicate
POST /api/exception_lists/items
GET /api/exception_lists/items
PUT /api/exception_lists/items
DELETE /api/exception_lists/items
GET /api/exception_lists/items/_find
GET /api/exception_lists/summary
POST /api/exceptions/shared
POST /api/detection_engine/rules/{id}/exceptions

elasticmachine · 2024-06-22T05:28:39Z

Pinging @elastic/security-detections-response (Team:Detections and Resp)

elasticmachine · 2024-06-22T05:28:40Z

Pinging @elastic/security-solution (Team: SecuritySolution)

marshallmain

Looks mostly good, just a couple schemas that I don't see used anywhere?

marshallmain · 2024-07-09T18:31:03Z

...ysolution-exceptions-common/api/create_exception_list_item/create_exception_list_item.gen.ts

+export type CreateExceptionListItemRequestBodyCamelCase = z.infer<
+  typeof CreateExceptionListItemRequestBodyCamelCase
+>;
+export const CreateExceptionListItemRequestBodyCamelCase = z.object({


What's this camel case schema for? I don't see it used in the API routes

Initially I had an idea to replace existing type CreateExceptionListItemOptions in x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts with CreateExceptionListItemRequestBodyCamelCase but rolled back the changes due to a number of changes required.

I removed the schema. We can add it back if needed.

marshallmain · 2024-07-09T18:43:16Z

...ysolution-exceptions-common/api/update_exception_list_item/update_exception_list_item.gen.ts

+export type UpdateExceptionListItemRequestBodyCamelCase = z.infer<
+  typeof UpdateExceptionListItemRequestBodyCamelCase
+>;
+export const UpdateExceptionListItemRequestBodyCamelCase = z.object({


where do we use this camel case schema?

Initially I had an idea to replace existing type UpdateExceptionListItemOptions in x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts with UpdateExceptionListItemRequestBodyCamelCase but rolled back the changes due to a number of changes required.

I removed the schema. We can add it back if needed.

marshallmain · 2024-07-09T18:56:32Z

...solution-exceptions-common/api/find_exception_list_item/find_exception_list_item.schema.yaml

+        - name: list_id
+          in: query
+          required: true
+          description: List's ide


Suggested change

description: List's ide

description: List's id

banderror

Thank you @maximpn, overall and code owners changes LGTM 👍

packages/kbn-openapi-common/shared/path_params_replacer.ts

.buildkite/scripts/steps/code_generation/security_solution_codegen.sh

elasticmachine · 2024-07-10T13:23:03Z

💔 Build Failed

Buildkite Build
Commit: cd6d3acae9149ecdfdee2a4e27b907cb0f84dc35

Failed CI Steps

Test Failures

[job] [logs] Defend Workflows Cypress Tests on Serverless #4 / Automated Response Actions From alerts "before all" hook for "should have generated endpoint and rule" "before all" hook for "should have generated endpoint and rule"
[job] [logs] Defend Workflows Cypress Tests on Serverless #7 / Endpoints page "before all" hook for "Shows endpoint on the list" "before all" hook for "Shows endpoint on the list"
[job] [logs] Defend Workflows Cypress Tests on Serverless #14 / Response console Execute operations: "before all" hook for ""execute --command" - should execute a command" "before all" hook for ""execute --command" - should execute a command"
[job] [logs] Defend Workflows Cypress Tests on Serverless #4 / Response console Host Isolation: "before all" hook for "should release an isolated host via response console" "before all" hook for "should release an isolated host via response console"
[job] [logs] Defend Workflows Cypress Tests on Serverless #5 / Response console Scan operation: "before all" hook for ""scan --path" - should scan a file" "before all" hook for ""scan --path" - should scan a file"

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`lists`	290	289	-1
`securitySolution`	5638	5637	-1
total			-2

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/securitysolution-io-ts-list-types`	525	521	-4

Unknown metric groups

API count

id	before	after	diff
`@kbn/securitysolution-io-ts-list-types`	538	534	-4

History

💔 Build #220505 failed c9a716e21eb0b98494c658a17c9196079830135a
💔 Build #220277 failed b7a273b6abdef22132ad725be3c5d161c609fa76

cc @maximpn

e40pud

Thanks for addressing the feedback! LGTM

maximpn self-assigned this Jun 11, 2024

maximpn force-pushed the add-missing-exceptions-api-oas branch 2 times, most recently from 22d2fc8 to 61ad063 Compare June 12, 2024 14:03

maximpn force-pushed the add-missing-exceptions-api-oas branch 11 times, most recently from d4d7cd8 to 09f4a03 Compare June 21, 2024 20:40

maximpn marked this pull request as ready for review June 22, 2024 05:28

maximpn requested review from a team as code owners June 22, 2024 05:28

maximpn requested review from parkiino and paul-tavares June 22, 2024 05:28

maximpn requested a review from rylnd June 22, 2024 05:28

maximpn requested a review from e40pud July 9, 2024 07:35

marshallmain reviewed Jul 9, 2024

View reviewed changes

maximpn force-pushed the add-missing-exceptions-api-oas branch from b7a273b to c9a716e Compare July 10, 2024 05:12

maximpn requested a review from marshallmain July 10, 2024 05:15

banderror approved these changes Jul 10, 2024

View reviewed changes

packages/kbn-openapi-common/shared/path_params_replacer.ts Outdated Show resolved Hide resolved

.buildkite/scripts/steps/code_generation/security_solution_codegen.sh Outdated Show resolved Hide resolved

maximpn force-pushed the add-missing-exceptions-api-oas branch from c9a716e to cd6d3ac Compare July 10, 2024 12:29

marshallmain approved these changes Jul 11, 2024

View reviewed changes

maximpn force-pushed the add-missing-exceptions-api-oas branch from cd6d3ac to 33a1a17 Compare July 12, 2024 08:16

e40pud approved these changes Jul 15, 2024

View reviewed changes

maximpn added 15 commits July 15, 2024 11:38

create kbn- securitysolution-exceptions-common package

77e6a9e

add Exceptions API OpenAPI specs

b3a24cb

apply generated Zod schemas to Exceptions API routes

88bf6d1

enable Exceptions Common package PR pipeline code generation

85f5a47

generate test clients

c5fc6e5

simply folded if's in lists API routes

a76046f

update deps

353a6a2

fix a problem of unused replaceParams helper in API client

862f51b

fix generated exceptions API client

be4fe8a

use string instead of NonEmptyString where necessary

f3cfb59

use only positive integers for pagination fields

e43b80c

fix description's misprint

957a5ef

remove unused camel case schemas

9809758

add an example

1757ec0

specify explicit ownership for security_solution_codegen.sh

a93fe4e

maximpn force-pushed the add-missing-exceptions-api-oas branch from 33a1a17 to a93fe4e Compare July 15, 2024 09:38

maximpn merged commit 4d7c36c into elastic:main Jul 15, 2024
42 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Jul 15, 2024

maximpn deleted the add-missing-exceptions-api-oas branch July 15, 2024 11:13

dhurley14 mentioned this pull request Aug 26, 2024

[Security Solution] [Exceptions] PUT api allows empty item_id but fails validation when fetching the associated list #191315

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Security Solution] Add missing Exceptions API OpenAPI specifications #185951

[Security Solution] Add missing Exceptions API OpenAPI specifications #185951

maximpn commented Jun 11, 2024 •

edited

Loading

elasticmachine commented Jun 22, 2024

elasticmachine commented Jun 22, 2024

marshallmain left a comment

marshallmain Jul 9, 2024

maximpn Jul 10, 2024

marshallmain Jul 9, 2024

maximpn Jul 10, 2024

marshallmain Jul 9, 2024

banderror left a comment

elasticmachine commented Jul 10, 2024 •

edited

Loading

API count

e40pud left a comment •

edited

Loading

[Security Solution] Add missing Exceptions API OpenAPI specifications #185951

[Security Solution] Add missing Exceptions API OpenAPI specifications #185951

Conversation

maximpn commented Jun 11, 2024 • edited Loading

Summary

elasticmachine commented Jun 22, 2024

elasticmachine commented Jun 22, 2024

marshallmain left a comment

Choose a reason for hiding this comment

marshallmain Jul 9, 2024

Choose a reason for hiding this comment

maximpn Jul 10, 2024

Choose a reason for hiding this comment

marshallmain Jul 9, 2024

Choose a reason for hiding this comment

maximpn Jul 10, 2024

Choose a reason for hiding this comment

marshallmain Jul 9, 2024

Choose a reason for hiding this comment

banderror left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 10, 2024 • edited Loading

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

API count

History

e40pud left a comment • edited Loading

Choose a reason for hiding this comment

maximpn commented Jun 11, 2024 •

edited

Loading

elasticmachine commented Jul 10, 2024 •

edited

Loading

e40pud left a comment •

edited

Loading