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

Clarify methods that accept a "URI". #65

Open
garretwilson opened this issue Sep 27, 2017 · 1 comment
Open

Clarify methods that accept a "URI". #65

garretwilson opened this issue Sep 27, 2017 · 1 comment

Comments

@garretwilson
Copy link

I see things like Condition.get(String uri) which say that they accept a URI. But the examples show things like get("/demo"), which is not a URI at all --- it's a path. And there's no documentation about encoding at all.

Yes I know that Request.getRequestURI() really returns a path, but that's an old API and it was named badly to begin with. There are so many variations of things that are partial paths, full paths, encoded, raw, etc.; see https://stackoverflow.com/a/21046620/421049 for just a taste.

So it would really help if the API documentation to indicate:

  • Whether the argument should be a URI or a path.
  • If a path, whether it should be an absolute path or relative to some webapp.
  • Whether the path should be URI-encoded or not.
@mkotsur
Copy link
Owner

mkotsur commented Sep 28, 2017

Ok, very good point. Would you like to contribute to this via a PR?

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