Add docs for breadcrumbs and navigation; Add deprecation message to c…

…omponents docs.
plone · Apr 17, 2017 · 70481ec · 70481ec
1 parent 061a562
commit 70481ec
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/docs/source/breadcrumbs.rst b/docs/source/breadcrumbs.rst
@@ -0,0 +1,12 @@
+Breadcrumbs
+===========
+
+Getting the breadcrumbs for the current page:
+
+..  http:example:: curl httpie python-requests
+    :request: _json/breadcrumbs.req
+
+Example response:
+
+.. literalinclude:: _json/breadcrumbs.resp
+   :language: http
diff --git a/docs/source/components.rst b/docs/source/components.rst
@@ -1,8 +1,13 @@
 Components
 ==========
 
+.. warning::
+   The @components endpoint is deprecated and will be removed in plone.restapi
+   1.0b1. :doc:`breadcrumbs` and :doc:`navigation` are now top-level endpoints.
+
 How to get pages components (i.e. everything but the main content), like breadcrumbs, navigations, actions, etc.
 
+
 Breadcrumbs
 -----------
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -30,6 +30,8 @@ Contents
    types
    users
    components
+   breadcrumbs
+   navigation
    serialization
    searching
    vocabularies

diff --git a/docs/source/navigation.rst b/docs/source/navigation.rst
@@ -0,0 +1,12 @@
+Navigation
+==========
+
+Getting the top navigation items:
+
+..  http:example:: curl httpie python-requests
+    :request: _json/navigation.req
+
+Example response:
+
+.. literalinclude:: _json/navigation.resp
+   :language: http