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 allow undocumented formats #297

Open
sfackler opened this issue May 3, 2019 · 2 comments
Open

Path parameters allow undocumented formats #297

sfackler opened this issue May 3, 2019 · 2 comments

Comments

@sfackler
Copy link
Member

sfackler commented May 3, 2019

The HTTP path parser appears to allow three different parameter syntaxes: {argName}, {argName:.*} and {argName:.+}: https://github.com/palantir/conjure/blob/master/conjure-core/src/main/java/com/palantir/conjure/defs/validator/HttpPathValidator.java#L42-L45

However, only the first of these is actually discussed in the specification: (https://github.com/palantir/conjure/blob/master/docs/spec/conjure_definitions.md#path-parameters

@ferozco
Copy link
Contributor

ferozco commented May 8, 2019

I remember seeing an internal discussion where the syntax you provide was explicitly omitted from the spec (but left in the code) because we wanted to remove it but did not want to break current users. @uschi2000 may have more context here

@sfackler
Copy link
Member Author

sfackler commented May 8, 2019

It is in conjure-java's example service, which is where I noticed it: https://github.com/palantir/conjure-java/blob/develop/conjure-java-core/src/test/resources/example-service.yml#L162

Probably worth logging a deprecation warning at least if we want to get rid of it?

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