design/api/metacategory.apib
changeset 142 56850f5c73f6
parent 133 6f3078f7fd47
--- a/design/api/metacategory.apib	Tue Jul 10 15:18:03 2018 +0200
+++ b/design/api/metacategory.apib	Wed Jul 18 17:32:09 2018 +0200
@@ -24,15 +24,15 @@
 
 - id: `a4977c1f-4752-4aff-b724-eec4033af25c` (string)
 - owner: `group1` (string)
-- revision: `1`
+- version: `1`
 - description: `Cras rutrum lacinia pretium. Suspendisse justo est, tincidunt sed tellus a, sodales suscipit risus. Curabitur odio tortor, tincidunt sed est nec, ullamcorper sodales velit.` (string)
 
 ## MetacategoryRevision (object)
 
 - id: `e5712a76-857a-4769-b27e-a3ac3fb38b4d` (string)
-- revision: `2` (number)
+- version: `2` (number)
 - base: `ef14bcce-52ac-44ba-a7d1-f1441bab94de` (string)
-- name: `référence` (string)
+- title: `référence` (string)
 - description: `Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin massa nibh, hendrerit quis justo vitae, luctus tempor dolor. Nam quis fringilla diam.` (string)
 - color: `#2cbfff` (string)
 - has_comment: `false` (boolean)
@@ -138,18 +138,18 @@
 
 Permet de créer une nouvelle révision du protocole.
 
-L'attribut `revision` doit être le dernier numéro de révision du protocole.
+L'attribut `version` doit être le dernier numéro de révision du protocole.
 
 La liste des métacatégorie doit être complête et remplacera la liste existante sur la révision courante.
-Tous les attributs d'une metacategories doivent être fournis à part `id`, `revision` et `base`.
+Tous les attributs d'une metacategories doivent être fournis à part `id`, `version` et `base`.
 Les rêgles pour ces derniers sont les suivantes
 
-- Si `id` est présent: l'attribut `revision` doit être fourni et correspondre à la dernière valeur pour cette méta-catégorie. Si un des attributs a été modifé, une nouvelle révision sera créee.
+- Si `id` est présent: l'attribut `version` doit être fourni et correspondre à la dernière valeur pour cette méta-catégorie. Si un des attributs a été modifé, une nouvelle révision sera créee.
 - Si `id` n'est pas présent: 2 possibilités:
     - `base` est présent: Dans ce cas une nouvelle famille de méta-catégorie est créé prenant pour base la métacatégorie dont l'ID est passé comme base. Si les attributs ne sont pas les mêmes, une nouvelle révision sera automatiquement créée, sinon, les attributs de la méta-catégorie de base sont copié dans une révision de base.
     - `base` n'est pas présent: une nouvelle métacatégorie est créée ainsi qu'une nouvelle famille de méta-catégorie basée dessus.
 
-Dans tous les cas, le retours est une sérialisation complête du protocole d'annotation, avec les nouveaux `id` et `revision` pour les méta-catégories créées ou mis à jour.
+Dans tous les cas, le retours est une sérialisation complête du protocole d'annotation, avec les nouveaux `id` et `version` pour les méta-catégories créées ou mis à jour.
 
 + Parameters
 
@@ -179,13 +179,13 @@
 
 + Response 409
 
-    Retournée si la valeur de l'attribut `revision` n'est pas le numéro de version courant du protocole, ou bien d'une des méta-catégories.
+    Retournée si la valeur de l'attribut `version` n'est pas le numéro de version courant du protocole, ou bien d'une des méta-catégories.
 
     + Attributes (object)
-        - error : `Bad revision number.`
+        - error : `Bad version number.`
 
 
-## Détail d'un protocole [/protocol/{id}/{revision}/]
+## Détail d'un protocole [/protocol/{id}/{version}/]
 
 ### Voir une revision d'un protocole [GET]
 
@@ -194,7 +194,7 @@
 + Parameters
 
     + id: `a4977c1f-4752-4aff-b724-eec4033af25c` - Identifiant d'un protocole
-    + revision: `2` (number) - Numéro de la révision
+    + version: `2` (number) - Numéro de la révision
 
 + Response 200 (application/json)
 
@@ -216,7 +216,7 @@
 
 
 
-## Détail méta-catégorie [/protocol/{protocol_id}/{revision}/metacategory/{metacategory_id}/]
+## Détail méta-catégorie [/protocol/{protocol_id}/{version}/metacategory/{metacategory_id}/]
 
 ### Voir le détail d'une méta-catégorie [GET]
 
@@ -225,7 +225,7 @@
 + Parameters
 
     + protocol_id: `a4977c1f-4752-4aff-b724-eec4033af25c` - Identifiant d'un protocole
-    + revision: `2` (number) - Numéro de la révision
+    + version: `2` (number) - Numéro de la révision
     + metacategory_id: `e5712a76-857a-4769-b27e-a3ac3fb38b4d` - Identifiant d'une méta-categorie
 
 + Response 200 (application/json)