Skip to content

Commit 37ee1a5

Browse files
[9.2] [API DOCS]: Update Upgrade Assistant description (#244102) (#244750)
# Backport This will backport the following commits from `main` to `9.2`: - [[API DOCS]: Update Upgrade Assistant description (#244102)](#244102) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Charlotte Hoblik","email":"116336412+charlotte-hoblik@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-12-01T11:36:20Z","message":"[API DOCS]: Update Upgrade Assistant description (#244102)","sha":"697c49759c4136e1173e927524fd432ac933fe9b","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","APIDocs","backport:version","v9.1.0","v8.19.0","v9.0.1","v9.0.2","v9.0.3","v9.2.0","v9.0.4","v9.0.5","v9.1.1","v8.19.1","v9.1.2","v8.19.2","v9.1.3","v8.19.3","v9.0.6","v9.1.4","v9.0.7","v8.19.4","v8.19.5","v9.0.8","v9.1.5","v9.3.0","v9.1.6","v8.19.6","v9.0.9","v8.19.7","v9.1.7","v9.2.1"],"title":"[API DOCS]: Update Upgrade Assistant description","number":244102,"url":"https://github.com/elastic/kibana/pull/244102","mergeCommit":{"message":"[API DOCS]: Update Upgrade Assistant description (#244102)","sha":"697c49759c4136e1173e927524fd432ac933fe9b"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","9.1","8.19","9.2"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.2","label":"v9.2.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/244102","number":244102,"mergeCommit":{"message":"[API DOCS]: Update Upgrade Assistant description (#244102)","sha":"697c49759c4136e1173e927524fd432ac933fe9b"}}]}] BACKPORT--> Co-authored-by: Charlotte Hoblik <116336412+charlotte-hoblik@users.noreply.github.com>
1 parent ff7c4e8 commit 37ee1a5

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

oas_docs/output/kibana.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,12 @@ tags:
358358
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/kibana-tasks-management
359359
name: task manager
360360
x-displayName: Task manager
361-
- description: The assistant helps you prepare for the next major version of Elasticsearch.
361+
- description: |
362+
The Kibana Upgrade Assistant API helps you prepare for the next major Elasticsearch release.
363+
> warn
364+
> This is a Kibana REST API (not an Elasticsearch API) and requests must target your Kibana URL:
365+
> * Self-managed URL pattern: `https://localhost:5601`
366+
> * Elastic Cloud URL pattern: `https://your-deployment.kb.us-east-1.aws.elastic.cloud:9243`
362367
name: upgrade
363368
x-displayName: Upgrade assistant
364369
- description: Uptime APIs enable you to view and update uptime monitoring settings.

x-pack/platform/plugins/private/upgrade_assistant/docs/openapi/upgrade_apis.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ info:
88
url: https://www.elastic.co/licensing/elastic-license
99
tags:
1010
- name: upgrade
11-
description: The assistant helps you prepare for the next major version of Elasticsearch.
11+
description: |
12+
The Kibana Upgrade Assistant API helps you prepare for the next major Elasticsearch release.
13+
> warn
14+
> This is a Kibana REST API (not an Elasticsearch API) and requests must target your Kibana URL:
15+
> * Self-managed URL pattern: `https://localhost:5601`
16+
> * Elastic Cloud URL pattern: `https://your-deployment.kb.us-east-1.aws.elastic.cloud:9243`
1217
x-displayName: Upgrade assistant
1318
servers:
1419
- url: /

0 commit comments

Comments
 (0)