Conversation
The link to the Spring "understanding HATEOAS" guide pointed to a tree view in the spring-guides/understanding repository, which has since been archived to spring-attic/understanding and is no longer published as a rendered guide. Point the link directly at the README.md file so it renders correctly on GitHub. Closes spring-projectsGH-1751. Signed-off-by: Gaalbu <gabrielalbuquerquealencar@gmail.com>
spring-projects-issues
added
the
status: waiting-for-triage
Author
|
Friendly ping — this PR is still waiting for triage. Happy to make any adjustments needed. |
ruthst00
reviewed
Sep 16, 2026
| === Resource Discoverability | ||
|
|
||
| A core principle of https://github.com/spring-guides/understanding/tree/master/hateoas[HATEOAS] is that resources should be discoverable through the publication of links that point to the available resources. There are a few competing de-facto standards of how to represent links in JSON. By default, Spring Data REST uses https://tools.ietf.org/html/draft-kelly-json-hal[HAL] to render responses. HAL defines the links to be contained in a property of the returned document. | ||
| A core principle of https://github.com/spring-attic/understanding/blob/master/hateoas/README.md[HATEOAS] is that resources should be discoverable through the publication of links that point to the available resources. There are a few competing de-facto standards of how to represent links in JSON. By default, Spring Data REST uses https://tools.ietf.org/html/draft-kelly-json-hal[HAL] to render responses. HAL defines the links to be contained in a property of the returned document. |
There was a problem hiding this comment.
The fix is correct and an improvement over the current state. The new URL resolves properly and renders readable content. However, the ideal fix would replace the link with a reference to an actively maintained resource (e.g., Spring HATEOAS docs or Wikipedia) rather than an archived GitHub repository. If the team is comfortable linking to spring-attic, this is ready to merge as-is. Otherwise, consider updating the link target to a more durable reference before merging, such as:
- The Spring HATEOAS reference docs — which is actively maintained and part of the Spring ecosystem.
- Or the Wikipedia HATEOAS article as a neutral, stable reference.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The HATEOAS reference in the "Resource Discoverability" section linked to a tree view of
spring-guides/understanding/hateoas. That repository has since been archived and moved tospring-attic/understanding, and the directory is no longer published as a rendered guide (it's just a source folder containing aREADME.md).This updates the link to point directly at the
README.mdfile in the currentspring-attic/understandinglocation, so it renders correctly on GitHub.Closes gh-1751.