Skip to content

Commit 744c942

Browse files
committed
bte/service provider temp 1.4 yamls: remove /check_query_status endpoint
1 parent 0420b43 commit 744c942

File tree

2 files changed

+0
-126
lines changed

2 files changed

+0
-126
lines changed

biothings_explorer/temp-trapi14-bte.yaml

Lines changed: 0 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -418,68 +418,6 @@ paths:
418418
application/json:
419419
schema:
420420
type: string
421-
## not TRAPI spec: BTE-specific endpoint related to asyncquery
422-
/check_query_status/{id}:
423-
## moved because smartapi-editor gave alert that a non-existent post endpoint wouldn't know what {id} is
424-
parameters:
425-
- description: job-id
426-
in: path
427-
name: id
428-
required: true
429-
## Cache refreshing means this will be changing pretty often, so not including an example
430-
schema:
431-
type: string
432-
get:
433-
tags:
434-
- asyncquery_status
435-
summary: >-
436-
This endpoint can be used when a Query was sent to BTE through an /asyncquery
437-
endpoint without a callback property: BTE then handled it in a polling manner and
438-
provided a job id. The job id can be used here to check the status or retrieve
439-
the Response.
440-
parameters:
441-
- description: option to override original query log level
442-
in: query
443-
name: log_level
444-
required: false
445-
schema:
446-
type: string
447-
description: >-
448-
Logging level. The order of priority is ERROR, WARNING, INFO, DEBUG. BTE will return all logs at the
449-
specified level and those at higher priority levels
450-
enum:
451-
- ERROR
452-
- WARNING
453-
- INFO
454-
- DEBUG
455-
responses:
456-
'200':
457-
description: Returns status. If successfully completed, it will return a TRAPI Response object under the field returnvalue
458-
content:
459-
application/json:
460-
schema:
461-
type: object
462-
required:
463-
- id
464-
- state
465-
properties:
466-
id:
467-
description: the job-id
468-
type: string
469-
state:
470-
description: the status of the job
471-
reason:
472-
description: when the state is 'failed', this field states a reason for the failure
473-
type: string
474-
returnvalue:
475-
## returnvalue.response is where the TRAPI Response is
476-
description: >-
477-
When the state is 'completed', this will contain the TRAPI Response object. Note
478-
that BTE might return an error, no results, etc as a Response...
479-
type: object
480-
properties:
481-
response:
482-
$ref: '#/components/schemas/Response'
483421
## modified TRAPI spec: summary sections tell users that AsyncQuery schema was changed to make callback optional
484422
/asyncquery:
485423
post:

biothings_explorer/temp-trapi14-service-provider.yaml

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -161,70 +161,6 @@ paths:
161161
application/json:
162162
schema:
163163
type: string
164-
## need to remove the extra stuff from server url to use this endpoint..
165-
## example: https://api.bte.ncats.io/check_query_status/{id}
166-
## not TRAPI spec: BTE-specific endpoint related to asyncquery
167-
# /check_query_status/{id}:
168-
# ## moved because smartapi-editor gave alert that a non-existent post endpoint wouldn't know what {id} is
169-
# parameters:
170-
# - description: job-id
171-
# in: path
172-
# name: id
173-
# required: true
174-
# ## Cache refreshing means this will be changing pretty often, so not including an example
175-
# schema:
176-
# type: string
177-
# get:
178-
# tags:
179-
# - asyncquery_status
180-
# summary: >-
181-
# This endpoint can be used when a Query was sent to BTE through an /asyncquery
182-
# endpoint without a callback property: BTE then handled it in a polling manner and
183-
# provided a job id. The job id can be used here to check the status or retrieve
184-
# the Response.
185-
# parameters:
186-
# - description: option to override original query log level
187-
# in: query
188-
# name: log_level
189-
# required: false
190-
# schema:
191-
# type: string
192-
# description: >-
193-
# Logging level. The order of priority is ERROR, WARNING, INFO, DEBUG. BTE will return all logs at the
194-
# specified level and those at higher priority levels
195-
# enum:
196-
# - ERROR
197-
# - WARNING
198-
# - INFO
199-
# - DEBUG
200-
# responses:
201-
# '200':
202-
# description: Returns status. If successfully completed, it will return a TRAPI Response object under the field returnvalue
203-
# content:
204-
# application/json:
205-
# schema:
206-
# type: object
207-
# required:
208-
# - id
209-
# - state
210-
# properties:
211-
# id:
212-
# description: the job-id
213-
# type: string
214-
# state:
215-
# description: the status of the job
216-
# reason:
217-
# description: when the state is 'failed', this field states a reason for the failure
218-
# type: string
219-
# returnvalue:
220-
# ## returnvalue.response is where the TRAPI Response is
221-
# description: >-
222-
# When the state is 'completed', this will contain the TRAPI Response object. Note
223-
# that BTE might return an error, no results, etc as a Response...
224-
# type: object
225-
# properties:
226-
# response:
227-
# $ref: '#/components/schemas/Response'
228164
## copied from BTE's /asyncquery and modified summary
229165
/asyncquery:
230166
post:

0 commit comments

Comments
 (0)