Skip to content
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

Jump to bottom

[Security Solution] Create missing OpenAPI specs for Detections API #183661

Closed
13 tasks done
maximpn opened this issue May 16, 2024 · 5 comments
Closed
13 tasks done

[Security Solution] Create missing OpenAPI specs for Detections API #183661

maximpn opened this issue May 16, 2024 · 5 comments
Assignees
@maximpn
Labels
8.15 candidate 8.16 candidate docs Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.15.0 v8.16.0

Comments

@maximpn
Copy link
Contributor

maximpn commented May 16, 2024 •
edited
Loading

Epic: https://github.com/elastic/security-team/issues/9398

Deadline: Jul 29, 2024 (see milestones in https://github.com/elastic/security-team/issues/9400)

Summary

As part of the Serverless project, we need to create OpenAPI specs for all public Detections API endpoints, because we want all of them documented before Serverless GA. Please look for more context in the epic.

During a Security Solution public API research we discovered that some public Detections API endpoints have missing OpenAPI specs. We need to add them.

API endpoints

The following public API endpoints are available in both Serverless and ESS, and don't have any OpenAPI specs:

The following public API endpoints are available in ESS only, and don't have any OpenAPI specs:

To do

  • Create OpenAPI specs for the endpoints listed above.
  • Check if there are any other public endpoints that you own that don't have OpenAPI specs.
  • Make sure the specs you add are valid OpenAPI documents.
  • Make sure the specs you add match the actual API contract defined in the code.
  • Mark the endpoints as available in ESS, or Serverless, or in both offerings (depends on: https://github.com/elastic/security-team/issues/9516).
@maximpn maximpn added docs Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team Project:Serverless Work as part of the Serverless project for its initial release Team:Detection Engine Security Solution Detection Engine Area labels May 16, 2024
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-engine (Team:Detection Engine)

@maximpn maximpn changed the title [Security Solution] Create missing OpenAPI specs for Detections API [Security Solution] Create missing OpenAPI specs for Detection Engine API May 17, 2024
@maximpn maximpn mentioned this issue May 17, 2024
Closed
18 tasks
@banderror banderror changed the title [Security Solution] Create missing OpenAPI specs for Detection Engine API [Security Solution] Create missing OpenAPI specs for Detections API May 17, 2024
@banderror banderror mentioned this issue May 17, 2024
Open
30 tasks
This was referenced May 20, 2024
Closed
Closed
@banderror banderror removed the Project:Serverless Work as part of the Serverless project for its initial release label Jun 4, 2024
This was referenced Jun 5, 2024
Merged
Closed
This was referenced Jun 18, 2024
Merged
Merged
maximpn added a commit that referenced this issue Jun 18, 2024
@maximpn
[Security Solution] Add missing alerts (signals) API endpoints OpenAP…
b169a9c 
…I specs (#184838)

**Addresses:** #183661

## Summary

This PR adds missing OpenAPI specs for the following API endpoints (Alerts API and Alerts Migration API) available in both Serverless and ESS

- `POST /api/detection_engine/signals/status`
- `POST /api/detection_engine/signals/tags`
- `POST /api/detection_engine/signals/search`

and API endpoints available only in ESS

- `POST /api/detection_engine/signals/migration_status`
- `POST /api/detection_engine/signals/migration`
- `POST /api/detection_engine/signals/finalize_migration`
- `DELETE /api/detection_engine/signals/migration`

**Note:** Code generation is enabled for the added specs to verify that it works and produces expected results. Generated Zod schemas and types aren't integrated in the route's code.
bhapas pushed a commit to bhapas/kibana that referenced this issue Jun 18, 2024
@maximpn @bhapas
[Security Solution] Add missing alerts (signals) API endpoints OpenAP…
5794041 
…I specs (elastic#184838)

**Addresses:** elastic#183661

## Summary

This PR adds missing OpenAPI specs for the following API endpoints (Alerts API and Alerts Migration API) available in both Serverless and ESS

- `POST /api/detection_engine/signals/status`
- `POST /api/detection_engine/signals/tags`
- `POST /api/detection_engine/signals/search`

and API endpoints available only in ESS

- `POST /api/detection_engine/signals/migration_status`
- `POST /api/detection_engine/signals/migration`
- `POST /api/detection_engine/signals/finalize_migration`
- `DELETE /api/detection_engine/signals/migration`

**Note:** Code generation is enabled for the added specs to verify that it works and produces expected results. Generated Zod schemas and types aren't integrated in the route's code.
maximpn added a commit that referenced this issue Jun 21, 2024
@maximpn
[Security Solution] Add missing Alert index API OpenAPI specs (#186401)
b632f00 
**Addresses:** #183661

## Summary

This PR adds missing OpenAPI specs for the Alert Index API endpoints available in ESS

- `POST /api/detection_engine/index`
- `GET /api/detection_engine/index`
- `DELETE /api/detection_engine/index`
@maximpn maximpn mentioned this issue Jun 22, 2024
Merged
bhapas pushed a commit to bhapas/kibana that referenced this issue Jun 24, 2024
@maximpn @bhapas
[Security Solution] Add missing Alert index API OpenAPI specs (elasti…
f566dbc 
…c#186401)

**Addresses:** elastic#183661

## Summary

This PR adds missing OpenAPI specs for the Alert Index API endpoints available in ESS

- `POST /api/detection_engine/index`
- `GET /api/detection_engine/index`
- `DELETE /api/detection_engine/index`
maximpn added a commit that referenced this issue Jul 12, 2024
@maximpn
[Security Solution] Add missing Detections API OpenAPI specs (#186764)
577a583 
**Addresses:** #183661

## Summary

This PR adds missing OpenAPI specs for the following Detections API endpoints available in both Serverless and ESS

- `POST /api/detection_engine/rules/preview`

and the following API endpoints available in ESS only

- `GET /api/detection_engine/privileges`
- `POST /api/detection_engine/rules/_bulk_delete`
@maximpn
Copy link
Contributor Author

maximpn commented Jul 12, 2024

This task was addressed in

@maximpn maximpn closed this as completed Jul 12, 2024
@maximpn maximpn mentioned this issue Aug 1, 2024
Merged
maximpn added a commit that referenced this issue Aug 5, 2024
@maximpn
[Security Solution] Align operationId and file names in OpenAPI specs (…
a4fc565 
…#189703)

**Relates to:** #183661 (internal)
**Relates to:** #183821 (internal)
**Relates to:** #183837 (internal)

## Summary

It addresses a discussion Rule Management team had on a tech time meeting whose outcome was usage of consistent  operationId, files and folder naming related to OpenAPI specs. For example use `Read` instead of `Get` since it gives better readability and matches with already used approach.

This PR aligns the naming and performs necessary renaming.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maximpn maximpn

Labels
8.15 candidate 8.16 candidate docs Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.15.0 v8.16.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@maximpn @banderror @elasticmachine