Skip to content

Commit 293d456

Browse files
authored
Merge pull request plone#1338 from plone/merge-glossaries
Merge glossary terms
2 parents 6926a82 + 8dbc28f commit 293d456

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@
118118
"**/README.rst",
119119
"plone.restapi/.*",
120120
"plone.restapi/bin",
121+
"plone.restapi/docs/source/glossary.md", # There can be only one Glossary.
121122
"plone.restapi/ideas",
122123
"plone.restapi/include",
123124
"plone.restapi/lib",

docs/glossary.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,4 +450,53 @@ make
450450
451451
Make gets its knowledge of how to build your program from a file called the _makefile_, which lists each of the non-source files and how to compute it from other files.
452452
When you write a program, you should write a makefile for it, so that it is possible to use Make to build and install the program.
453+
454+
REST
455+
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.
456+
457+
workflow
458+
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/)
459+
460+
HTTP-Request
461+
HTTP Request
462+
Request
463+
Requests
464+
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)
465+
466+
HTTP-Response
467+
HTTP Response
468+
Response
469+
Answer of or action by the server that is executed or send to the client after the {term}`Request` is processed.
470+
471+
HTTP-Header
472+
HTTP Header
473+
Header
474+
The part of the communication of the client with the server that provides the initialisation of the communication of a {term}`Request`.
475+
476+
HTTP-Verb
477+
HTTP Verb
478+
Verb
479+
One of the basic actions that can be requested to be executed by the server (on an object) based on the {term}`Request`.
480+
481+
Object URL
482+
The target object of the {term}`Request`
483+
484+
Authorization Header
485+
Part of the {term}`Request` that is responsible for the authentication related to the right user or service to ask for a {term}`Response`.
486+
487+
Accept Header
488+
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`.
489+
490+
Authentication Method
491+
Access restriction provided by the connection chain to the server exposed to the client.
492+
493+
Basic Auth
494+
A simple {term}`Authentication Method` referenced in the {term}`Authorization Header` that needs to be provided by the server.
495+
496+
content rule
497+
A content rule will automatically perform an action when a certain event, known as a {term}`trigger`, takes place.
498+
499+
trigger
500+
A trigger is an event in Plone that causes the execution of defined actions.
501+
Example triggers include object modified, user logged in, and workflow state changed.
453502
```

0 commit comments

Comments
 (0)