Skip to content

[DOCS] Add minimal uptime APIs#213867

Merged
lcawl merged 3 commits intoelastic:mainfrom
lcawl:uptime-apis
Mar 17, 2025
Merged

[DOCS] Add minimal uptime APIs#213867
lcawl merged 3 commits intoelastic:mainfrom
lcawl:uptime-apis

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 11, 2025

Summary

Relates to #206243

This PR includes the uptime API in the OpenAPI document, since https://www.elastic.co/guide/en/kibana/current/uptime-apis.html will not exist in the narrative V9 docs.

In the long run if this API persists, ideally this information would be generated from the code but this is a stop-gap.

Preview

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 docs Team:uptime backport:version Backport to applied version labels v8.18.0 v9.1.0 v8.19.0 labels Mar 11, 2025
@lcawl lcawl marked this pull request as ready for review March 11, 2025 23:58
@lcawl lcawl requested a review from a team as a code owner March 11, 2025 23:58
@elasticmachine
Copy link
Copy Markdown
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #107 / discover/group1 discover accessibility top nav menu buttons should return focus to the alerts button when dismissing the alerts popover

Metrics [docs]

✅ unchanged

@lcawl lcawl requested a review from a team March 17, 2025 15:34
Copy link
Copy Markdown
Contributor

@justinkambic justinkambic left a comment

Choose a reason for hiding this comment

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

LGTM

@justinkambic
Copy link
Copy Markdown
Contributor

In the long run if this API persists, ideally this information would be generated from the code

We are planning to deprecate it.

@lcawl lcawl merged commit 57caf87 into elastic:main Mar 17, 2025
9 checks passed
@lcawl lcawl deleted the uptime-apis branch March 17, 2025 22:03
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/13910742664

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 17, 2025
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 17, 2025
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 17, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

💚 All backports created successfully

Status Branch Result
8.18
8.x
9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Mar 18, 2025
# Backport

This will backport the following commits from `main` to `8.18`:
- [[DOCS] Add minimal uptime APIs
(#213867)](#213867)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-17T22:03:33Z","message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","Team:uptime","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[DOCS]
Add minimal uptime
APIs","number":213867,"url":"https://github.com/elastic/kibana/pull/213867","mergeCommit":{"message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213867","number":213867,"mergeCommit":{"message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
kibanamachine added a commit that referenced this pull request Mar 18, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS] Add minimal uptime APIs
(#213867)](#213867)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-17T22:03:33Z","message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","Team:uptime","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[DOCS]
Add minimal uptime
APIs","number":213867,"url":"https://github.com/elastic/kibana/pull/213867","mergeCommit":{"message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213867","number":213867,"mergeCommit":{"message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 19, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

kibanamachine added a commit that referenced this pull request Mar 20, 2025
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Add minimal uptime APIs
(#213867)](#213867)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-17T22:03:33Z","message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","Team:uptime","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[DOCS]
Add minimal uptime
APIs","number":213867,"url":"https://github.com/elastic/kibana/pull/213867","mergeCommit":{"message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213867","number":213867,"mergeCommit":{"message":"[DOCS]
Add minimal uptime APIs
(#213867)","sha":"57caf8796cd5633625ccec94b1d77b3b425fec35"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 20, 2025
clintandrewhall pushed a commit to clintandrewhall/kibana that referenced this pull request Mar 20, 2025
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Mar 22, 2025
cqliu1 pushed a commit to cqliu1/kibana that referenced this pull request Mar 31, 2025
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 release_note:skip Skip the PR/issue when compiling release notes Team:uptime v8.18.0 v8.19.0 v9.0.0 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants