From 92b6268da42398b1c7a83bfaa4b7ee60fd31e242 Mon Sep 17 00:00:00 2001 From: "Michael J. Simons" Date: Mon, 6 Nov 2017 13:32:43 +0100 Subject: [PATCH] Fix name of self rel in reference documentation Closes gh-449 --- docs/src/docs/asciidoc/documenting-your-api.adoc | 2 +- docs/src/test/java/com/example/Hypermedia.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/docs/asciidoc/documenting-your-api.adoc b/docs/src/docs/asciidoc/documenting-your-api.adoc index 8c358885..0299505b 100644 --- a/docs/src/docs/asciidoc/documenting-your-api.adoc +++ b/docs/src/docs/asciidoc/documenting-your-api.adoc @@ -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 <> to add link diff --git a/docs/src/test/java/com/example/Hypermedia.java b/docs/src/test/java/com/example/Hypermedia.java index 10f16868..87cfb376 100644 --- a/docs/src/test/java/com/example/Hypermedia.java +++ b/docs/src/test/java/com/example/Hypermedia.java @@ -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[]