jakartaee / jakartaee/rest

Review and update if needed API docs using the word "resolve"

Open
#489 4 comments 0 reactions 1 assignee Claimed by @spericas View on GitHub
Component: model api
Dominant language
Java
Stars
400
Forks
143
PR merge metrics
No merged PRs in 30d

Description

ResponseBuilder, UriInfo and possibly other API docs use (URI) "resolve" in some cases. For example, ResponseBuilder.location(), etc.
Now that JAX-RS 2.0 has its own URI resolution support, it is becoming a bit confusing what exactly is meant by "resolve".
For example, given "http://a/b" and a relative "b" supplied to ResponseBuilder.location(), most likely the users would expect "http://a/b/b" given that it is a new Location. However, URI Resolution will produce "http://a/b/".

IMHO it will help avoiding lots of confusion going forward if various API referring to "resolve" get clarified what is meant, the concatenation or an actual resolution.
#### Affected Versions
[2.0.1]

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.