Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/biothings/bte-server into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
tokebe committed May 21, 2024
2 parents 97297bb + c5aecdd commit 5aa2eb6
Showing 1 changed file with 79 additions and 38 deletions.
117 changes: 79 additions & 38 deletions docs/smartapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ info:
biolink-version: "4.1.6"
infores: "infores:biothings-explorer"
x-trapi:
version: 1.5.0-beta
version: "1.5.0"
asyncquery: true
operations:
## look at https://standards.ncats.io/operation.json for details.
Expand Down Expand Up @@ -47,7 +47,7 @@ servers:
description: Non-ITRB dev (internal use)
x-maturity: development
tags:
- name: 1.5.0-beta
- name: "1.5.0"
- name: meta_knowledge_graph
- name: query
- name: asyncquery
Expand Down Expand Up @@ -235,13 +235,18 @@ paths:
example: 09c8782d9f4027712e65b95424adba79 ## MyVariant
schema:
type: string
## old feature: not sure if it still works
# - description: dryrun a query (logs the queries BTE will make)
# in: query
# name: dryrun
# required: false
# schema:
# type: boolean
- description: Legacy option to explicitly enable/disable caching.
in: query
name: caching
required: false
schema:
type: boolean
- description: Dryrun a query (logs the queries BTE would make without running them)
in: query
name: dryrun
required: false
schema:
type: boolean
requestBody:
description: Query information to be submitted
required: true
Expand Down Expand Up @@ -338,13 +343,18 @@ paths:
- Multiomics Provider
- Text Mining Provider
- Service Provider
## old feature: not sure if it still works
# - description: dryrun a query (logs the queries BTE will make)
# in: query
# name: dryrun
# required: false
# schema:
# type: boolean
- description: Legacy option to explicitly enable/disable caching.
in: query
name: caching
required: false
schema:
type: boolean
- description: Dryrun a query (logs the queries BTE would make without running them)
in: query
name: dryrun
required: false
schema:
type: boolean
requestBody:
description: Query information to be submitted
required: true
Expand Down Expand Up @@ -429,14 +439,19 @@ paths:
the callback property is not included, BTE will handle the query in a polling
manner: it will provide a job-id that can be used to check the status or retrieve
the Response.
## old feature: not sure if it still works
# parameters:
# - description: dryrun a query (logs the queries BTE will make)
# in: query
# name: dryrun
# required: false
# schema:
# type: boolean
parameters:
- description: Legacy option to explicitly enable/disable caching.
in: query
name: caching
required: false
schema:
type: boolean
- description: Dryrun a query (logs the queries BTE would make without running them)
in: query
name: dryrun
required: false
schema:
type: boolean
requestBody:
description: Query information to be submitted
required: true
Expand Down Expand Up @@ -538,13 +553,18 @@ paths:
example: 09c8782d9f4027712e65b95424adba79 ## MyVariant
schema:
type: string
## old feature: not sure if it still works
# - description: dryrun a query (logs the queries BTE will make)
# in: query
# name: dryrun
# required: false
# schema:
# type: boolean
- description: Legacy option to explicitly enable/disable caching.
in: query
name: caching
required: false
schema:
type: boolean
- description: Dryrun a query (logs the queries BTE would make without running them)
in: query
name: dryrun
required: false
schema:
type: boolean
requestBody:
description: Query information to be submitted
required: true
Expand Down Expand Up @@ -652,13 +672,18 @@ paths:
- Multiomics Provider
- Text Mining Provider
- Service Provider
## old feature: not sure if it still works
# - description: dryrun a query (logs the queries BTE will make)
# in: query
# name: dryrun
# required: false
# schema:
# type: boolean
- description: Legacy option to explicitly enable/disable caching.
in: query
name: caching
required: false
schema:
type: boolean
- description: Dryrun a query (logs the queries BTE would make without running them)
in: query
name: dryrun
required: false
schema:
type: boolean
requestBody:
description: Query information to be submitted
required: true
Expand Down Expand Up @@ -792,6 +817,22 @@ paths:
required: true
schema:
type: string
- description: >-
When specified, the TRAPI logs returned will be of this level of importance or higher. This setting
will override the log_level setting in the job's TRAPI query.
If it's not specified, BTE will use the log_level setting in the job's TRAPI query or return all logs
(the default).
in: query
name: log_level
required: false
schema:
type: string
enum:
- ERROR
- WARNING
- INFO
- DEBUG
responses:
'200':
description: >-
Expand Down

0 comments on commit 5aa2eb6

Please sign in to comment.