Docs move expansion to usage (#1678)

* Move expansion from endpoints to usage * Update references to expansion. * Add a complete list of components that support expansion. * Add change log entry
plone · Aug 8, 2023 · 754b5e5 · 754b5e5
1 parent b9c067e
commit 754b5e5
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 4 deletions.
diff --git a/docs/source/endpoints/index.md b/docs/source/endpoints/index.md
@@ -29,7 +29,6 @@ copymove
 database
 email-notification
 email-send
-expansion
 groups
 history
 linkintegrity

diff --git a/docs/source/endpoints/navroot.md b/docs/source/endpoints/navroot.md
@@ -88,7 +88,7 @@ The response has the language folder information as a navigation root:
 
 ## Expansion
 
-This endpoint can be used with the {doc}`expansion` mechanism which allows getting more information about a content item in one query, avoiding unnecessary requests.
+This endpoint can be used with the {doc}`../usage/expansion` mechanism which allows getting more information about a content item in one query, avoiding unnecessary requests.
 
 If a simple `GET` request is made on the content item, a new entry will be shown on the `@components` entry with the URL of the `@navroot` endpoint.
 

diff --git a/docs/source/endpoints/translations.md b/docs/source/endpoints/translations.md
@@ -125,6 +125,6 @@ This endpoint returns the proper placement for the newly created translation:
 
 ## Expansion
 
-This endpoint can be used with the {doc}`expansion` mechanism which allows getting additional information about a content item in one query, avoiding unnecessary requests.
+This endpoint can be used with the {doc}`../usage/expansion` mechanism which allows getting additional information about a content item in one query, avoiding unnecessary requests.
 
 If a simple `GET` request is done on the content item, a new entry will be shown on the `@components` entry, with the URL of the `@translations` endpoint:
diff --git a/docs/source/endpoints/expansion.md → docs/source/usage/expansion.md b/docs/source/endpoints/expansion.md → docs/source/usage/expansion.md
@@ -17,7 +17,19 @@ This helps the API consumers avoid unnecessary requests.
 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 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 response of any content `GET` request:
+The following is a list of components that support expansion.
+
+-   {doc}`actions <../endpoints/actions>`
+-   {doc}`aliases <../endpoints/aliases>`
+-   {doc}`breadcrumbs <../endpoints/breadcrumbs>`
+-   {doc}`contextnavigation <../endpoints/contextnavigation>`
+-   {doc}`navigation <../endpoints/navigation>`
+-   {doc}`navroot <../endpoints/navroot>`
+-   {doc}`translations <../endpoints/translations>`
+-   {doc}`types <../endpoints/types>`
+-   {doc}`workflow <../endpoints/workflow>`
+
+You can also get the list expandable components by inspecting the `@components` attribute in the response of any content `GET` request, as shown in the following example.
 
 ```http
 GET /plone/front-page HTTP/1.1

diff --git a/docs/source/usage/index.md b/docs/source/usage/index.md
@@ -21,6 +21,7 @@ authentication
 batching
 content
 customization
+expansion
 exploring
 i18n
 serialization

diff --git a/news/1678.documentation b/news/1678.documentation
@@ -0,0 +1 @@
+Move expansion docs from endpoints to usage, and add a list of all expandable components. Fixes #1677. @stevepiercy