Skip to content

Commit 090754b

Browse files
committed
Doc updates. Mostly formatting.
1 parent e5d72ec commit 090754b

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/rest.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,10 @@ If the client has requested a deprecated API endpoint, the header:
136136

137137
**Sunset**: an http date after which the end point will not be
138138
available. This is not returned by current code, but can be used
139-
when `Programming the REST API`_.
140-
141-
will be returned. It should be used as a hint that the REST endpoint
142-
will be going away. See https://tools.ietf.org/html/rfc8594 for
143-
details on this header and the sunset link type.
139+
when `Programming the REST API`_. It should be used as a hint that
140+
the REST endpoint will be going away. See
141+
https://tools.ietf.org/html/rfc8594 for details on this header and
142+
the sunset link type.
144143

145144
Hyperdb Stats
146145
=============
@@ -235,10 +234,12 @@ well as a ``collections`` list of objects::
235234
available meta data is described in the documentation for the
236235
collections endpoint.
237236

238-
The ``link`` fields implement HATEOS by supplying a url for the
237+
The ``link`` fields implement `HATEOS`_ by supplying a url for the
239238
resource represented by that object. The "link" parameter with the
240239
value of a url is a special case of the @links parameter.
241240

241+
.. _HATEOS: https://en.wikipedia.org/wiki/HATEOAS
242+
242243
In the @links object, each relationship is a list of full link json
243244
objects. These include rel (relationship) and uri properties. In the
244245
future this may be extended to include other data like content-type.

0 commit comments

Comments
 (0)