[Security Solution] Make existing OpenAPI specs for Osquery API documentation-ready

[maximpn]

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:

• Add summaries for:
  • API endpoints
  • HTTP methods
• Add descriptions for:
  • API endpoints
  • HTTP methods
  • endpoint's parameters
  • requests
  • responses
  • shared schemas
• Add examples.
• Add tags to group your endpoints in the docs (depends on: [Security Solution] Bundle root level tags  #183375)
• Make sure the generated API reference documentation looks nice and correct on bump.sh.
• Make sure the generated Serverless API reference documentation doesn't contain available only in ESS API endpoints.

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).

[elasticmachine]

Pinging @elastic/security-defend-workflows (Team:Defend Workflows)

[elasticmachine]

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

[banderror]

I'm closing this ticket since the Osquery API docs have become available on elastic.co/docs/api/doc/serverless and elastic.co/docs/api/doc/kibana. Please open new tickets if any follow-up work is needed.