Skip to content

[DOCS] Fix overlay for resolve cluster #3670

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

Merged
merged 1 commit into from
Jan 31, 2025
Merged

[DOCS] Fix overlay for resolve cluster #3670

merged 1 commit into from
Jan 31, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 30, 2025

Relates to #3655

This PR updates our overlays to pick up the second example for the resolve cluster API and attaches them to where they now exist in the OpenAPI output (in the components section instead of the paths section).

It also fixes one description string.

Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
cluster.remote_info 🟢 3/3 3/3

You can validate this API yourself by using the make validate target.

@lcawl lcawl marked this pull request as ready for review January 30, 2025 18:52
Copy link

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🐄

@lcawl lcawl merged commit f37de4e into main Jan 31, 2025
12 checks passed
@lcawl lcawl deleted the examples-3 branch January 31, 2025 16:17
Copy link
Contributor

The backport to 8.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-3670-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f37de4e6a0f0418ebf439b23072c246722be2a79
# Push it to GitHub
git push --set-upstream origin backport-3670-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.x

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-3670-to-8.x.

lcawl added a commit that referenced this pull request Jan 31, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Jan 31, 2025

💚 All backports created successfully

Status Branch Result
8.x

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 31, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Jan 31, 2025

💚 All backports created successfully

Status Branch Result
8.18

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Feb 3, 2025
pquentin pushed a commit that referenced this pull request Feb 6, 2025
* [DOCS] Fix overlay for resolve cluster (#3670)

* Update specification output

* uppercase enum source mode (#3676)

* [DOCS] Add overlays for CCR API examples (#3672)

* Update inference.update.json with the correct verb (#3688)

* Update specification output

* [DOCS] Convert final examples from JSON to YAML (#3692)

* Update specification output

* Correcting the response format for ingest simulate (#3640)

* Correcting the response format for ingest simulate

* code review feedback

* moving error to the correct place, and adding ignored_fields

* Update specification/simulate/ingest/SimulateIngestResponse.ts

Co-authored-by: Laura Trotta <[email protected]>

---------

Co-authored-by: Laura Trotta <[email protected]>

* Update specification output

* Add text_embedding_bits to inference result output (#3698)

* Update specification output

* Improve `Analyzer` definitions and fix various classes (#3215)

* Update specification output

---------

Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
Co-authored-by: Laura Trotta <[email protected]>
Co-authored-by: David Kyle <[email protected]>
Co-authored-by: Keith Massey <[email protected]>
Co-authored-by: Ying Mao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants