Skip to content

[DOCS] Add minimal short URL APIs#213860

Merged
lcawl merged 2 commits intoelastic:mainfrom
lcawl:short-urls
Mar 18, 2025
Merged

[DOCS] Add minimal short URL APIs#213860
lcawl merged 2 commits intoelastic:mainfrom
lcawl:short-urls

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 11, 2025 •
edited by kibanamachine
Loading

Summary

Relates to #206243

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

In the long run, 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 docs backport:version Backport to applied version labels v9.1.0 v8.19.0 v8.18.1 v9.0.1 labels Mar 11, 2025
@lcawl lcawl mentioned this pull request Mar 11, 2025
Closed
9 tasks
@lcawl lcawl added the Team:SharedUX Platform AppEx-SharedUX (formerly Global Experience) t// label Mar 11, 2025
@lcawl lcawl marked this pull request as ready for review March 11, 2025 05:13
@lcawl lcawl requested a review from a team as a code owner March 11, 2025 05:13
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Mar 11, 2025

Pinging @elastic/appex-sharedux (Team:SharedUX)

eokoneyo
eokoneyo approved these changes Mar 18, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@eokoneyo eokoneyo left a comment

Choose a reason for hiding this comment

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

Changes LGTM and are on par with existing short URL documentation

@lcawl lcawl enabled auto-merge (squash) March 18, 2025 10:42
@lcawl lcawl merged commit 863a42f into elastic:main Mar 18, 2025
9 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Mar 18, 2025

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

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

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Mar 18, 2025

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 18, 2025
@lcawl
[DOCS] Add minimal short URL APIs (elastic#213860)
98df41c 
(cherry picked from commit 863a42f)
@kibanamachine kibanamachine mentioned this pull request Mar 18, 2025
Merged
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Mar 18, 2025

💔 Some backports could not be created

Status Branch Result
❌ 8.18 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.18:
- [DOCS] Logstash configuration management APIs (#214497)
❌ 8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- [DOCS] Logstash configuration management APIs (#214497)
- [DOCS] Add minimal uptime APIs (#213867)
- OpenAPI docs for APM UI APIs (#197946)
✅ 9.0

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 213860

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Mar 18, 2025
@kibanamachine @lcawl
[9.0] [DOCS] Add minimal short URL APIs (#213860) (#214969)
fd630b3 
# Backport

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

<!--- 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-18T12:28:23Z","message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Team:SharedUX","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal short URL
APIs","number":213860,"url":"https://github.com/elastic/kibana/pull/213860","mergeCommit":{"message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213860","number":213860,"mergeCommit":{"message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@lcawl lcawl deleted the short-urls branch March 18, 2025 18:43
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 18, 2025
@lcawl
[DOCS] Add minimal short URL APIs (elastic#213860)
0b5ea8c 
(cherry picked from commit 863a42f)
@lcawl lcawl mentioned this pull request Mar 18, 2025
Merged
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 18, 2025
@lcawl
[DOCS] Add minimal short URL APIs (elastic#213860)
d864725 
(cherry picked from commit 863a42f)
@lcawl lcawl mentioned this pull request Mar 18, 2025
Merged
@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Mar 18, 2025

💚 All backports created successfully

Status Branch Result
✅ 8.x
✅ 8.18

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Mar 19, 2025
@lcawl
[8.x] [DOCS] Add minimal short URL APIs (#213860) (#215055)
d53ad25 
# Backport

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

<!--- 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-18T12:28:23Z","message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637","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:SharedUX","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal short URL
APIs","number":213860,"url":"https://github.com/elastic/kibana/pull/213860","mergeCommit":{"message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/214969","number":214969,"state":"MERGED","mergeCommit":{"sha":"fd630b317e926e72a524727941eb3404b557c471","message":"[9.0]
[DOCS] Add minimal short URL APIs (#213860) (#214969)\n\n#
Backport\n\nThis will backport the following commits from `main` to
`9.0`:\n- [[DOCS] Add minimal short URL
APIs\n(#213860)](https://github.com/elastic/kibana/pull/213860)\n\n\n\n###
Questions ?\nPlease refer to the [Backport
tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213860","number":213860,"mergeCommit":{"message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
lcawl added a commit that referenced this pull request Mar 19, 2025
@lcawl
[8.18] [DOCS] Add minimal short URL APIs (#213860) (#215057)
75e90b5 
# Backport

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

<!--- 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-18T12:28:23Z","message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637","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:SharedUX","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal short URL
APIs","number":213860,"url":"https://github.com/elastic/kibana/pull/213860","mergeCommit":{"message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/214969","number":214969,"state":"MERGED","mergeCommit":{"sha":"fd630b317e926e72a524727941eb3404b557c471","message":"[9.0]
[DOCS] Add minimal short URL APIs (#213860) (#214969)\n\n#
Backport\n\nThis will backport the following commits from `main` to
`9.0`:\n- [[DOCS] Add minimal short URL
APIs\n(#213860)](https://github.com/elastic/kibana/pull/213860)\n\n\n\n###
Questions ?\nPlease refer to the [Backport
tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213860","number":213860,"mergeCommit":{"message":"[DOCS]
Add minimal short URL APIs
(#213860)","sha":"863a42fd31827e592319fcaf3670a7d18cd3e637"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
clintandrewhall pushed a commit to clintandrewhall/kibana that referenced this pull request Mar 20, 2025
@lcawl @clintandrewhall
[DOCS] Add minimal short URL APIs (elastic#213860)
09c37b4
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Mar 22, 2025
@lcawl @CAWilson94
[DOCS] Add minimal short URL APIs (elastic#213860)
552712b
cqliu1 pushed a commit to cqliu1/kibana that referenced this pull request Mar 31, 2025
@lcawl @cqliu1
[DOCS] Add minimal short URL APIs (elastic#213860)
3155d4d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@eokoneyo eokoneyo eokoneyo approved these changes

Assignees

No one assigned

Labels

backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:SharedUX Platform AppEx-SharedUX (formerly Global Experience) t// v8.18.0 v8.18.1 v8.19.0 v9.0.0 v9.0.1 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lcawl @elasticmachine @kibanamachine @eokoneyo