elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.64k stars 8.22k forks source link

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

Open banderror opened 2 hours ago

banderror commented 2 hours ago

Related to: 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:

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:

Implementation tasks

### Tasks
- [ ] https://github.com/elastic/kibana/issues/183702
- [ ] https://github.com/elastic/kibana/issues/183822
- [ ] https://github.com/elastic/kibana/issues/183838
- [ ] https://github.com/elastic/kibana/issues/183841
elasticmachine commented 2 hours ago

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

elasticmachine commented 2 hours ago

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

elasticmachine commented 2 hours ago

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

elasticmachine commented 2 hours ago

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