Skip to content

Commit

Permalink
chore: update smartapi yaml to final trapi 1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenXu committed May 29, 2024
1 parent 86b2b49 commit 6b794a9
Showing 1 changed file with 39 additions and 8 deletions.
47 changes: 39 additions & 8 deletions docs/smartapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ info:
infores: "infores:biothings-explorer"
x-trapi:
version: "1.5.0"
multicuriequery: false
pathfinderquery: true ## dev instance only
asyncquery: true
operations:
## look at https://standards.ncats.io/operation.json for details.
Expand Down Expand Up @@ -879,8 +881,10 @@ components:
## - AsyncQuery: callback property not required (commented it out of the 'required' field),
## comment out workflow.oneOf section
## - Response: comment out workflow.oneOf section
## - Attribute: comment out properties.attributes.items since the self-$ref breaks execution of
## BTE's api-schema-builder/openapi-validator-middleware
## - Attribute: comment out type and items. The self-$ref in items breaks BTE, because
## an error occurs in its api-schema-builder/openapi-validator-middleware.
## The type is commented out because there'd be a semantic error for
## specifying an array without items.
schemas:
Query:
description: >-
Expand Down Expand Up @@ -928,7 +932,9 @@ components:
Set to true in order to request that the agent obtain
fresh information from its sources in all cases where
it has a viable choice between requesting fresh information
in real time and using cached information.
in real time and using cached information. The agent
receiving this flag MUST also include it in TRAPI sent to
downstream sources (e.g., ARS -> ARAs -> KPs).
additionalProperties: true
required:
- message
Expand Down Expand Up @@ -987,7 +993,9 @@ components:
Set to true in order to request that the agent obtain
fresh information from its sources in all cases where
it has a viable choice between requesting fresh information
in real time and using cached information.
in real time and using cached information. The agent
receiving this flag MUST also include it in TRAPI sent to
downstream sources (e.g., ARS -> ARAs -> KPs).
additionalProperties: true
required:
## BTE does not require the callback property, see the asyncquery
Expand Down Expand Up @@ -1499,8 +1507,20 @@ components:
items:
$ref: '#/components/schemas/CURIE'
minItems: 1
example: [OMIM:603903]
description: CURIE identifier for this node
example: ["OMIM:603903"]
description: >-
A CURIE identifier (or list of identifiers) for this node.
The 'ids' field will hold a list of CURIEs only in the case of a
BATCH set_interpretation, where each CURIE is queried
separately. If a list of queried CURIEs is to be considered as a
set (as under a MANY or ALL set_interpretation), the 'ids' field
will hold a single id representing this set, and the individual members
of this set will be captured in a separate 'member_ids' field.
Note that the set id MUST be created as a UUID by the system that
defines the queried set, using a centralized nodenorm service.
Note also that downstream systems MUST re-use the original set UUID
in the messages they create/send, which will facilitate merging or
caching operations.
nullable: true
categories:
type: array
Expand Down Expand Up @@ -1528,6 +1548,17 @@ components:
- ALL
- MANY
nullable: true
member_ids:
type: array
description: >-
A list of CURIE identifiers for members of a queried set. This
field MUST be populated under a set_interpretation of MANY
or ALL, when the 'ids' field holds a UUID representing the set
itself. This field MUST NOT be used under a set_interpretation
of BATCH.
nullable: true
items:
$ref: '#/components/schemas/CURIE'
constraints:
type: array
description: >-
Expand Down Expand Up @@ -1727,7 +1758,7 @@ components:
example: Assertion Authored By Dr. Trans L. Ator
nullable: true
attributes:
type: array
# type: array
description: >-
A list of attributes providing further information about the
parent attribute (for example to provide provenance
Expand Down Expand Up @@ -2195,7 +2226,7 @@ components:
an Edge provided by the ARAGORN ARA can expressing knowledge it
retrieved from both the automat-mychem-info and molepro KPs,
which both provided it with records of this single fact.
example: [infores:automat-mychem-info, infores:molepro]
example: ["infores:automat-mychem-info", "infores:molepro"]
source_record_urls:
type: array
nullable: true
Expand Down

0 comments on commit 6b794a9

Please sign in to comment.