Skip to content

[DOCS] Add overlays for CCR API examples #3672

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 3 commits into from
Jan 31, 2025
Merged

[DOCS] Add overlays for CCR API examples #3672

merged 3 commits into from
Jan 31, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 31, 2025

Relates to #2482

This PR converts some CCR API examples from JSON to YAML (to comment out some invalid fields) and adds those examples to the OpenAPI output by using overlays.

It also copies some descriptions from the documentation into the specification.

Copy link
Contributor

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

API Status Request Response
ccr.delete_auto_follow_pattern Missing test Missing test
ccr.follow_info Missing test Missing test
ccr.follow_stats Missing test Missing test
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.get_auto_follow_pattern Missing test Missing test
ccr.pause_auto_follow_pattern Missing test Missing test
ccr.pause_follow Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
ccr.stats Missing test Missing test
ccr.unfollow Missing test Missing test

You can validate these APIs yourself by using the make validate target.

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! 🐋

Copy link
Contributor

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

API Status Request Response
ccr.delete_auto_follow_pattern Missing test Missing test
ccr.follow_info Missing test Missing test
ccr.follow_stats Missing test Missing test
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.get_auto_follow_pattern Missing test Missing test
ccr.pause_auto_follow_pattern Missing test Missing test
ccr.pause_follow Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
ccr.stats Missing test Missing test
ccr.unfollow Missing test Missing test

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl marked this pull request as ready for review January 31, 2025 17:16
Copy link
Contributor

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

API Status Request Response
ccr.delete_auto_follow_pattern Missing test Missing test
ccr.follow_info Missing test Missing test
ccr.follow_stats Missing test Missing test
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.get_auto_follow_pattern Missing test Missing test
ccr.pause_auto_follow_pattern Missing test Missing test
ccr.pause_follow Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
ccr.stats Missing test Missing test
ccr.unfollow Missing test Missing test

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl merged commit 41f2f0a into main Jan 31, 2025
8 checks passed
@lcawl lcawl deleted the ccr-examples branch January 31, 2025 17:16
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-3672-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 41f2f0a0e1a4df480de14d2d0de5b72861c2f187
# Push it to GitHub
git push --set-upstream origin backport-3672-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-3672-to-8.x.

Copy link
Contributor

The backport to 8.18 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.18 8.18
# Navigate to the new working tree
cd .worktrees/backport-8.18
# Create a new branch
git switch --create backport-3672-to-8.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 41f2f0a0e1a4df480de14d2d0de5b72861c2f187
# Push it to GitHub
git push --set-upstream origin backport-3672-to-8.18
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.18

Then, create a pull request where the base branch is 8.18 and the compare/head branch is backport-3672-to-8.18.

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 Jan 31, 2025
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 <153528055+l-trotta@users.noreply.github.com>

---------

Co-authored-by: Laura Trotta <153528055+l-trotta@users.noreply.github.com>

* 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 <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Laura Trotta <153528055+l-trotta@users.noreply.github.com>
Co-authored-by: David Kyle <david.kyle@elastic.co>
Co-authored-by: Keith Massey <keith.massey@elastic.co>
Co-authored-by: Ying Mao <ying.mao@elastic.co>
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