-
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
[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs #184956
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
Pinging @elastic/response-ops (Team:ResponseOps) |
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.
Tested and is working as expected 👍
💚 Build Succeeded
Metrics [docs]
To update your PR or re-run it, just comment with: |
💔 All backports failed
Manual backportTo create the backport manually run:
Questions ?Please refer to the Backport tool documentation |
…astic#184956) (cherry picked from commit e6795e5)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…PIs (#184956) (#189237) # Backport This will backport the following commits from `main` to `8.15`: - [[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (#184956)](#184956) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-07-25T21:46:30Z","message":"[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (#184956)","sha":"e6795e5b0a58f8369e354fc2806531a173b052c9","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","backport:prev-minor","Feature:OAS","v8.16.0"],"number":184956,"url":"https://github.com/elastic/kibana/pull/184956","mergeCommit":{"message":"[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (#184956)","sha":"e6795e5b0a58f8369e354fc2806531a173b052c9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/184956","number":184956,"mergeCommit":{"message":"[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (#184956)","sha":"e6795e5b0a58f8369e354fc2806531a173b052c9"}}]}] BACKPORT-->
Summary
Relates to #180056, #182779
This PR:
oas-tag
values so that the output contains tagsdeprecated: true
qualifiers to the legacy APIs per [HTTP/OAS] Supportdeprecated
field #181240NOTE: I've commented out details about the kibana feature privileges since I think we'll need to quality the difference between privileges in serverless and stateful contexts.
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: