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 documentation-ready #183813

Open
15 tasks
maximpn opened this issue May 20, 2024 · 3 comments
Open
15 tasks

[Security Solution] Make existing OpenAPI specs for Timeline API documentation-ready #183813

maximpn opened this issue May 20, 2024 · 3 comments
Labels
8.16 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

Comments

@maximpn
Copy link
Contributor

maximpn commented May 20, 2024 •
edited
Loading

Epic: https://github.com/elastic/security-team/issues/9524
Depends on: #183810, #183812

Deadline: Sep 24, 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 polished and ready to be published on a documentation website. Please look for more context in the epic, and please find below what needs to be done exactly.

API endpoints

The following public API endpoints were discovered during research:

  • POST /api/timeline
  • PATCH /api/timeline
  • POST /api/timeline/_import
  • POST /api/timeline/_export
  • GET /api/timeline/_draft
  • GET /api/timeline
  • GET /api/timeline/resolve
  • 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

For all the Timeline API endpoints (including those above), in the corresponding OpenAPI specification files, please:

  • Add summaries for:
    • API endpoints
    • HTTP methods
  • Add descriptions for:
    • API endpoints
    • HTTP methods
    • endpoint's parameters
    • requests
    • responses
    • shared schemas
  • Add examples.
  • Add tags to group your endpoints in the docs (depends on: [Security Solution] Bundle root level tags  #183375)
  • Make sure the generated API reference documentation looks nice and correct on bump.sh.
  • Make sure the generated Serverless API reference documentation doesn't contain available only in ESS API endpoints.

Ask @maximpn to provide you with an example of a polished and documentation-ready OpenAPI spec. Please also ask @maximpn for a link to the generated API reference documentation (at the time of creating this ticket, it didn't exist).
@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.16 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)

@banderror banderror removed the Project:Serverless Work as part of the Serverless project for its initial release label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
8.16 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
No milestone
Development

No branches or pull requests
3 participants
@maximpn @banderror @elasticmachine