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

2.x.x - Change parameter capture syntax to same as OpenAPI #331

Merged
merged 1 commit into from
Jan 11, 2024

Conversation

adam-fowler
Copy link
Member

In v1.0 to support prefix and suffix URI parameters we added a new syntax for defining extracted parameters ${parameter}. Since then the OpenAPI runtime has come on line and it seems more sensible to duplicate the syntax OpenAPI has {parameter}. ie remove the $

Copy link
Contributor

@Joannis Joannis left a comment

Choose a reason for hiding this comment

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

I don't mind this change, it makes the ecosystem more consistent. My main worry is about needing a clear note in docs for migrating older users

@adam-fowler
Copy link
Member Author

I don't mind this change, it makes the ecosystem more consistent. My main worry is about needing a clear note in docs for migrating older users

I understand your concern. But being consistent is probably a good thing and if there is any time to change this kind of thing it is a major release. We can make sure to be clear about this change in the release notes and any migration docs.

@adam-fowler adam-fowler changed the title Change parameter capture syntax to same as OpenAPI 2.x.x - Change parameter capture syntax to same as OpenAPI Jan 8, 2024
@adam-fowler
Copy link
Member Author

@tib given you were involved in the original decision regarding prefix and suffix capture parameters. How do you feel about changing it from ${param} to {param} to be more consistent with open api.

Copy link
Contributor

@Joannis Joannis left a comment

Choose a reason for hiding this comment

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

I'm for the change, let's make an issue for the (migration) docs though

Copy link

codecov bot commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1e3b93d) 83.08% compared to head (15eb3d1) 83.07%.

Additional details and impacted files
@@            Coverage Diff             @@
##            2.x.x     #331      +/-   ##
==========================================
- Coverage   83.08%   83.07%   -0.02%     
==========================================
  Files          92       92              
  Lines        5037     5034       -3     
==========================================
- Hits         4185     4182       -3     
  Misses        852      852              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@adam-fowler adam-fowler merged commit 0b09c38 into 2.x.x Jan 11, 2024
4 of 5 checks passed
@adam-fowler adam-fowler deleted the openapi-style-capture branch January 11, 2024 07:09
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

Successfully merging this pull request may close these issues.

None yet

2 participants