[Security Solution] Create missing OpenAPI specs for Detections API #183661
Labels
8.15 candidate
docs
Project:Serverless
Work as part of the Serverless project for its initial release
Team:Detection Engine
Security Solution Detection Engine Area
Team:Detection Rule Management
Security Detection Rule Management Team
Team:Detections and Resp
Security Detection Response Team
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
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:
POST /api/detection_engine/rules/{id}/exceptions
POST /api/detection_engine/rules/preview
POST /api/detection_engine/signals/status
POST /api/detection_engine/signals/tags
POST /api/detection_engine/signals/search
GET /api/detection_engine/privileges
The following public API endpoints are available in ESS only, and don't have any OpenAPI specs:
POST /api/detection_engine/index
GET /api/detection_engine/index
DELETE /api/detection_engine/index
POST /api/detection_engine/signals/migration_status
POST /api/detection_engine/signals/migration
POST /api/detection_engine/signals/finalize_migration
DELETE /api/detection_engine/signals/migration
POST /api/detection_engine/rules/_bulk_delete
To do
The text was updated successfully, but these errors were encountered: