-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[HTTP/OAS] Add tags and summaries for saved object APIs #184184
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job @lcawl! Left a nit.
packages/core/saved-objects/core-saved-objects-server-internal/src/routes/find.ts
Outdated
Show resolved
Hide resolved
packages/core/saved-objects/core-saved-objects-server-internal/src/routes/import.ts
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Descriptions look good!
Just one question echoing JL's comment about routes switching to public
x-pack/plugins/encrypted_saved_objects/server/routes/key_rotation.ts
Outdated
Show resolved
Hide resolved
…/src/routes/find.ts Co-authored-by: Jean-Louis Leysens <[email protected]>
I've split off the changes to the manually-maintained OpenAPI document in #186134 since this PR was getting overly large. |
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks updating these endpoints with summaries and main
changes.
I opened this issue to do the last step of including SO APIs in our generated bundle.
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Co-authored-by: Jean-Louis Leysens <[email protected]> (cherry picked from commit dddcf2e)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
2 similar comments
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
Summary
Relates to #180056, #183935
This PR adds summaries and tags for saved object operations in the generated OpenAPI document.
How to test
Per #181277:
yarn es snapshot --license trial
)server.oas.enabled: true
tokibana.dev.yml
yarn start --no-base-path
)The output will contain info like this: