[Security Solution] Make existing OpenAPI specs for Timeline API correct #183812
Labels
8.15 candidate
docs
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Team:Threat Hunting:Investigations
Security Solution Investigations Team
Team:Threat Hunting
Security Solution Threat Hunting Team
Milestone
Epic: https://github.com/elastic/security-team/issues/9524
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 Timeline 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 Timeline 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:
POST /api/timeline
PATCH /api/timeline
POST /api/timeline/_import
POST /api/timeline/_export
GET /api/timeline/_draft
GET /api/timeline
GET /api/timelines
POST /api/timeline/_draft
DELETE /api/timeline
PATCH /api/timeline/_favorite
POST /api/timeline/_prepackaged
PATCH | /api/note
DELETE /api/note
PATCH /api/pinned_event
To do
The text was updated successfully, but these errors were encountered: