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] Make existing OpenAPI specs for Endpoint exceptions API documentation-ready #183841

Open
6 tasks
maximpn opened this issue May 20, 2024 · 4 comments
Open
6 tasks

[Security Solution] Make existing OpenAPI specs for Endpoint exceptions API documentation-ready #183841

maximpn opened this issue May 20, 2024 · 4 comments
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.

Comments

@maximpn
Copy link
Contributor

maximpn commented May 20, 2024 •
edited by banderror

Epic: https://github.com/elastic/security-team/issues/9531
Depends on: #183839

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

Summary

As part of the Serverless project, we need to make sure OpenAPI specs for all public Endpoint exceptions API endpoints are polished and ready to be published on a documentation website. Please look for more context in the epic, and please find below what needs to be done exactly.

API endpoints

The following public API endpoints were discovered during research:

  • 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

For all the Endpoint exceptions API endpoints (including those above), in the corresponding OpenAPI specification files, please:

  • Add summaries for:
    • API endpoints
    • HTTP methods
  • Add descriptions for:
    • API endpoints
    • HTTP methods
    • endpoint's parameters
    • requests
    • responses
    • shared schemas
  • Add examples.
  • Add tags to group your endpoints in the docs (depends on: [Security Solution] Bundle root level tags  #183375)
  • Make sure the generated API reference documentation looks nice and correct on bump.sh.
  • Make sure the generated Serverless API reference documentation doesn't contain available only in ESS API endpoints.

Ask @maximpn to provide you with an example of a polished and documentation-ready OpenAPI spec. Please also ask @maximpn for a link to the generated API reference documentation (at the time of creating this ticket, it didn't exist).
@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-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@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
@banderror banderror changed the title [Security Solution] Make existing OpenAPI specs for Endpoint list API documentation-ready [Security Solution] Make existing OpenAPI specs for Endpoint exceptions API documentation-ready Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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.
Projects
None yet
Milestone
No milestone
Development

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