Newer
Older
web-services / data-wrapper / v1 / query-istex.ini
# Entrypoint output format
mimeType = application/x-gzip
extension = tar.gz

# OpenAPI Documentation - JSON format (dot notation)
post.operationId = post-v1-query-istex
post.summary = Téléchargement des documents ISTEX répondant à une requete
post.description = Le fichier en entrée contient une requête dont le résultat produira un fichier corpus exploitable par un web service asynchrone
post.tags.0 = data-wrapper
post.requestBody.content.text/plain.schema.type = string
post.requestBody.content.text/plain.schema.format = binary
post.requestBody.required = true
post.responses.default.description = Fichier corpus au format tar.gz
post.responses.default.content.application/x-gzip.schema.type = string
post.responses.default.content.application/x-gzip.schema.format = binary
post.parameters.0.description = Nom du champ à exploiter comme identifiant de colonne
post.parameters.0.in = query
post.parameters.0.name = id
post.parameters.0.schema.type = string
post.parameters.0.schema.default = arkIstex
post.parameters.0.required = false
post.parameters.1.description = Nom du champ à exploiter comme identifiant de ligne
post.parameters.1.in = query
post.parameters.1.name = value
post.parameters.1.schema.type = string
post.parameters.1.schema.default = title
post.parameters.1.required = false
post.parameters.2.description = chaque ligne est réduite à un object contenant 2 champs (id, value)
post.parameters.2.in = query
post.parameters.2.name = slim
post.parameters.2.schema.type = boolean
post.parameters.2.schema.default = true
post.parameters.2.required = false

[env]
path = slim
value = env('slim').thru(x => (x === 'false' ? false : true))

[use]
plugin = basics
plugin = istex

[TXTConcat]

[replace]
path = q
value = self().trim()

[ISTEXScroll]
query = get('q')
field = *

[ISTEXResult]

[assign]
path = id
value = get(env('id', 'arkIstex'))
path = value
value = get(env('value', 'title'))
value = self()

[exchange]
value = self().thru(x => _.env(null, 'slim') ? _.pick(x, ['id', 'value']) : x)

[TARDump]
compress = true
manifest = fix({version: '1'})
manifest = fix({generator: 'v1/query-istex'})
manifest = fix({parameters: _.omit(_.env(), 'headers')})
manifest = fix({hostAgent: _.get(_.env(), 'headers.host')})
manifest = fix({userAgent: _.get(_.env(), 'headers.user-agent')})