update api doc

Holusion · Jul 18, 2024 · e351a91 · e351a91
1 parent 7ec4d46
commit e351a91
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/_sass/highlight.scss b/_sass/highlight.scss
@@ -132,7 +132,7 @@ pre code{
 		color: #555555;
 	}
 	.nt { /* Name.Tag */
-		color: #000080;
+		color: #009719;
 	}
 	.nv { /* Name.Variable */
 		color: #008080;

diff --git a/en/doc/guides/import_export.md b/en/doc/guides/import_export.md
@@ -19,15 +19,20 @@ Navigate to the **collection** page of your eCorpus instance. Select the scenes
 #### Using the API
 
 ```bash
-curl -XGET https://${HOSTNAME}/api/v1/scenes?name=${NAME}&format=zip
+curl -XGET https://${HOSTNAME}/scenes?name=${NAME}&format=zip
 ```
 You can add as many `name="..."` parameters as you need, separated by `&` characters.
 
 ### Importing data into your eCorpus instance
 
 #### Using the API
 
+Import zip scene or collection of scenes from a eCorpus instance.
+
 ```bash
-curl -XPOST https://${HOSTNAME}/api/v1/scenes --data-binary "@${ZIP_FILE}" | jq .
+curl -XPOST https://${HOSTNAME}/scenes --data-binary "@${ZIP_FILE}" -u "${USERNAME}:${PASSWORD}" | jq .
 ```
+
+Only user with global **admin** right can user this request.
+
 The request returns a (potentially very large) JSON object describing the result. You can filter only failure by running `jq .fail` or if you don't have `jq` installed you can skip it and use the `curl -s --fail -o /dev/null -w "%{http_code}"`.
diff --git a/fr/doc/guides/import_export.md b/fr/doc/guides/import_export.md
@@ -20,7 +20,7 @@ Accédez à la page **collection** de votre instance eCorpus. Sélectionnez les
 #### Utilisation de l'API
 
 ```bash
-curl -XGET https://${HOSTNAME}/api/v1/scenes?name=${NAME}&format=zip
+curl -XGET https://${HOSTNAME}/scenes?name=${NAME}&format=zip
 ```
 Vous pouvez ajouter autant de paramètres `name="..."` que nécessaire, séparés par des caractères `&`.
 
@@ -29,8 +29,12 @@ Vous pouvez ajouter autant de paramètres `name="..."` que nécessaire, séparé
 
 #### Utilisation de l'API
 
+Importer une scène ou une collection de scènes exportées d'une instance eCorpus.
+
 ```bash
-curl -XPOST https://${HOSTNAME}/api/v1/scenes --data-binary "@${ZIP_FILE}" | jq .
+curl -XPOST https://${HOSTNAME}/scenes --data-binary "@${ZIP_FILE}" -u "${USERNAME}:${PASSWORD}" | jq .
 ```
 
+Seul les comptes avec des droits d'**administrateur** peuvent effectuer cette requête.
+
 Cette requête retourne une liste des changements effectués qui peut être assez longue. Vous pouvez filtrer les échecs en utilisant `jq .fail` ou si vous n'avez pas `jq` installé, vous pouvez utiliser curl en mode silencieux et inspecter uniquement le status de la réponse : `curl -s --fail -o /dev/null -w "%{http_code}"`.