Skip to content

Commit bb10aa0

Browse files
committed
maj doc tech v8
1 parent 4270395 commit bb10aa0

File tree

8 files changed

+1207
-869
lines changed

8 files changed

+1207
-869
lines changed

ressources/DocCourante/index.html

Lines changed: 21 additions & 428 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/externe/Collect.html

Lines changed: 412 additions & 414 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/externe/access.html

Lines changed: 207 additions & 9 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/externe/dsl.html

Lines changed: 44 additions & 2 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/externe/functional-administration.html

Lines changed: 452 additions & 11 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/interne/Access.html

Lines changed: 33 additions & 2 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/interne/Collect.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

ressources/DocCourante/raml/interne/Collect.raml

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,38 @@ documentation:
190190
application/json:
191191
type: object
192192
example: !include libraries/examples/transactionResponse.json
193+
/{id}/upload:
194+
displayName: upload d'une archive Zip à un projet avec gestion automatique des transactions
195+
is: [ StandardTraits.StandardOptionalHeader,
196+
StandardTraits.StandardHeader401, StandardTraits.StandardHeader404,
197+
StandardTraits.StandardHeader409, StandardTraits.StandardHeader412 ]
198+
post:
199+
description: |
200+
Permet de soumettre un ensemble de binaire au format Zip.
201+
L'arborescence est rattachée à une transaction auto-générée dont l'identifiant est retourné à l'appelant.
202+
Optionnellement, le Zip peut contenir un fichier "metadata.csv" ou "metadata.jsonl" décrivant l'ensemble des
203+
métadonnées de l'arborescence.
204+
205+
Il est à noter que dans le cas d'un fichier de métadonnées au format JSONL (metadata.jsonl), la sélection des
206+
métadonnées peut se faire uniquement via le champ `File` ou via un sélecteur (champ `Selector`),
207+
limité à la clé `#uploadFile`.
208+
209+
Attention : Cette API est alpha / expérimentale.
210+
body:
211+
application/zip:
212+
headers:
213+
X-tenant-Id:
214+
required: true
215+
X-Encoding:
216+
required: false
217+
description: "Encodage du zip, par default VITAM utilise UTF-8"
218+
responses:
219+
200:
220+
body:
221+
application/json:
222+
type: object
223+
example: !include libraries/examples/uploadZipToProjectResponseExample.json
224+
193225

194226
/transactions:
195227
displayName: Transactions
@@ -325,11 +357,11 @@ documentation:
325357
responses:
326358
200:
327359
/{id}/upload:
360+
displayName: upload d'une archive Zip à une transaction
328361
uriParameters:
329362
id:
330363
required: true
331364
description: Identifiant de la transaction
332-
displayName: upload d'une archive Zip
333365
is: [ StandardTraits.StandardOptionalHeader,
334366
StandardTraits.StandardHeader401, StandardTraits.StandardHeader404,
335367
StandardTraits.StandardHeader409, StandardTraits.StandardHeader412 ]
@@ -341,6 +373,9 @@ documentation:
341373
headers:
342374
X-tenant-Id:
343375
required: true
376+
X-Encoding:
377+
required: false
378+
description: "Encodage du zip, par default VITAM utilise UTF-8"
344379
responses:
345380
200:
346381
body:

0 commit comments

Comments
 (0)