search

elastic / kibana

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

[Cloud Security] document internal APIs of cloud_security_posture plugin with OpenAPI #173830

Open maxcold opened 6 months ago

maxcold commented 6 months ago

Motivation Created after this PR comment

as our plugin grows, more APIs are being added to it. It would be good to have API docs for our endpoints. OpenAPI is used at Elastic to document APIs (external and internal), it makes to use it too, even though we don't have public APIs at the time of writing this ticket. Also consider code generation options (one option linked in the comment) to avoid the need to always keep docs and interfaces in sync.

elasticmachine commented 6 months ago

Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security)