Skip to content

[8.17] Improves Timeline API docs content (#192744)#204907

Merged
natasha-moore-elastic merged 2 commits intoelastic:8.17from
natasha-moore-elastic:backport/8.17/pr-192744
Dec 19, 2024
Merged

[8.17] Improves Timeline API docs content (#192744)#204907
natasha-moore-elastic merged 2 commits intoelastic:8.17from
natasha-moore-elastic:backport/8.17/pr-192744

Conversation

@natasha-moore-elastic
Copy link
Copy Markdown
Contributor

Backport

This will backport the following commits from main to 8.17:

Questions ?

Please refer to the Backport tool documentation

## Summary

Resolves elastic/security-docs-internal#35 by
improving the Timeline API docs content. Adds missing and improves
existing operation summaries and operation descriptions to adhere to our
[OAS
standards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).

---------

Co-authored-by: Jatin Kathuria <jtn.kathuria@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 9765f73)

# Conflicts:
#	x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts
#	x-pack/plugins/security_solution/docs/openapi/ess/security_solution_timeline_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_timeline_api_2023_10_31.bundled.schema.yaml
#	x-pack/test/api_integration/services/security_solution_api.gen.ts
Copy link
Copy Markdown
Contributor

@logeekal logeekal 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 the backport. Looks great.

@natasha-moore-elastic natasha-moore-elastic merged commit de3f14d into elastic:8.17 Dec 19, 2024
@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants