Commit abf77aed authored by David Mendez's avatar David Mendez
Browse files

Separator Identifier: add swagger description

parent f4307811
......@@ -26,6 +26,8 @@ tags:
description: 'Endpoints related to the tracking of elements in the frontend'
- name: 'Visualisations'
description: 'Endpoints to obtain data for visualisations'
- name: 'Utils'
description: 'Endpoints with utility functions.'
schemes:
- "https"
- "http"
......@@ -460,6 +462,36 @@ paths:
description: "success"
schema:
$ref: '#/definitions/COVIDEntitiesRecordsResponse'
/utils/identify_separator:
post:
tags:
- 'Utils'
summary: 'Given a text with items separated by a character or a group of characters,
identifies which is the separator used.'
description: 'Returns the separator used in a string with a list of IDs'
operationId: 'identify_separator'
produces:
- 'application/json'
parameters:
- name: 'type_of_ids'
in: 'formData'
description: 'Type of IDs in the string'
required: true
type: 'string'
default: 'chembl'
enum: ['chembl']
- name: 'text'
in: 'formData'
description: 'Text for which to identify the separator'
required: true
type: 'string'
default: 'CHEMBL1905569;CHEMBL3659411;CHEMBL4104861;CHEMBL1502197;CHEMBL3931303;CHEMBL466111;CHEMBL323959;
CHEMBL1255073;CHEMBL4288214;CHEMBL3480964'
responses:
'200':
description: "success"
schema:
$ref: '#/definitions/IdentifiedSeparatorResponse'
definitions:
ESProxyResponse:
type: 'object'
......@@ -563,3 +595,9 @@ definitions:
type: "object"
COVIDEntitiesRecordsResponse:
type: "object"
IdentifiedSeparatorResponse:
type: "object"
properties:
separator:
type: 'string'
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment