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] Improve OpenAPI specs for Lists API #183822

Open
18 tasks
Tracked by #200310
maximpn opened this issue May 20, 2024 · 4 comments
Open
18 tasks
Tracked by #200310

[Security Solution] Improve OpenAPI specs for Lists API #183822

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

Epic: #200310

Summary

We need to make our API reference docs for Lists API more user-friendly and usable. For that, we need to improve and polish the corresponding OpenAPI specs: enrich them with summaries, descriptions, examples of usage, etc:

  • Add summaries for:
    • API endpoints
    • HTTP methods
  • Add descriptions for:
    • API endpoints
    • HTTP methods
    • endpoint's parameters
    • requests
    • responses
    • shared schemas
  • Add examples of usage of each API endpoint.
  • Make sure the generated API reference documentation looks nice and correct on bump.sh.

API endpoints

The following public API endpoints were discovered during research:

  • POST /api/lists
  • GET /api/lists
  • PUT /api/lists
  • DELETE /api/lists
  • PATCH /api/lists
  • GET /api/lists/_find
  • GET /api/lists/privileges
  • POST /api/lists/items
  • GET /api/lists/items
  • PUT /api/lists/items
  • DELETE /api/lists/items
  • PATCH /api/lists/items
  • POST /api/lists/items/_export
  • POST /api/lists/items/_import
  • GET /api/lists/items/_find
  • POST /api/lists/index
  • GET /api/lists/index
  • DELETE /api/lists/index
@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 8.16 candidate labels May 20, 2024
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@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 Aug 7, 2024
Closed
4 tasks
@banderror banderror mentioned this issue Nov 15, 2024
Open
@banderror banderror changed the title [Security Solution] Make existing OpenAPI specs for Lists API documentation-ready [Security Solution] Improve OpenAPI specs for Lists API Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
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