Response.created() and ResponseBuilder.location() have the conflicting documentation about relative URIs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 400
- Forks
- 143
- PR merge metrics
- No merged PRs in 30d
Description
We've had an issue opened with a reference to Response.created() which recommends the use of UriInfo.getRequestUri to resolve relative references, while ResponseBuilder.location to which Response.created() delegates recommends the use of UriInfo.getBaseUri.
Either Response.created() or ResponseBuilder.location() API docs need to be fixed.
IMHO it's actually be better be done for 2.0.2
#### Affected Versions
[2.0.1]
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the API documentation for Response.created() and ResponseBuilder.location(), focusing on their guidance for resolving relative URIs with UriInfo. Update the conflicting wording so both methods give consistent guidance, then verify that the published API documentation no longer contradicts itself.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100