plone · stevepiercy · Apr 26, 2022 · Apr 23, 2022 · Apr 23, 2022 · Apr 23, 2022
diff --git a/docs/source/actions.md b/docs/source/actions.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Portal actions can be used to build UI elements that adapt to the available actions, such as displaying only certain tabs for an authenticated user."
+  "property=og:description": "Portal actions can be used to build UI elements that adapt to the available actions, such as displaying only certain tabs for an authenticated user."
+  "property=og:title": "Portal Actions"
+  "keywords": "Plone, plone.restapi, REST, API, Portal Actions"
+---
+
 # Portal Actions
 
 Plone has the concept of configurable actions called `portal_actions`.

diff --git a/docs/source/addons.md b/docs/source/addons.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Add-on product records can be addressed through the @addons endpoint in a Plone site."
+  "property=og:description": "Add-on product records can be addressed through the @addons endpoint in a Plone site."
+  "property=og:title": "Add-ons"
+  "keywords": "Plone, plone.restapi, REST, API, Add-ons"
+---
+
 # Add-ons
 
 Add-on product records can be addressed through the `@addons` endpoint in a Plone site.

diff --git a/docs/source/authentication.md b/docs/source/authentication.md
@@ -1,6 +1,14 @@
+---
+html_meta:
+  "description": "plone.restapi uses PlonePAS for authentication."
+  "property=og:description": "`plone.restapi uses PlonePAS for authentication."
+  "property=og:title": "Authentication"
+  "keywords": "Plone, plone.restapi, REST, API, Authentication, "
+---
+
 # Authentication
 
-`plone.restapi` uses Plone PAS for authentication.
+`plone.restapi` uses [`PlonePAS`](https://github.com/plone/Products.PlonePAS) for authentication.
 
 That means that any authentication method supported by an installed PAS plugin should work, assuming it's an authentication method that makes sense to use with an API.
 

diff --git a/docs/source/batching.md b/docs/source/batching.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Representations of collection-like resources are batched or paginated if the size of the resultset exceeds the batching size."
+  "property=og:description": "Representations of collection-like resources are batched or paginated if the size of the resultset exceeds the batching size"
+  "property=og:title": "Batching"
+  "keywords": "Plone, plone.restapi, REST, API, Batching"
+---
+
 # Batching
 
 Representations of collection-like resources are batched or paginated if the

diff --git a/docs/source/blocks.md b/docs/source/blocks.md
@@ -1,10 +1,16 @@
+---
+html_meta:
+  "description": "The plone.restapi package gives support for Volto blocks providing a Dexterity behavior plone.restapi.behaviors.IBlocks."
+  "property=og:description": "The plone.restapi package gives support for Volto blocks providing a Dexterity behavior plone.restapi.behaviors.IBlocks."
+  "property=og:title": "Volto Blocks support"
+  "keywords": "Plone, plone.restapi, REST, API, Volto, Blocks, support"
+---
+
 # Volto Blocks support
 
-```{note}
 The `plone.restapi` package gives support for Volto blocks providing a Dexterity behavior `plone.restapi.behaviors.IBlocks`.
 It is used to enable Volto blocks in any content type.
 Volto then renders the blocks engine for all the content types that have this behavior enabled.
-```
 
 
 ## Retrieving blocks on a content object

diff --git a/docs/source/breadcrumbs.md b/docs/source/breadcrumbs.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Get the breadcrumbs for the current page with plone.restapi."
+  "property=og:description": "Get the breadcrumbs for the current page with plone.restapi."
+  "property=og:title": "Breadcrumbs"
+  "keywords": "Plone, plone.restapi, REST, API, Breadcrumbs"
+---
+
 (breadcrumbs)=
 
 # Breadcrumbs

diff --git a/docs/source/comments.md b/docs/source/comments.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Plone offers to users a feature to post comments on any content object with plone.app.discussion."
+  "property=og:description": "Plone offers to users a feature to post comments on any content object with plone.app.discussion."
+  "property=og:title": "Comments"
+  "keywords": "Plone, plone.restapi, REST, API, Comments, plone.app.discussion"
+---
+
 # Comments
 
 Plone offers to users a feature to post comments on any content object with `plone.app.discussion`.

diff --git a/docs/source/content-negotiation.md b/docs/source/content-negotiation.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Content negotiation is a mechanism defined in the HTTP specification that makes it possible to serve different versions of a document (or more generally, a resource representation) at the same URI, so that user agents can specify which version fit their capabilities the best."
+  "property=og:description": "Content negotiation is a mechanism defined in the HTTP specification that makes it possible to serve different versions of a document (or more generally, a resource representation) at the same URI, so that user agents can specify which version fit their capabilities the best."
+  "property=og:title": "Content Negotiation"
+  "keywords": "Plone, plone.restapi, REST, API, Content, Negotiation"
+---
+
 # Content Negotiation
 
 [Content negotiation](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3) is a mechanism defined in the [HTTP specification](https://datatracker.ietf.org/doc/html/rfc7231) that makes it possible to serve different versions of a document (or more generally, a resource representation) at the same URI, so that user agents can specify which version fit their capabilities the best.

diff --git a/docs/source/content.md b/docs/source/content.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "plone.restapi not only exposes content objects via a RESTful API, but the API consumer can create, read, update, and delete a content object."
+  "property=og:description": "plone.restapi not only exposes content objects via a RESTful API, but the API consumer can create, read, update, and delete a content object."
+  "property=og:title": "Content Manipulation"
+  "keywords": "Plone, plone.restapi, REST, API, Content, Manipulation"
+---
+
 # Content Manipulation
 
 `plone.restapi` does not only expose content objects via a RESTful API.

diff --git a/docs/source/contextnavigation.md b/docs/source/contextnavigation.md
@@ -1,3 +1,13 @@
+---
+html_meta:
+  "description": "The @contextnavigation endpoint uses the same semantics as the classic Plone navigation portlet. Instead of storing the portlet configuration in a portlet assignment storage, you can pass these as
+parameters to the service or expand the component."
+  "property=og:description": "The @contextnavigation endpoint uses the same semantics as the classic Plone navigation portlet. Instead of storing the portlet configuration in a portlet assignment storage, you can pass these as
+parameters to the service or expand the component."
+  "property=og:title": "Context Navigation"
+  "keywords": "Plone, plone.restapi, REST, API, Context, Navigation"
+---
+
 (contextnavigation)=
 
 # Context Navigation

diff --git a/docs/source/contributing.md b/docs/source/contributing.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Contributing to plone.restapi"
+  "property=og:description": "Contributing to plone.restapi"
+  "property=og:title": "Contributing to plone.restapi"
+  "keywords": "Plone, plone.restapi, REST, API, Contributing, documentation"
+---
+
 # Contributing to plone.restapi
 
 

diff --git a/docs/source/controlpanels.md b/docs/source/controlpanels.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Control panels in Plone allow you to configure the global site setup of a Plone site. The @controlpanels endpoint in plone.restapi allows you to list all existing control panels in a Plone site, and to retrieve or edit the settings of a specific control panel."
+  "property=og:description": "Control panels in Plone allow you to configure the global site setup of a Plone site. The @controlpanels endpoint in plone.restapi allows you to list all existing control panels in a Plone site, and to retrieve or edit the settings of a specific control panel."
+  "property=og:title": "Control Panels"
+  "keywords": "Plone, plone.restapi, REST, API, Control, Panels"
+---
+
 # Control Panels
 
 Control panels in Plone allow you to configure the global site setup of a Plone site.

diff --git a/docs/source/conventions.md b/docs/source/conventions.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Naming convention for REST API resources and endpoints."
+  "property=og:description": "Naming convention for REST API resources and endpoints."
+  "property=og:title": "Conventions"
+  "keywords": "Plone, plone.restapi, REST, API, Conventions"
+---
+
 # Conventions
 
 

diff --git a/docs/source/copymove.md b/docs/source/copymove.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "To copy a content object, use the /@copy endpoint at the destination's URL with the source object specified in the request body. Similarly use the /@move endpoint to move an object."
+  "property=og:description": "To copy a content object, use the /@copy endpoint at the destination's URL with the source object specified in the request body. Similarly use the /@move endpoint to move an object."
+  "property=og:title": "Copy and Move"
+  "keywords": "Plone, plone.restapi, REST, API, Copy, Move"
+---
+
 # Copy and Move
 
 

diff --git a/docs/source/customization.md b/docs/source/customization.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Customizing the API with the IFieldSerializer adapter."
+  "property=og:description": "Customizing the API with the IFieldSerializer adapter."
+  "property=og:title": "Customizing the API"
+  "keywords": "Plone, plone.restapi, REST, API, Customizing, IFieldSerializer, adapter"
+---
+
 # Customizing the API
 
 

diff --git a/docs/source/database.md b/docs/source/database.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "The @database endpoint exposes system information about the Plone database (ZODB)."
+  "property=og:description": "The @database endpoint exposes system information about the Plone database (ZODB)."
+  "property=og:title": "Database"
+  "keywords": "Plone, plone.restapi, REST, API, Database"
+---
+
 (database)=
 
 # Database

diff --git a/docs/source/email-notification.md b/docs/source/email-notification.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Plone allows the user to contact the site owner via a form on the website which sends an email notification."
+  "property=og:description": "Plone allows the user to contact the site owner via a form on the website which sends an email notification."
+  "property=og:title": "Email Notification"
+  "keywords": "Plone, plone.restapi, REST, API, Email, Notification"
+---
+
 # Email Notification
 
 

diff --git a/docs/source/email-send.md b/docs/source/email-send.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "To send an email to an arbitrary email address use the /@email-send endpoint."
+  "property=og:description": "To send an email to an arbitrary email address use the /@email-send endpoint."
+  "property=og:title": "Email Send"
+  "keywords": "Plone, plone.restapi, REST, API, Email, Send"
+---
+
 # Email Send
 
 

diff --git a/docs/source/expansion.md b/docs/source/expansion.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Expansion is a mechanism in plone.restapi to embed additional components—such as navigation, breadcrumbs, schema, or workflows—within the main content response. This helps the API consumers avoid unnecessary requests."
+  "property=og:description": "Expansion is a mechanism in plone.restapi to embed additional components—such as navigation, breadcrumbs, schema, or workflows—within the main content response. This helps the API consumers avoid unnecessary requests."
+  "property=og:title": "Expansion"
+  "keywords": "Plone, plone.restapi, REST, API, Expansion"
+---
+
 (expansion-label)=
 
 # Expansion

diff --git a/docs/source/exploring.md b/docs/source/exploring.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "To discover the API interactively, using Postman is recommended."
+  "property=og:description": "To discover the API interactively, using Postman is recommended."
+  "property=og:title": "Explore the API using Postman"
+  "keywords": "Plone, plone.restapi, REST, API, Explore, Postman"
+---
+
 (exploring-api-postman-onboarding)=
 
 # Explore the API using Postman

diff --git a/docs/source/glossary.md b/docs/source/glossary.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "plone.restapi Glossary"
+  "property=og:description": "plone.restapi Glossary"
+  "property=og:title": "Glossary"
+  "keywords": "Plone, plone.restapi, REST, API, Glossary"
+---
+
 # Glossary
 
 ```{glossary}

diff --git a/docs/source/groups.md b/docs/source/groups.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Available groups in a Plone site can be created, queried, updated, and deleted by interacting with the /@groups endpoint on the portal root."
+  "property=og:description": "Available groups in a Plone site can be created, queried, updated, and deleted by interacting with the /@groups endpoint on the portal root."
+  "property=og:title": "Groups"
+  "keywords": "Plone, plone.restapi, REST, API, Groups"
+---
+
 # Groups
 
 Available groups in a Plone site can be created, queried, updated, and deleted by interacting with the `/@groups` endpoint on the portal root.

diff --git a/docs/source/history.md b/docs/source/history.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "The @history endpoint exposes history and versioning information on previous versions of the content."
+  "property=og:description": "The @history endpoint exposes history and versioning information on previous versions of the content."
+  "property=og:title": "History"
+  "keywords": "Plone, plone.restapi, REST, API, History"
+---
+
 # History
 
 The `@history` endpoint exposes history and versioning information on previous versions of the content.

diff --git a/docs/source/http-status-codes.md b/docs/source/http-status-codes.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "A list of HTTP status codes that are used in plone.restapi."
+  "property=og:description": "A list of HTTP status codes that are used in plone.restapi."
+  "property=og:title": "HTTP Status Codes"
+  "keywords": "Plone, plone.restapi, REST, API, HTTP, Status, Codes"
+---
+
 # HTTP Status Codes
 
 This is the list of HTTP status codes that are used in `plone.restapi`.

diff --git a/docs/source/i18n.md b/docs/source/i18n.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Plone provides user-interface translations, or internationalization, using the plone.app.locales package."
+  "property=og:description": "Plone provides user-interface translations, or internationalization, using the plone.app.locales package."
+  "property=og:title": "i18n: internationalization of screen messages"
+  "keywords": "Plone, plone.restapi, REST, API, i18n, internationalization, screen, messages"
+---
+
 # i18n: internationalization of screen messages
 
 Plone already provides user-interface translations using the [`plone.app.locales`](https://pypi.org/project/plone.app.locales/) packages.

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "A RESTful API for Plone."
+  "property=og:description": "A RESTful API for Plone."
+  "property=og:title": "REST API"
+  "keywords": "Plone, plone.restapi, REST, API"
+---
+
 % plone.restapi documentation master file, created by
 % sphinx-quickstart on Mon Apr 28 13:04:12 2014.
 % You can adapt this file completely to your liking, but it should at least

diff --git a/docs/source/introduction.md b/docs/source/introduction.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "A hypermedia API provides an entry point to the API, which contains hyperlinks the clients can follow."
+  "property=og:description": "A hypermedia API provides an entry point to the API, which contains hyperlinks the clients can follow."
+  "property=og:title": "Introduction"
+  "keywords": "Plone, plone.restapi, REST, API, Introduction"
+---
+
 # Introduction
 
 ```{sidebar} API Browser Quick Guide

diff --git a/docs/source/locking.md b/docs/source/locking.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Locking is a mechanism to prevent users from accidentally overriding each other's changes."
+  "property=og:description": "Locking is a mechanism to prevent users from accidentally overriding each other's changes."
+  "property=og:title": "Locking"
+  "keywords": "Plone, plone.restapi, REST, API, Locking"
+---
+
 # Locking
 
 Locking is a mechanism to prevent users from accidentally overriding each other's changes.

diff --git a/docs/source/navigation.md b/docs/source/navigation.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "Get the top-level navigation items or navigation item tree with the navigation endpoint."
+  "property=og:description": "Get the top-level navigation items or navigation item tree with the navigation endpoint."
+  "property=og:title": "Navigation"
+  "keywords": "Plone, plone.restapi, REST, API, Navigation"
+---
+
 (navigation)=
 
 # Navigation

diff --git a/docs/source/plone-content.md b/docs/source/plone-content.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "A list of all standard Plone content representations with sample requests and responses."
+  "property=og:description": "A list of all standard Plone content representations with sample requests and responses."
+  "property=og:title": "Plone Content"
+  "keywords": "Plone, plone.restapi, REST, API, Plone, Content"
+---
+
 # Plone Content
 
 How to get all standard Plone content representations.

diff --git a/docs/source/principals.md b/docs/source/principals.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "The principal endpoint will search for all the available principals in the local PAS plugins when given a query string. We define a principal as any user or group in the system."
+  "property=og:description": "The principal endpoint will search for all the available principals in the local PAS plugins when given a query string. We define a principal as any user or group in the system."
+  "property=og:title": "Principals"
+  "keywords": "Plone, plone.restapi, REST, API, Principals"
+---
+
 # Principals
 
 This endpoint will search for all the available principals in the local PAS plugins when given a query string.

diff --git a/docs/source/querystring.md b/docs/source/querystring.md
@@ -1,3 +1,11 @@
+---
+html_meta:
+  "description": "The @querystring endpoint returns the querystring configuration of plone.app.querystring."
+  "property=og:description": "The @querystring endpoint returns the querystring configuration of plone.app.querystring."
+  "property=og:title": "Querystring"
+  "keywords": "Plone, plone.restapi, REST, API, Querystring"
+---
+
 # Querystring
 
 The `@querystring` endpoint returns the `querystring` configuration of `plone.app.querystring`.