Open maximpn opened 1 month ago
Pinging @elastic/security-detections-response (Team:Detections and Resp)
Pinging @elastic/security-solution (Team: SecuritySolution)
Pinging @elastic/security-detection-engine (Team:Detection Engine)
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)
Epic: https://github.com/elastic/security-team/issues/9530 Depends on: https://github.com/elastic/kibana/issues/183837
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 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/exceptions/shared
POST /api/exception_lists/_export
POST /api/exception_lists/_import
POST /api/exception_lists
GET /api/exception_lists
PUT /api/exception_lists
DELETE /api/exception_lists
GET /api/exception_lists/_find
POST /api/exception_lists/_duplicate
POST /api/exception_lists/items
GET /api/exception_lists/items
PUT /api/exception_lists/items
DELETE /api/exception_lists/items
GET /api/exception_lists/items/_find
GET /api/exception_lists/summary
To do
For all the Exceptions API endpoints (including those above), in the corresponding OpenAPI specification files, please:
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).