-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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 descriptions for uptime setting APIs #184268
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lcawl
added
release_note:skip
Skip the PR/issue when compiling release notes
docs
Team:uptime
v8.15.0
labels
May 24, 2024
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
botelastic
bot
added
the
ci:project-deploy-observability
Create an Observability project
label
Jun 4, 2024
lcawl
changed the title
[HTTP/OAS] Add descriptions for uptime setting APIs
[HTTP/OAS] Add tags and descriptions for uptime setting APIs
Jun 4, 2024
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: |
justinkambic
approved these changes
Jun 18, 2024
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!
Tested locally, seeing the expected JSON:
{
"openapi": "3.0.0",
"info": {
"title": "Kibana HTTP APIs",
"version": "0.0.0"
},
"servers": [
{
"url": "http://localhost:5601"
}
],
"paths": {
"/api/uptime/settings": {
"get": {
"summary": "",
"description": "Get uptime settings",
"tags": [
"uptime"
],
"responses": {
"200": {
"content": {
"application/json; Elastic-Api-Version=2023-10-31": {
"schema": {
"type": "object",
"properties": {
"heartbeatIndices": {
"type": "string",
"minLength": 1
},
"certAgeThreshold": {
"minimum": 1,
"type": "number"
},
"certExpirationThreshold": {
"minimum": 1,
"type": "number"
},
...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
apm:review
backport:skip
This commit does not require backporting
ci:project-deploy-observability
Create an Observability project
docs
release_note:skip
Skip the PR/issue when compiling release notes
Team:uptime
v8.15.0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Relates to #180056
This PR adds operation summaries for the uptime setting APIs in the generated OpenAPI document.
It also adds tags per #184320
How to test
Per #181277:
yarn es snapshot --license trial
)server.oas.enabled: true
tokibana.dev.yml
yarn start --no-base-path
)