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.

Sign up for GitHub

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

Jump to bottom

API doc says "curieProvider can be null" but it is required #1449

Closed
andreaskanzlers5555 opened this issue Jan 28, 2021 · 1 comment
Closed

API doc says "curieProvider can be null" but it is required #1449

andreaskanzlers5555 opened this issue Jan 28, 2021 · 1 comment
Assignees
@odrotbohm
Labels
in: documentation Reference documentation in: mediatypes Media type related functionality type: task
Milestone
1.2.4

Comments

@andreaskanzlers5555
Copy link

API Documentation of
org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalHandlerInstantiator
states that in the constructor
"curieProvider - can be null."
(https://docs.spring.io/spring-hateoas/docs/1.2.3/api/)

But source code requires it.
@odrotbohm
Copy link
Member

This has been corrected with #1447 for 1.3 already. I'll make sure, we're gonna have the Javadoc corrected for 1.2.x as well.

@odrotbohm odrotbohm self-assigned this Feb 9, 2021
@odrotbohm odrotbohm added in: documentation Reference documentation in: mediatypes Media type related functionality type: task labels Feb 9, 2021
@odrotbohm odrotbohm added this to the 1.2.4 milestone Feb 9, 2021
odrotbohm added a commit that referenced this issue Feb 16, 2021
@odrotbohm
#1449 - Polished Javadoc on HalHandlerInstantiator.
be99b85
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@odrotbohm odrotbohm

Labels
in: documentation Reference documentation in: mediatypes Media type related functionality type: task
Projects
None yet
Milestone
1.2.4
Development

No branches or pull requests
2 participants
@odrotbohm @andreaskanzlers5555