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

[API][DOCS] Add x-state to saved object APIs #196783

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 17, 2024

Summary

This PR adds x-state in the OpenAPI documents for saved object APIs, which removes the need to cover that information in the descriptions.

After #196647 is merged, this detail should be moved to the code and IMO we should move to generating these saved object API docs.

@lcawl lcawl added Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes docs v8.16.0 backport:version Backport to applied version labels v8.17.0 v8.15.4 labels Oct 17, 2024
@lcawl lcawl requested a review from TinaHeiligers October 17, 2024 23:43
@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

@lcawl lcawl marked this pull request as draft January 21, 2025 01:29
@elasticmachine
Copy link
Contributor

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes v8.15.4 v8.16.0 v8.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants