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

Path parameters with colons not OpenAPI 3.1 compliant? #21

Open
elrubio opened this issue Sep 20, 2024 · 1 comment
Open

Path parameters with colons not OpenAPI 3.1 compliant? #21

elrubio opened this issue Sep 20, 2024 · 1 comment
Assignees

Comments

@elrubio
Copy link

elrubio commented Sep 20, 2024

First off, thanks a lot for this super-useful tool! 🙏🏼

When I passed my generated spec file to my code generator, it complained about invalid path parameters containing colons.

Indeed, the OpenAPI specs only seem to allow curly braces and don't mention colons:

3.2 Path Templating

Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters.

After changing my spec file accordingly, code generation worked.

Is there a specific reason your generated documents deviate from the OpenAPI spec? Could this be changed to meet the standard?

@AndrewWalsh AndrewWalsh self-assigned this Sep 20, 2024
@AndrewWalsh
Copy link
Owner

Thanks @elrubio, that's definitely a bug, I kind of hacked this together.

I will address this along with the other PR next week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants