-
Notifications
You must be signed in to change notification settings - Fork 7
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
Quotation marks in example values of the field filter
cause a syntax error in Swagger UI
#111
Comments
@bonaparten please also give an example of the request or a link to the position where you found it :) I checked it now and indeed, the escaping of the double quotes is missing in this swagger example (you'd have to open up then the 'count' tab to get to the correct endpoint..). But is also seems like now even with escaping, the request does not run through, e.g. look at this example: Am I doing something wrong here @tyrasd? |
I think the quote marks should not be there in the first place. this would be the correct filter: |
Ok yes I am blind.. the marks would just be around the key, not the whole tag. And true, they would not be necessary for this example. Still, in the docs it's recommended to escape the quotes, but e.g. the following request is not working for me: |
Do you mean here: https://docs.ohsome.org/ohsome-api/v1/filter.html#special-characters-whitespace?
This refers to when you want to search for tags which have a
//edit
escape sequences only work in strings with quote marks. See the documentation:
So, if you want to filter by the tag key
//edit2:
No, everything works as documented. Let me repeat: |
I see.. yes that makes sense, sorry for the missunderstanding. So we would only have to fix then the suggested filter value in the swagger example. |
In Swagger UI, in the endpoint
/elements/count/ratio
quotation marks in the example value of the fieldfilter2
cause a syntax error.We should also take a look at the example values in other endpoints.
The text was updated successfully, but these errors were encountered: