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.

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

Get Timeline API docs enhancements #4882

Merged
merged 4 commits into from
Mar 11, 2024

Conversation

natasha-moore-elastic
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic commented Mar 7, 2024

Resolves #4881 by making improvements to the following API docs:

  • Get Timelines or Timeline templates
  • Get Timeline / Timeline template by savedObjectId
  • Get Timeline template by templateTimelineId

Summary of changes

All three docs:

  • Improved endpoint and parameter descriptions.
  • Added Response code and Example response sections.

Get Timeline / Timeline template by savedObjectId and Get Timeline template by templateTimelineId only:

  • Updated request examples to use mock data instead of placeholders.
  • Added the query parameter information

Previews

Copy link

github-actions bot commented Mar 7, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@natasha-moore-elastic natasha-moore-elastic self-assigned this Mar 7, 2024
@natasha-moore-elastic natasha-moore-elastic added enhancement New feature or request Team: Threat Hunting Formerly Data Visibility API Priority: Medium Issues that have relevance, but aren't urgent Effort: Medium Issues that take moderate but not substantial time to complete v8.13.0 Feature: Timeline labels Mar 7, 2024
@natasha-moore-elastic natasha-moore-elastic marked this pull request as ready for review March 7, 2024 15:52
@natasha-moore-elastic natasha-moore-elastic requested a review from a team as a code owner March 7, 2024 15:52
@natasha-moore-elastic natasha-moore-elastic requested a review from a team March 7, 2024 15:52
joepeeples
joepeeples previously approved these changes Mar 8, 2024
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

michaelolo24
michaelolo24 previously approved these changes Mar 8, 2024
Copy link

@michaelolo24 michaelolo24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating these docs!

@natasha-moore-elastic
Copy link
Contributor Author

run docs-build

@natasha-moore-elastic natasha-moore-elastic merged commit 84037e1 into main Mar 11, 2024
3 checks passed
@natasha-moore-elastic natasha-moore-elastic deleted the timeline-API-enhancements branch March 11, 2024 15:20
mergify bot pushed a commit that referenced this pull request Mar 11, 2024
* Get Timeline API docs enhancements

* Replaces slash

* Adds default values

(cherry picked from commit 84037e1)
natasha-moore-elastic added a commit that referenced this pull request Mar 11, 2024
* Get Timeline API docs enhancements

* Replaces slash

* Adds default values

(cherry picked from commit 84037e1)

Co-authored-by: natasha-moore-elastic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Effort: Medium Issues that take moderate but not substantial time to complete enhancement New feature or request Feature: Timeline Priority: Medium Issues that have relevance, but aren't urgent Team: Threat Hunting Formerly Data Visibility v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: Improve Get Timeline API docs
3 participants