diff --git a/docs/source/actions.md b/docs/source/actions.md index e36ed5d006..f3a38986d2 100644 --- 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 index cb50261271..2ba3b7ddec 100644 --- 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 index 3603919d7b..69d2b540bd 100644 --- 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 index 078ba16ebe..536c0d07bd 100644 --- 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 index 1946085c52..b652175bc5 100644 --- 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 index ec32483de1..82f8dc30ef 100644 --- 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 index 09b0da0d4b..a1f32157de 100644 --- 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 index 9f7390cd69..3c9c50691e 100644 --- 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 index 813171f722..6d5a3458f4 100644 --- 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 index e1089e79b7..88406c2d84 100644 --- 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 index 974251637b..6ff32575b5 100644 --- 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 index 88a1e46f66..8b2c64e713 100644 --- 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 index ec83d6399d..bf7e3d5526 100644 --- 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 index 75e1726051..63a1ae3b6b 100644 --- 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 index 6d107a8731..e3028ca8dc 100644 --- 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 index b63c81d3a3..47d72dbe44 100644 --- 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 index baee55c19e..95f2e321bc 100644 --- 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 index 661a529269..810b181dd0 100644 --- 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 index 74ebe274e8..36f69b003a 100644 --- 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 index 0095551470..000d97aa71 100644 --- 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 index f99d17af82..53354430c3 100644 --- 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 index d476551c52..ed229cbe2d 100644 --- 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 index 721dd9fdd5..4ed5aa7950 100644 --- 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 index 7852825067..3655d54d48 100644 --- 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 index 6f9e6cbdda..46642e50b1 100644 --- 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 index 5eedd5a33a..a2ba0cd3bf 100644 --- 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 index ddc592217e..42fe268a11 100644 --- 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 index e9291f4b8e..120bd64c09 100644 --- 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 index c96d002e6c..f82b5e2e4e 100644 --- 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 index 24e491caf8..f25b746274 100644 --- 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 index cf952379d5..85d2d4557b 100644 --- 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 index 174450391f..02bba55c06 100644 --- 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`. diff --git a/docs/source/querystringsearch.md b/docs/source/querystringsearch.md index 1079a2a42e..74e26f7bf9 100644 --- a/docs/source/querystringsearch.md +++ b/docs/source/querystringsearch.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "The @querystring-search endpoint returns search results that can be filtered on search criteria." + "property=og:description": "The @querystring-search endpoint returns search results that can be filtered on search criteria." + "property=og:title": "Querystring Search" + "keywords": "Plone, plone.restapi, REST, API, Querystring, Search" +--- + # Querystring Search The `@querystring-search` endpoint returns search results that can be filtered on search criteria. diff --git a/docs/source/registry.md b/docs/source/registry.md index b94e1a4579..b02e5a8e04 100644 --- a/docs/source/registry.md +++ b/docs/source/registry.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Registry records can be addressed through the @registry endpoint on the Plone site." + "property=og:description": "Registry records can be addressed through the @registry endpoint on the Plone site." + "property=og:title": "Registry" + "keywords": "Plone, plone.restapi, REST, API, Registry" +--- + # Registry Registry records can be addressed through the `@registry` endpoint on the Plone site. diff --git a/docs/source/roles.md b/docs/source/roles.md index bef2a60298..e079f624f5 100644 --- a/docs/source/roles.md +++ b/docs/source/roles.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Available roles in a Plone site can be queried by interacting with the /@roles endpoint on the portal root. This action requires an authenticated user." + "property=og:description": "Available roles in a Plone site can be queried by interacting with the /@roles endpoint on the portal root. This action requires an authenticated user." + "property=og:title": "Roles" + "keywords": "Plone, plone.restapi, REST, API, Roles" +--- + # Roles Available roles in a Plone site can be queried by interacting with the `/@roles` endpoint on the portal root. diff --git a/docs/source/searching.md b/docs/source/searching.md index b06d0f6e0f..c0bee2a13b 100644 --- a/docs/source/searching.md +++ b/docs/source/searching.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Content in a Plone site can be searched for by invoking the /@search endpoint in any context." + "property=og:description": "Content in a Plone site can be searched for by invoking the /@search endpoint in any context." + "property=og:title": "Search" + "keywords": "Plone, plone.restapi, REST, API, Search" +--- + # Search Content in a Plone site can be searched for by invoking the `/@search` endpoint in any context: diff --git a/docs/source/serialization.md b/docs/source/serialization.md index ae67b19b43..59cb135d58 100644 --- a/docs/source/serialization.md +++ b/docs/source/serialization.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Throughout the REST API, content needs to be serialized and deserialized to and from JSON representations." + "property=og:description": "Throughout the REST API, content needs to be serialized and deserialized to and from JSON representations." + "property=og:title": "Serialization" + "keywords": "Plone, plone.restapi, REST, API, Serialization" +--- + # Serialization Throughout the REST API, content needs to be serialized and deserialized to and from JSON representations. diff --git a/docs/source/sharing.md b/docs/source/sharing.md index 611c9911c1..567dc994f5 100644 --- a/docs/source/sharing.md +++ b/docs/source/sharing.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Plone comes with a sophisticated user management system that allows an administrator to assign users and groups with global roles and permissions. Sharing give users the permission to access or edit a specific part of your website or a specific content object." + "property=og:description": "Plone comes with a sophisticated user management system that allows an administrator to assign users and groups with global roles and permissions. Sharing give users the permission to access or edit a specific part of your website or a specific content object." + "property=og:title": "Sharing" + "keywords": "Plone, plone.restapi, REST, API, Sharing" +--- + (sharing)= # Sharing diff --git a/docs/source/system.md b/docs/source/system.md index d163df5331..157a4aac94 100644 --- a/docs/source/system.md +++ b/docs/source/system.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "The @system endpoint exposes system information about the Plone backend." + "property=og:description": "The @system endpoint exposes system information about the Plone backend." + "property=og:title": "System" + "keywords": "Plone, plone.restapi, REST, API, System" +--- + (system)= # System diff --git a/docs/source/tiles.md b/docs/source/tiles.md index 0d32a7aa91..c8c4fc79d4 100644 --- a/docs/source/tiles.md +++ b/docs/source/tiles.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "A tile in Plone is an HTML snippet that can contain arbitrary content, such as text, images, or videos. The tiles endpoint is deprecated and will be removed in plone.restapi 9." + "property=og:description": "A tile in Plone is an HTML snippet that can contain arbitrary content, such as text, images, or videos. The tiles endpoint is deprecated and will be removed in plone.restapi 9." + "property=og:title": "Tiles" + "keywords": "Plone, plone.restapi, REST, API, Tiles" +--- + # Tiles ```{warning} diff --git a/docs/source/translations.md b/docs/source/translations.md index e2e9c3dc59..e3cd10c8ba 100644 --- a/docs/source/translations.md +++ b/docs/source/translations.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "plone.restapi provides a @translations endpoint to handle the translation information of the content objects." + "property=og:description": "plone.restapi provides a @translations endpoint to handle the translation information of the content objects." + "property=og:title": "Translations" + "keywords": "Plone, plone.restapi, REST, API, Translations, plone.app.multilingual, multilingual" +--- + (translations)= # Translations diff --git a/docs/source/tusupload.md b/docs/source/tusupload.md index 34629c946e..c5887f978d 100644 --- a/docs/source/tusupload.md +++ b/docs/source/tusupload.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "plone.restapi supports the TUS Open Protocol for resumable file uploads. There is a @tus-upload endpoint to upload a file, and a @tus-replace endpoint to replace an existing file." + "property=og:description": "plone.restapi supports the TUS Open Protocol for resumable file uploads. There is a @tus-upload endpoint to upload a file, and a @tus-replace endpoint to replace an existing file." + "property=og:title": "TUS resumable upload" + "keywords": "Plone, plone.restapi, REST, API, TUS, resumable, upload" +--- + # TUS resumable upload `plone.restapi` supports the [TUS Open Protocol](https://tus.io/) for resumable file uploads. diff --git a/docs/source/types-schema.md b/docs/source/types-schema.md index 946c644215..7b37eb706e 100644 --- a/docs/source/types-schema.md +++ b/docs/source/types-schema.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "A detailed list of all available Zope Schema field types and their corresponding representation as JSON objects." + "property=og:description": "A detailed list of all available Zope Schema field types and their corresponding representation as JSON objects." + "property=og:title": "Types Schema" + "keywords": "Plone, plone.restapi, REST, API, Types, Schema" +--- + (types-schema)= # Types Schema diff --git a/docs/source/types.md b/docs/source/types.md index 75f2ed6885..c204151429 100644 --- a/docs/source/types.md +++ b/docs/source/types.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Available content types in a Plone site can be listed and queried by accessing the /@types endpoint on any context. Access requires an authenticated user." + "property=og:description": "Available content types in a Plone site can be listed and queried by accessing the /@types endpoint on any context. Access requires an authenticated user." + "property=og:title": "Types" + "keywords": "Plone, plone.restapi, REST, API, Types" +--- + (types)= # Types diff --git a/docs/source/upgrade-guide.md b/docs/source/upgrade-guide.md index 388445c0c3..10708834c8 100644 --- a/docs/source/upgrade-guide.md +++ b/docs/source/upgrade-guide.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "plone.restapi Upgrade Guide" + "property=og:description": "plone.restapi Upgrade Guide" + "property=og:title": "Upgrade Guide" + "keywords": "Plone, plone.restapi, REST, API, Upgrade, Guide" +--- + # Upgrade Guide This upgrade guide lists all breaking changes in `plone.restapi`. diff --git a/docs/source/users.md b/docs/source/users.md index 8b925f81a8..c6319662f7 100644 --- a/docs/source/users.md +++ b/docs/source/users.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Available users in a Plone site can be created, queried, updated, and deleted by interacting with the /@users endpoint on portal root." + "property=og:description": "Available users in a Plone site can be created, queried, updated, and deleted by interacting with the /@users endpoint on portal root." + "property=og:title": "Users" + "keywords": "Plone, plone.restapi, REST, API, Users" +--- + # Users Available users in a Plone site can be created, queried, updated, and deleted by interacting with the `/@users` endpoint on portal root. diff --git a/docs/source/vocabularies.md b/docs/source/vocabularies.md index 0383d956eb..1319878048 100644 --- a/docs/source/vocabularies.md +++ b/docs/source/vocabularies.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Vocabularies are a set of allowed choices that back a particular field, whereas sources are similar but usually too large to be enumerated and should be queried such as through an autocomplete." + "property=og:description": "Vocabularies are a set of allowed choices that back a particular field, whereas sources are similar but usually too large to be enumerated and should be queried such as through an autocomplete." + "property=og:title": "Vocabularies and Sources" + "keywords": "Plone, plone.restapi, REST, API, Vocabularies, Sources" +--- + (vocabularies)= # Vocabularies and Sources diff --git a/docs/source/workflow.md b/docs/source/workflow.md index 2475b25454..004e1b4d08 100644 --- a/docs/source/workflow.md +++ b/docs/source/workflow.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Get the current state and history of an object, or workflow, by issuing a GET request for any context." + "property=og:description": "Get the current state and history of an object, or workflow, by issuing a GET request for any context." + "property=og:title": "Workflow" + "keywords": "Plone, plone.restapi, REST, API, Workflow" +--- + # Workflow ```{note} diff --git a/docs/source/workingcopy.md b/docs/source/workingcopy.md index 87b0872be2..b5023eaa22 100644 --- a/docs/source/workingcopy.md +++ b/docs/source/workingcopy.md @@ -1,3 +1,11 @@ +--- +html_meta: + "description": "Plone has a working copy feature that allows the users to create a working copy of a published or live content object, and work with it until it is ready to be published without having to edit the original object." + "property=og:description": "Plone has a working copy feature that allows the users to create a working copy of a published or live content object, and work with it until it is ready to be published without having to edit the original object." + "property=og:title": "Working Copy" + "keywords": "Plone, plone.restapi, REST, API, Working, Copy" +--- + # Working Copy ```{note} diff --git a/news/1382.bugfix b/news/1382.bugfix new file mode 100644 index 0000000000..9619323b3c --- /dev/null +++ b/news/1382.bugfix @@ -0,0 +1 @@ +Add html_meta tags and values for better SEO. [stevepiercy]