Skip to content

Commit 596af10

Browse files
committed
Merge branch '6-dev' into upgrade-guide
# Conflicts: # docs/glossary.md
2 parents bffe8bb + 77491ab commit 596af10

File tree

5 files changed

+53
-3
lines changed

5 files changed

+53
-3
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@
120120
"**/README.rst",
121121
"plone.restapi/.*",
122122
"plone.restapi/bin",
123+
"plone.restapi/docs/source/glossary.md", # There can be only one Glossary.
123124
"plone.restapi/ideas",
124125
"plone.restapi/include",
125126
"plone.restapi/lib",

docs/glossary.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,4 +455,53 @@ PLIP
455455
PLIPs are **PL**one **I**mprovement **P**roposals.
456456
These are about larger changes to Plone, discussed beforehand by the community.
457457
PLIPs are tracked in the GitHub issue tracker for [`Products.CMFPlone`](https://github.com/plone/Products.CMFPlone/issues?q=label%3A%2203+type%3A+feature+%28plip%29%22+).
458+
459+
REST
460+
REST stands for [Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer). It is a software architectural principle to create loosely coupled web APIs.
461+
462+
workflow
463+
A concept in Plone (and other CMS's) whereby a content object can be in a number of states (private, public, etcetera) and uses transitions to change between them (e.g. "publish", "approve", "reject", "retract"). See the [Plone docs on Workflow](https://docs.plone.org/working-with-content/collaboration-and-workflow/)
464+
465+
HTTP-Request
466+
HTTP Request
467+
Request
468+
Requests
469+
The initial action performed by a web client to communicate with a server. The {term}`Request` is usually followed by a {term}`Response` by the server, either synchronous or asynchronous (which is more complex to handle on the user side)
470+
471+
HTTP-Response
472+
HTTP Response
473+
Response
474+
Answer of or action by the server that is executed or send to the client after the {term}`Request` is processed.
475+
476+
HTTP-Header
477+
HTTP Header
478+
Header
479+
The part of the communication of the client with the server that provides the initialisation of the communication of a {term}`Request`.
480+
481+
HTTP-Verb
482+
HTTP Verb
483+
Verb
484+
One of the basic actions that can be requested to be executed by the server (on an object) based on the {term}`Request`.
485+
486+
Object URL
487+
The target object of the {term}`Request`
488+
489+
Authorization Header
490+
Part of the {term}`Request` that is responsible for the authentication related to the right user or service to ask for a {term}`Response`.
491+
492+
Accept Header
493+
Part of the {term}`Request` that is responsible to define the expected type of data to be accepted by the client in the {term}`Response`.
494+
495+
Authentication Method
496+
Access restriction provided by the connection chain to the server exposed to the client.
497+
498+
Basic Auth
499+
A simple {term}`Authentication Method` referenced in the {term}`Authorization Header` that needs to be provided by the server.
500+
501+
content rule
502+
A content rule will automatically perform an action when a certain event, known as a {term}`trigger`, takes place.
503+
504+
trigger
505+
A trigger is an event in Plone that causes the execution of defined actions.
506+
Example triggers include object modified, user logged in, and workflow state changed.
458507
```

submodules/plone.api

submodules/plone.restapi

Submodule plone.restapi updated 70 files

submodules/volto

Submodule volto updated 66 files

0 commit comments

Comments
 (0)