Skip to content

GOFAST-11382 - Add documentation for output shape selector parameter on space creation endpoint #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anbouchet wants to merge 1 commit into
base: 4.0
Choose a base branch
from
Open

GOFAST-11382 - Add documentation for output shape selector parameter on space creation endpoint #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 41 additions & 10 deletions docs-gofast-development/api-rest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1046,15 +1046,18 @@ Cette méthode permet de créer un *espace collaboratif* en passant par le méca
|Content-Type | application/json |
+-------------------+--------------------------+

+-------------------+----------------------------------------------+
| Clé | Valeur |
+===================+==============================================+
| gid* |N° de noeud de l'espace parent |
+-------------------+----------------------------------------------+
| title* |Titre du nouvel espace |
+-------------------+----------------------------------------------+
| body |Contenu de l'accueil de l'espace (format HTML)|
+-------------------+----------------------------------------------+
+-------------------+------------------------------------------------------------------+
| Clé | Valeur |
+===================+==================================================================+
| gid* |N° de noeud de l'espace parent |
+-------------------+------------------------------------------------------------------+
| title* |Titre du nouvel espace |
+-------------------+------------------------------------------------------------------+
| body |Contenu de l'accueil de l'espace (format HTML) |
+-------------------+------------------------------------------------------------------+
| output_shape |Soit "nid" ou "node" pour changer la forme de la valeur de retour.|
| |Introduit en v4.6.0 |
+-------------------+------------------------------------------------------------------+


*Retour:*
Expand All @@ -1065,10 +1068,38 @@ Cette méthode permet de créer un *espace collaboratif* en passant par le méca
|Content-Type | application/json |
+-------------------+----------------------------------------+

si ``output_shape`` vaut "id" ou non spécifié ou avant v4.6.0:

+-----------------------+---------------------+
| Clé | Valeur |
+=======================+=====================+
|gid | N° de l'espace créé |
+-----------------------+---------------------+

si ``output_shape`` vaut "node":

+-----------------------+----------------------------------------------------+
| Clé | Valeur |
+=======================+====================================================+
|gid | N° de l'espace crée |
|nid | N° de l'espace créé |
+-----------------------+----------------------------------------------------+
|type | Type du noeud |
+-----------------------+----------------------------------------------------+
|title | Titre du noeud |
+-----------------------+----------------------------------------------------+
|status | 1: Publié, 0: Dépublié (Supprimé) |
+-----------------------+----------------------------------------------------+
|uid | N° du créateur du noeud |
+-----------------------+----------------------------------------------------+
|sticky | 1: Epinglé, 0: Pas épinglé |
+-----------------------+----------------------------------------------------+
|created | Timestamp de création du noeud |
+-----------------------+----------------------------------------------------+
|updated | Timestamp de dernière modification du noeud |
+-----------------------+----------------------------------------------------+
|update_uid | N° du dernier modificateur du noeud |
+-----------------------+----------------------------------------------------+
|alfresco_reference | Référence du contenu Alfresco associé au noeud |
+-----------------------+----------------------------------------------------+

Action : member
Expand Down