[Security Solution] Make existing OpenAPI specs for Endpoint management API correct

[maximpn]

Epic: https://github.com/elastic/security-team/issues/9525

Deadline: Jul 29, 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 Endpoint management API endpoints are correct. We want all the APIs documented before Serverless GA. Please look for more context in the epic.

During a Security Solution public API research we discovered that for some of the public Endpoint management API endpoints we already have OpenAPI specs. We just need to make sure they are correct. Please see below what needs to be done exactly.

API endpoints

The following public API endpoints were discovered during research, and have OpenAPI specs:

• GET /api/endpoint/metadata
• GET /api/endpoint/metadata/{id}
• GET /api/endpoint/metadata/transforms
• POST /api/endpoint/suggestions/{suggestion_type}
• GET /api/endpoint/policy_response
• GET /api/endpoint/policy/summaries
• GET /api/endpoint/action_status
• GET /api/endpoint/action/state
• GET /api/endpoint/action_log/{agent_id}
• GET /api/endpoint/action
• GET /api/endpoint/action/{action_id}
• POST /api/endpoint/action/isolate
• POST /api/endpoint/action/unisolate
• POST /api/endpoint/action/kill_process
• POST /api/endpoint/action/suspend_process
• POST /api/endpoint/action/running_procs
• POST /api/endpoint/action/get_file
• POST /api/endpoint/action/execute
• POST /api/endpoint/action/upload
• POST /api/endpoint/action/scan
• GET /api/endpoint/action/{action_id}/file/{file_id}/download
• GET /api/endpoint/action/{action_id}/file/{file_id}
• GET /api/endpoint/protection_updates_note/{package_policy_id}
• POST /api/endpoint/protection_updates_note/{package_policy_id}

To do

• Check if there are any other public endpoints that you own that have OpenAPI specs and add them to the list above.
• Make sure your specs (including those above) are valid OpenAPI documents.
• Make sure your specs (including those above) match the actual API contracts defined in the code.
• Mark the endpoints as available in ESS, or Serverless, or in both offerings (depends on: https://github.com/elastic/security-team/issues/9516).
• Update schema response stubs to specific responses

[elasticmachine]

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

[elasticmachine]

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