plone.restapi/translate-workflow-titles: Minor improvement in expansion docs.
Thomas Buchberger <jenkins-z4DKO/[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.cvs |
|---|---|
| Message-ID | <[email protected]> |
Repository: plone.restapi Branch: refs/heads/translate-workflow-titles Date: 2017-07-25T11:48:31+02:00 Author: Timo Stollenwerk (tisto) <[email protected]> Commit: https://github.com/plone/plone.restapi/commit/6f74d48e849c1226eb3281c6c47bd4ad7d4a6e53 Minor improvement in expansion docs. Files changed: M docs/source/expansion.rst diff --git a/docs/source/expansion.rst b/docs/source/expansion.rst index b93e850a..d62a1bfa 100644 --- a/docs/source/expansion.rst +++ b/docs/source/expansion.rst @@ -7,7 +7,8 @@ response. This helps the API consumers to avoid unneccesary request. Say you want to show a document in Plone together with the breadcrumbs and a workflow switcher. Instead of doing three individual requests, you can just -expand the breadcrumbs and the workflow "components". +expand the breadcrumbs and the workflow "components" within the document GET +request. The list of expandable components is listed in the "@components" attribute in the reponse of any content GET request:: @@ -110,4 +111,4 @@ Request: Response: .. literalinclude:: _json/expansion.resp - :language: http \ No newline at end of file + :language: http ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot