diff --git a/data-wrapper/v1/csv.ini b/data-wrapper/v1/csv.ini index 926fbe0..7c08bb5 100644 --- a/data-wrapper/v1/csv.ini +++ b/data-wrapper/v1/csv.ini @@ -1,4 +1,29 @@ -mimeType=application/x-tar +# Entrypoint output format +mimeType = application/x-tar + +# OpenAPI Documentation - JSON format (dot notation) +post.operationId = post-v1-csv +post.description = Transformation d'un fichier CSV en fichier corpus +post.summary = Le fichier est transformé en fichier coprus exploitable par un web service asynchrone, chaque ligne est réduite à un object contenant 2 champs (id, value) +post.tags.0 = data-wrapper +post.requestBody.content.text/csv.schema.type = string +post.requestBody.content.text/csv.schema.format = binary +post.requestBody.required = true +post.responses.default.description = Fichier corpus au format tar.gz +post.responses.default.content.application/x-tar.schema.type = string +post.responses.default.content.application/x-tar.schema.format = binary +post.parameters.0.description = Nom du champ à exploiter comme identifiant de ligne +post.parameters.0.in = query +post.parameters.0.name = value +post.parameters.0.schema.type = string +post.parameters.0.schema.default = value +post.parameters.0.required = false +post.parameters.1.description = Nom du champ à exploiter comme identifiant de colonne +post.parameters.1.in = query +post.parameters.1.name = id +post.parameters.1.schema.type = string +post.parameters.1.schema.default = id +post.parameters.1.required = false [use] plugin = basics @@ -9,9 +34,9 @@ [replace] path = id -value = get('title') +value = get(env('id', 'id')) path = value -value = get('title') +value = get(env('value', 'value')) [TARDump] compress = true diff --git a/data-wrapper/v1/tar-tei2json.ini b/data-wrapper/v1/tar-tei2json.ini index 975c4ae..06b847a 100644 --- a/data-wrapper/v1/tar-tei2json.ini +++ b/data-wrapper/v1/tar-tei2json.ini @@ -1,10 +1,23 @@ +# Entrypoint output format mimeType = application/x-tar +# OpenAPI Documentation - JSON format (dot notation) +post.operationId = post-v1-tei2json +post.description = Transformation d'un fichier TEI en fichier corpus +post.summary = Le fichier est transformé en fichier coprus exploitable par un web service asynchrone, chaque document TEI est préalablement transformé en JSON +post.tags.0 = data-wrapper +post.requestBody.content.text/xml.schema.type = string +post.requestBody.content.text/xml.schema.format = binary +post.requestBody.required = true +post.responses.default.description = Fichier corpus au format tar.gz +post.responses.default.content.application/x-tar.schema.type = string +post.responses.default.content.application/x-tar.schema.format = binary + [use] plugin = basics [TARExtract] -path = **/*_tei.xml +path = **/*.xml compress = true json = false diff --git a/data-wrapper/v1/tar-tei2xml.ini b/data-wrapper/v1/tar-tei2xml.ini index 1e312b2..26c35c0 100644 --- a/data-wrapper/v1/tar-tei2xml.ini +++ b/data-wrapper/v1/tar-tei2xml.ini @@ -1,11 +1,24 @@ +# Entrypoint output format mimeType = application/x-tar +# OpenAPI Documentation - JSON format (dot notation) +post.operationId = post-v1-csv +post.description = Transformation d'un fichier TEI en fichier corpus +post.summary = Le fichier est transformé en fichier coprus exploitable par un web service asynchrone, chaque document TEI est préalablement simplifié en fichier XML minimal +post.tags.0 = data-wrapper +post.requestBody.content.text/xml.schema.type = string +post.requestBody.content.text/xml.schema.format = binary +post.requestBody.required = true +post.responses.default.description = Fichier corpus au format tar.gz +post.responses.default.content.application/x-tar.schema.type = string +post.responses.default.content.application/x-tar.schema.format = binary + [use] plugin = basics plugin = xslt [TARExtract] -path = **/*_tei.xml +path = **/*.xml compress = true json = false