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 D&R API reference documentation #200310

Open
4 of 9 tasks
banderror opened this issue Nov 15, 2024 · 4 comments
Open
4 of 9 tasks

[Security Solution] Improve D&R API reference documentation #200310

banderror opened this issue Nov 15, 2024 · 4 comments
Assignees
@jkelas
Labels
8.18 candidate APIDocs documentation epic 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

@banderror
Copy link
Contributor

banderror commented Nov 15, 2024 •
edited
Loading

Related to: https://github.com/elastic/security-docs-internal/issues/57, https://github.com/elastic/security-team/issues/9400

Summary

Improve the auto-generated API reference documentation available on elastic.co/docs/api for the following Serverless and Stateful APIs:

  • Detections API
  • Lists API
  • Exceptions API
  • Endpoint Exceptions API

We need to make these API docs 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 whole API endpoints and specific HTTP methods.
  • Add descriptions for API endpoints, HTTP methods, endpoint parameters, requests and responses, as well as schemas shared between multiple endpoints.
  • Add examples of usage of each API endpoint.
  • Make sure the API docs look nice on bump.sh.

Links

Implementation tasks

Improve OpenAPI specs

Migrate content from the legacy API docs

Remove API docs content

Add more API docs content
@banderror banderror added docs epic Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team Team:Detection Engine Security Solution Detection Engine Area Team:Detections and Resp Security Detection Response Team labels Nov 15, 2024
@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)

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@banderror banderror changed the title [Security Solution] Improve Detections API reference documentation (DRAFT) [Security Solution] Improve D&R API reference documentation (DRAFT) Nov 15, 2024
This was referenced Nov 15, 2024
Open
Closed
Closed
Closed
@banderror banderror changed the title [Security Solution] Improve D&R API reference documentation (DRAFT) [Security Solution] Improve D&R API reference documentation Nov 15, 2024
@banderror banderror mentioned this issue Feb 19, 2025
Open
59 tasks
This was referenced Feb 19, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jkelas jkelas

Labels
8.18 candidate APIDocs documentation epic 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
@banderror @elasticmachine @jkelas