Mercurial > p > roundup > code
changeset 6207:8a21f8ba3065
Doc updates. Mostly formatting.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 27 Jun 2020 20:02:26 -0400 |
| parents | b6f2cf872d2e |
| children | 74784dd531c8 |
| files | doc/rest.txt |
| diffstat | 1 files changed, 7 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/rest.txt Fri Jun 26 18:44:26 2020 -0400 +++ b/doc/rest.txt Sat Jun 27 20:02:26 2020 -0400 @@ -136,11 +136,10 @@ **Sunset**: an http date after which the end point will not be available. This is not returned by current code, but can be used - when `Programming the REST API`_. - -will be returned. It should be used as a hint that the REST endpoint -will be going away. See https://tools.ietf.org/html/rfc8594 for -details on this header and the sunset link type. + when `Programming the REST API`_. It should be used as a hint that + the REST endpoint will be going away. See + https://tools.ietf.org/html/rfc8594 for details on this header and + the sunset link type. Hyperdb Stats ============= @@ -235,10 +234,12 @@ available meta data is described in the documentation for the collections endpoint. -The ``link`` fields implement HATEOS by supplying a url for the +The ``link`` fields implement `HATEOS`_ by supplying a url for the resource represented by that object. The "link" parameter with the value of a url is a special case of the @links parameter. +.. _HATEOS: https://en.wikipedia.org/wiki/HATEOAS + In the @links object, each relationship is a list of full link json objects. These include rel (relationship) and uri properties. In the future this may be extended to include other data like content-type.