Skip to content

Commit 92b6268

Browse files
michael-simonswilkinsona
authored andcommitted
Fix name of self rel in reference documentation
Closes gh-449
1 parent 90c3549 commit 92b6268

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/src/docs/asciidoc/documenting-your-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ response.
9494
[[documenting-your-api-hypermedia-ignoring-common-links]]
9595
==== Ignoring common links
9696

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

docs/src/test/java/com/example/Hypermedia.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class Hypermedia {
2626

2727
// tag::ignore-links[]
2828
public static LinksSnippet links(LinkDescriptor... descriptors) {
29-
return HypermediaDocumentation.links(linkWithRel("_self").ignored().optional(),
29+
return HypermediaDocumentation.links(linkWithRel("self").ignored().optional(),
3030
linkWithRel("curies").ignored()).and(descriptors);
3131
}
3232
// end::ignore-links[]

0 commit comments

Comments
 (0)