spring-projects / spring-projects/spring-hateoas

Provide an example output in the affordances section

Open
#1,316 2 comments 0 reactions 1 assignee View on GitHub

@gregturn is already working on this.

Since Jul 1, 2020.

in: documentation
Dominant language
Java
Stars
1.1k
Forks
476
No merged PRs in 30d

Description

Section 3.3 Affordances is unclear, it explains how to to implement affordances but not what an affordance is. Suggest you add example output Json that is returned from the findOne method in example 13. That will make the text clearer much clearer.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.