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.

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

[Security Solution] Create missing OpenAPI specs for Endpoint exceptions API #183839

Open
6 tasks
maximpn opened this issue May 20, 2024 · 4 comments
Open
6 tasks
Assignees
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

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

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 Endpoint 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 Endpoint 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/endpoint_list
  • POST /api/endpoint_list/items
  • GET /api/endpoint_list/items
  • PUT /api/endpoint_list/items
  • DELETE /api/endpoint_list/items
  • GET /api/endpoint_list/items/_find

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 and add them to the list above.
  • 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. 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)

@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
@banderror banderror changed the title [Security Solution] Create missing OpenAPI specs for Endpoint list API [Security Solution] Create missing OpenAPI specs for Endpoint exceptions API Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

No branches or pull requests

3 participants