[Security Solution] Create missing OpenAPI specs for Detections API

maximpn commented 2 months ago

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

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 create OpenAPI specs for all public Detections API endpoints, because we want all of them documented before Serverless GA. Please look for more context in the epic.

During a Security Solution public API research we discovered that some public Detections API endpoints have missing OpenAPI specs. We need to add them.

API endpoints

The following public API endpoints are available in both Serverless and ESS, and don't have any OpenAPI specs:

[x] POST /api/detection_engine/rules/preview https://github.com/elastic/kibana/pull/186764
[x] POST /api/detection_engine/signals/status https://github.com/elastic/kibana/pull/184838
[x] POST /api/detection_engine/signals/tags https://github.com/elastic/kibana/pull/184838
[x] POST /api/detection_engine/signals/search https://github.com/elastic/kibana/pull/184838
[x] GET /api/detection_engine/privileges https://github.com/elastic/kibana/pull/186764

The following public API endpoints are available in ESS only, and don't have any OpenAPI specs:

[x] POST /api/detection_engine/index https://github.com/elastic/kibana/pull/186401
[x] GET /api/detection_engine/index https://github.com/elastic/kibana/pull/186401
[x] DELETE /api/detection_engine/index https://github.com/elastic/kibana/pull/186401
[x] POST /api/detection_engine/signals/migration_status https://github.com/elastic/kibana/pull/184838
[x] POST /api/detection_engine/signals/migration ( https://github.com/elastic/kibana/pull/184838
[x] POST /api/detection_engine/signals/finalize_migration https://github.com/elastic/kibana/pull/184838
[x] DELETE /api/detection_engine/signals/migration https://github.com/elastic/kibana/pull/184838
[x] POST /api/detection_engine/rules/_bulk_delete https://github.com/elastic/kibana/pull/186764

To do

Create OpenAPI specs for the endpoints listed above.
Check if there are any other public endpoints that you own that don't have OpenAPI specs.
Make sure the specs you add are valid OpenAPI documents.
Make sure the specs you add match the actual API contract 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).

elasticmachine commented 2 months ago

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

elasticmachine commented 2 months ago

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

elasticmachine commented 2 months ago

Pinging @elastic/security-detections-response (Team:Detections and Resp)

elasticmachine commented 2 months ago

Pinging @elastic/security-detection-engine (Team:Detection Engine)

maximpn commented 1 week ago

This task was addressed in

elastic / kibana