Skip to content

Fix broken HATEOAS link in repository-resources.adoc #2588

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

Open
Gaalbu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix broken HATEOAS link in repository-resources.adoc #2588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/antora/modules/ROOT/pages/repository-resources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Read more on this in the detailed description of xref:repository-resources.adoc#
[[repository-resources.resource-discoverability]]
=== 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.

@ruthst00 ruthst00 Sep 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:


Resource discovery starts at the top level of the application. By issuing a request to the root URL under which the Spring Data REST application is deployed, the client can extract, from the returned JSON object, a set of links that represent the next level of resources that are available to the client.

Expand Down
Loading