plone.restapi/expansion: Add docs for breadcrumbs and navigation; Add deprecation mes
Timo Stollenwerk <jenkins-z4DKO/[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.cvs |
|---|---|
| Message-ID | <[email protected]> |
Repository: plone.restapi Branch: refs/heads/expansion Date: 2017-07-16T12:05:47+02:00 Author: Timo Stollenwerk (tisto) <[email protected]> Commit: https://github.com/plone/plone.restapi/commit/ba9aaba8173d6998b2e7db3c93b7702d3b602272 Add docs for breadcrumbs and navigation; Add deprecation message to components docs. Files changed: A docs/source/breadcrumbs.rst A docs/source/navigation.rst M docs/source/components.rst M docs/source/index.rst diff --git a/docs/source/breadcrumbs.rst b/docs/source/breadcrumbs.rst new file mode 100644 index 00000000..f377ff30 --- /dev/null +++ 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 index f052d35d..49db7373 100644 --- 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 index 158a3327..ea4278fd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -35,6 +35,8 @@ Contents groups roles components + breadcrumbs + navigation serialization searching tusupload diff --git a/docs/source/navigation.rst b/docs/source/navigation.rst new file mode 100644 index 00000000..8027e2d6 --- /dev/null +++ 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 ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot