[Security Solution] Make existing OpenAPI specs for Osquery API documentation-ready #183824
Open
1 of 15 tasks
Labels
8.16 candidate
docs
grooming
Team:Defend Workflows
“EDR Workflows” sub-team of Security Solution
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Epic: https://github.com/elastic/security-team/issues/9527
Depends on: #183823
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 Osquery 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:
GET /api/osquery/live_queries
POST /api/osquery/live_queries
GET /api/osquery/live_queries/{id}
GET /api/osquery/live_queries/{id}/results/{actionId}
POST /api/osquery/packs
DELETE /api/osquery/packs/{id}
GET /api/osquery/packs
GET /api/osquery/packs/{id}
PUT /api/osquery/packs/{id}
POST /api/osquery/saved_queries
DELETE /api/osquery/saved_queries/{id}
GET /api/osquery/saved_queries
GET /api/osquery/saved_queries/{id}
PUT /api/osquery/saved_queries/{id}
To do
For all the Osquery 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).
The text was updated successfully, but these errors were encountered: