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

Merge pull request #449 from Michael Simons

Browse Source 
* gh-449:
  Fix name of self rel in reference documentation
This commit is contained in:
Andy Wilkinson
2017-11-11 18:58:18 +00:00
parent 90c3549f55 92b6268da4
commit 4d710d9143
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[]