Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix name of self rel in reference documentation

Browse Source 
Closes gh-449
This commit is contained in:
Michael J. Simons
2017-11-06 13:32:43 +01:00
committed by Andy Wilkinson
parent 90c3549f55
commit 92b6268da4
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/docs/asciidoc/documenting-your-api.adoc
View File

@@ -94,7 +94,7 @@ response.
[[documenting-your-api-hypermedia-ignoring-common-links]]
==== Ignoring common links
Rather than documenting links that are common to every response, such as `_self` and
Rather than documenting links that are common to every response, such as `self` and
`curies` when using HAL, you may want to document them once in an overview section and
then ignore them in the rest of your API's documentation. To do so, you can build on the
<<documenting-your-api-reusing-snippets,support for reusing snippets>> to add link

2
docs/src/test/java/com/example/Hypermedia.java
View File

@@ -26,7 +26,7 @@ public class Hypermedia {
// tag::ignore-links[]
public static LinksSnippet links(LinkDescriptor... descriptors) {
return HypermediaDocumentation.links(linkWithRel("_self").ignored().optional(),
return HypermediaDocumentation.links(linkWithRel("self").ignored().optional(),
linkWithRel("curies").ignored()).and(descriptors);
}
// end::ignore-links[]