Skip to content
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

[DOCS] Add overlays for transform examples #3658

Merged
merged 2 commits into from
Jan 30, 2025
Merged

[DOCS] Add overlays for transform examples #3658

merged 2 commits into from
Jan 30, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 30, 2025

Relates to #2482

This PR converts the transform examples from JSON to YAML format (to comment out the extra fields that generate lint errors) and adds them to the OpenAPI output via overlays.

Copy link
Contributor

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

API Status Request Response
transform.delete_transform 🟢 10/10 10/10
transform.get_transform_stats 🔴 34/34 33/34
transform.get_transform 🟢 26/26 26/26
transform.reset_transform 🟢 4/4 4/4
transform.schedule_now_transform 🟢 3/3 3/3
transform.start_transform 🟢 29/29 29/29
transform.stop_transform 🟢 16/16 16/16
transform.upgrade_transforms 🟢 2/2 2/2

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

Copy link
Contributor

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

API Status Request Response
transform.delete_transform 🟢 10/10 10/10
transform.get_transform_stats 🔴 34/34 33/34
transform.get_transform 🟢 26/26 26/26
transform.reset_transform 🟢 4/4 4/4
transform.schedule_now_transform 🟢 3/3 3/3
transform.start_transform 🟢 29/29 29/29
transform.stop_transform 🟢 16/16 16/16
transform.upgrade_transforms 🟢 2/2 2/2

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

@lcawl lcawl marked this pull request as ready for review January 30, 2025 04:47
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 0d77821 into main Jan 30, 2025
8 checks passed
@lcawl lcawl deleted the examples-1 branch January 30, 2025 17:48
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-3658-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0d77821160ee0dfeac41b3bdeba5b09bb813ab06
# Push it to GitHub
git push --set-upstream origin backport-3658-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-3658-to-8.x.

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

lcawl commented Jan 30, 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

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