From c5aecdd860e4ace375bef0a0f16f3131b905ba3f Mon Sep 17 00:00:00 2001 From: Colleen Xu Date: Tue, 21 May 2024 12:51:49 -0700 Subject: [PATCH] chore: update local smartapi yaml add changes from registered yaml in https://github.com/NCATS-Tangerine/translator-api-registry/commit/057acebdc91b1ce00663a58a17aeb8cb46693588 and https://github.com/NCATS-Tangerine/translator-api-registry/commit/b5cf828f4579aad436774b3f80c1e66929cd1924 add dryrun/caching params back to /query and /asyncquery endpoints --- docs/smartapi.yaml | 117 ++++++++++++++++++++++++++++++--------------- 1 file changed, 79 insertions(+), 38 deletions(-) diff --git a/docs/smartapi.yaml b/docs/smartapi.yaml index 7576c74..bffc8bb 100644 --- a/docs/smartapi.yaml +++ b/docs/smartapi.yaml @@ -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. @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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: >-