More service doc

jdev-org · Aug 2, 2024 · d36b077 · d36b077
1 parent 5bd815b
commit d36b077
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/docs-manager-back/README.md b/docs-manager-back/README.md
@@ -323,13 +323,35 @@ JSON Body params :
 |------|------------------|-------------------------------------------------|----------------------------|
 | GET  | /all             |                                                 | admins                     |
 
+JSON Body params : 
+> Required : null
+
+```
+{
+  plugin: `<String>`,
+  label: `<String>`,
+  status: `<String>`,
+  entity: `<String>`
+}
+```
+
 
 - Get all files by application (plugin) code 
 
 | TYPE | URL              | Param                                           | ALLOWED ROLES              |
 |------|------------------|-------------------------------------------------|----------------------------|
 | GET  | /plugin/{plugin} | Plugin: `<string>` - Plugin's code (e.g CARTEAUX) | writers + readers + admins |
 
+JSON Body params : 
+> Required : null
+
+```
+{
+  label: `<String>`,
+  status: `<String>`,
+  entity: `<String>`
+}
+```
 
 -  Get verification to controle that a document exists
 
@@ -343,6 +365,12 @@ JSON Body params :
 |--------|-----------------------|----------------------------------------------------------------------------------|----------------------------|
 | DELETE | /plugin/{plugin}/{id} | pluginPlugin: `<string>` - Plugin's code (e.g CARTEAUX)<br>id: file's ID to delete | writers + admins           |
 
+- Get a file by plugin's code and document identifier
+
+| TYPE   | URL                   | Param                                                                            | ALLOWED ROLES              |
+|--------|-----------------------|----------------------------------------------------------------------------------|----------------------------|
+| GET    | /plugin/{plugin}/{id} | pluginPlugin: `<string>` - Plugin's code (e.g CARTEAUX)<br>id: file's ID to delete | writers + readers + admins |
+
 # Developper corner
 
 TODO