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

[OAS] Refresh saved objects API document #186134

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 12, 2024

Summary

This API updates the manually-maintained openAPI document for saved objects as follows:

  1. Reverts from OAS 3.1 to 3.0, so that it can be joined with other 3.0 files and aligns with the version of the automated document. This involved updating the way an example was declared.
  2. Adds a serverless-specific list of endpoints, since it's a smaller subset per comments in [HTTP/OAS] Add tags and summaries for saved object APIs #184184
  3. Edits the operation summaries and descriptions to align with linting rules

@lcawl lcawl added Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting docs labels Jun 12, 2024
@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl force-pushed the saved-objects-oas branch from 4667550 to ff9d1e0 Compare June 12, 2024 21:33
@lcawl lcawl requested a review from a team June 12, 2024 21:38
@lcawl lcawl marked this pull request as ready for review June 12, 2024 21:56
@lcawl lcawl requested a review from a team as a code owner June 12, 2024 21:56
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🦕

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl merged commit 8862115 into elastic:main Jun 13, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants