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 Exceptions API #183837

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

[Security Solution] Create missing OpenAPI specs for Exceptions API #183837

maximpn opened this issue May 20, 2024 · 5 comments
Assignees
@maximpn
Labels
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.16.0

Comments

@maximpn
Copy link
Contributor

maximpn commented May 20, 2024 •
edited
Loading

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

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 Exceptions 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 Exceptions API endpoints have missing OpenAPI specs. We need to add them.

API endpoints

The following public API endpoints were discovered during research, and don't have any OpenAPI specs:

  • 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

Missing specs for the above endpoints were added in #185951.

To do
@maximpn maximpn added docs Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Project:Serverless Work as part of the Serverless project for its initial release Team:Detection Engine Security Solution Detection Engine Area 8.15 candidate labels May 20, 2024
@elasticmachine
Copy link
Contributor

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

@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 mentioned this issue May 20, 2024
Open
15 tasks
@banderror banderror added the Team:Detection Rule Management Security Detection Rule Management Team label May 27, 2024
@elasticmachine
Copy link
Contributor

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

@banderror banderror removed the Project:Serverless Work as part of the Serverless project for its initial release label Jun 4, 2024
@maximpn maximpn mentioned this issue Jun 11, 2024
Merged
@maximpn maximpn mentioned this issue Jun 18, 2024
Closed
maximpn added a commit that referenced this issue Jul 15, 2024
@maximpn
[Security Solution] Add missing Exceptions API OpenAPI specifications (…
4d7c36c 
…#185951)

**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`
@maximpn
Copy link
Contributor Author

maximpn commented Jul 15, 2024

Missing specs for the above endpoints were added in #185951.

@maximpn maximpn closed this as completed Jul 15, 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.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.16.0
Projects
None yet
Milestone
No milestone
Development

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