Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Security Solution] Make existing OpenAPI specs for Timeline API correct #183812

Open
14 tasks
maximpn opened this issue May 20, 2024 · 3 comments · May be fixed by #186458
Open
14 tasks

[Security Solution] Make existing OpenAPI specs for Timeline API correct #183812

maximpn opened this issue May 20, 2024 · 3 comments · May be fixed by #186458
Assignees
@janmonschke
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
8.15

Comments

@maximpn
Copy link
Contributor

maximpn commented May 20, 2024 •
edited
Loading

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

  • 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).
@maximpn maximpn added docs Team:Threat Hunting Security Solution Threat Hunting Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Threat Hunting:Investigations Security Solution Investigations Team Project:Serverless Work as part of the Serverless project for its initial release 8.15 candidate labels May 20, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting (Team:Threat Hunting)

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting-investigations (Team:Threat Hunting:Investigations)

@maximpn maximpn mentioned this issue May 20, 2024
Open
15 tasks
@logeekal logeekal added this to the 8.15 milestone May 24, 2024
@banderror banderror removed the Project:Serverless Work as part of the Serverless project for its initial release label Jun 4, 2024
@janmonschke janmonschke self-assigned this Jun 6, 2024
@janmonschke janmonschke linked a pull request Jun 19, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@janmonschke janmonschke

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
Projects
None yet
Milestone
8.15
Development

Successfully merging a pull request may close this issue.

[Security] Timeline OpenAPI documentation fixes janmonschke/kibana
6 participants
@janmonschke @maximpn @banderror @logeekal @elasticmachine @PhilippeOberti