Commit 0e96d8f1 authored by David Mendez's avatar David Mendez
Browse files

Add description for new entities join endpoint

parent 9855d25c
......@@ -137,4 +137,6 @@ app/static/
/config.yml
/config_playground.yml
output.csv
\ No newline at end of file
output.csv
deleteme.json
\ No newline at end of file
......@@ -28,6 +28,8 @@ tags:
description: 'Endpoints to obtain data for visualisations'
- name: 'Utils'
description: 'Endpoints with utility functions.'
- name: 'Entities Join'
description: 'Endpoints for handling joins between ChEMBL entities.'
schemes:
- "https"
- "http"
......@@ -493,6 +495,51 @@ paths:
description: "success"
schema:
$ref: '#/definitions/IdentifiedSeparatorResponse'
/entities_join/get_link_to_related_items:
post:
tags:
- 'Entities Join'
summary: 'Get link to the related entities to the ones passed as parameter'
operationId: 'get_es_data'
produces:
- 'application/json'
parameters:
- name: 'destination_entity_browser_state_template'
in: 'formData'
description: 'Template to use for the resulting browser state to generate.'
required: true
type: 'string'
default: 'wwwdev.ebi.ac.uk/chembl/g/#browse/<BROWSER_NAME>/full_state/<GENERATED_STATE>'
- name: 'from'
in: 'formData'
description: 'Source entity for the join.'
required: true
type: 'string'
enum: [ 'CHEMBL_COMPOUNDS', 'CHEMBL_TARGETS', 'CHEMBL_ASSAYS', 'CHEMBL_DOCUMENTS', 'CHEMBL_CELL_LINES', 'CHEMBL_TISSUES' ]
default: 'CHEMBL_COMPOUNDS'
- name: 'to'
in: 'formData'
description: 'The entity in ChEMBL to do the join with.'
required: true
type: 'string'
enum: [ 'CHEMBL_COMPOUNDS', 'CHEMBL_TARGETS', 'CHEMBL_ASSAYS', 'CHEMBL_DOCUMENTS', 'CHEMBL_CELL_LINES', 'CHEMBL_TISSUES' ]
default: 'CHEMBL_COMPOUNDS'
- name: 'es_query'
in: 'formData'
description: 'stringifyied version of the query being sent to elasticsearch'
required: true
type: 'string'
default: '{"size": 24, "from": 0, "query": {"bool": {"must": [{"query_string": {"analyze_wildcard": True, "query": "*"}}], "filter": []}}, "sort": []}'
- name: 'selection_description'
in: 'formData'
description: 'stringifyied version of the description of the selection parameters of the dataset. //selectionMode options: ["allItemsExcept", "noItemsExcept"]'
type: 'string'
default: '{"selectionMode": "allItemsExcept","exceptions": ["CHEMBL3989861", "CHEMBL3989724", "CHEMBL64"]}'
responses:
'200':
description: "success"
schema:
$ref: '#/definitions/EntitiesJoinResponse'
definitions:
ESProxyResponse:
type: 'object'
......@@ -601,4 +648,9 @@ definitions:
properties:
separator:
type: 'string'
EntitiesJoinResponse:
type: "object"
properties:
tiny_url:
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