From 773ee0aceac76000f4669fe4abd6aa2e22e0ad44 Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: May 18 2018 19:55:48 +0000 Subject: [docs][api 2] correct spelling of HATEOAS "Hypermedia As The Engine Of Application State (HATEOAS)" --- diff --git a/frontend/docs/api_2/source/index.rst b/frontend/docs/api_2/source/index.rst index 44c3c6c..0f1d437 100644 --- a/frontend/docs/api_2/source/index.rst +++ b/frontend/docs/api_2/source/index.rst @@ -26,12 +26,12 @@ Resources Resources/mock_chroot -HETEOAS +HATEOAS ------- -This API implements HETEOAS_ in the very simple form: each entity is accompanied with a set of relative links -to other related entities. HETEOAS makes API self discoverable, so you don't need to learn how to access sub-resources. +This API implements HATEOAS_ in the very simple form: each entity is accompanied with a set of relative links +to other related entities. HATEOAS makes API self discoverable, so you don't need to learn how to access sub-resources. Here is a short example with the content of API root: **GET /api_2** @@ -60,7 +60,7 @@ Here is a short example with the content of API root: Response structure ------------------ -Each entity is enveloped into a json dict and accompanied with set of HETEOAS references. +Each entity is enveloped into a json dict and accompanied with set of HATEOAS references. GET requests would return the following structures: **Collection structure**: @@ -138,4 +138,4 @@ additional information would be present at key ``data``. .. _BasicAuth: https://en.wikipedia.org/wiki/Basic_access_authentication .. _CoprAPI: https://copr.fedoraproject.org/api -.. _HETEOAS: https://en.wikipedia.org/wiki/HATEOAS +.. _HATEOAS: https://en.wikipedia.org/wiki/HATEOAS