Skip to content

OpenAPI: update path separator #4199

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 2 commits into from
Apr 9, 2025
Merged

OpenAPI: update path separator #4199

merged 2 commits into from
Apr 9, 2025

Conversation

swallez
Copy link
Member

@swallez swallez commented Apr 5, 2025

Follow-up to #4184 - using the : was wrong, as $ref paths must be RFC-3986 compliant, and : is a reserved char that must be escaped. Furthermore, identifiers in components are further restricted and must match ^[a-zA-Z0-9.-_]+$`

This PR also outputs example values as JSON when they can be successfully parsed instead of just outputting them as strings, as required by the spec Reverted, needs more work (json with multiline strings, ndjson, etc)

@swallez
Copy link
Member Author

swallez commented Apr 5, 2025

@lcawl I added you as reviewer: path separator has been updated again (for good this time). Shouldn't be an issue, but we'd better cross-check that it doesn't impact docs.

@swallez swallez changed the title OpenAPI: update path separator, output examples as json OpenAPI: update path separator Apr 5, 2025
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@swallez swallez force-pushed the fix-openapi-refs branch from e44fb1a to 702d569 Compare April 9, 2025 15:26
@swallez swallez merged commit 5db306e into main Apr 9, 2025
8 checks passed
@swallez swallez deleted the fix-openapi-refs branch April 9, 2025 15:31
Copy link
Contributor

github-actions bot commented Apr 9, 2025

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-4199-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5db306e172f9a495f100a390b2cbc8c5b3733934
# Push it to GitHub
git push --set-upstream origin backport-4199-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-4199-to-8.x.

Copy link
Contributor

github-actions bot commented Apr 9, 2025

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-4199-to-8.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 5db306e172f9a495f100a390b2cbc8c5b3733934
# Push it to GitHub
git push --set-upstream origin backport-4199-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-4199-to-8.18.

Copy link
Contributor

github-actions bot commented Apr 9, 2025

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

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

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