Skip to content

Commit ec8ec27

Browse files
committed
Simplify binding structure
1 parent e85e480 commit ec8ec27

1 file changed

Lines changed: 31 additions & 29 deletions

File tree

TranslatorReasonerAPI.yaml

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -604,14 +604,11 @@ components:
604604
The dictionary of Input Query Graph to Result Knowledge Graph node
605605
bindings where the dictionary keys are the key identifiers of the
606606
Query Graph nodes and the associated values of those keys are
607-
instances of NodeBinding schema type (see below). This value is an
608-
array of NodeBindings since a given query node may have multiple
609-
knowledge graph Node bindings in the result.
607+
instances of NodeBinding schema type (see below). Because a given
608+
QNode may have multple knowledge Nodes bound in the result,
609+
the NodeBinding object may list multiple knowledge Nodes.
610610
additionalProperties:
611-
type: array
612-
items:
613-
$ref: '#/components/schemas/NodeBinding'
614-
minItems: 1
611+
$ref: '#/components/schemas/NodeBinding'
615612
minProperties: 1
616613
analyses:
617614
type: array
@@ -627,17 +624,20 @@ components:
627624
NodeBinding:
628625
type: object
629626
description: >-
630-
An instance of NodeBinding is a single KnowledgeGraph Node mapping,
627+
A NodeBinding object defines all relevant KnowledgeGraph Node mappings,
631628
identified by the corresponding 'id' object key identifier of the
632629
Node within the Knowledge Graph. Instances of NodeBinding may
633630
include extra annotation in the form of additional properties.
634631
(such annotation is not yet fully standardized). Each Node
635632
Binding must bind directly to node in the original Query Graph.
636633
properties:
637-
id:
638-
$ref: '#/components/schemas/CURIE'
634+
ids:
635+
type: array
636+
items:
637+
$ref: '#/components/schemas/CURIE'
638+
minItems: 1
639639
description: >-
640-
The CURIE of a Node within the Knowledge Graph.
640+
The CURIEs of one or more Nodes within the Knowledge Graph.
641641
additionalProperties: true
642642
required:
643643
- id
@@ -662,23 +662,19 @@ components:
662662
The dictionary of input Query Graph to Knowledge Graph edge
663663
bindings where the dictionary keys are the key identifiers of
664664
the Query Graph edges and the associated values of those keys
665-
are instances of EdgeBinding schema type (see below). This
666-
value is an array of EdgeBindings since a given query edge may
667-
resolve to multiple Knowledge Graph Edges.
665+
are instances of EdgeBinding schema type (see below). Because
666+
a given QEdge may have multple knowledge Edges bound in the
667+
result, the EdgeBinding object may list multiple knowledge Nodes.
668668
additionalProperties:
669-
type: array
670-
items:
671-
$ref: '#/components/schemas/EdgeBinding'
669+
$ref: '#/components/schemas/EdgeBinding'
672670
path_bindings:
673671
type: object
674672
minProperties: 1
675673
description: >-
676674
The dictionary of input Query Graph paths to Analysis paths,
677675
specifically only for pathfinder queries.
678676
additionalProperties:
679-
type: array
680-
items:
681-
$ref: '#/components/schemas/PathBinding'
677+
$ref: '#/components/schemas/PathBinding'
682678
score:
683679
type: number
684680
format: float
@@ -719,31 +715,37 @@ components:
719715
EdgeBinding:
720716
type: object
721717
description: >-
722-
A instance of EdgeBinding is a single KnowledgeGraph Edge mapping,
718+
An EdgeBinding object defines all relevant KnowledgeGraph Edge mappings,
723719
identified by the corresponding 'id' object key identifier of the
724720
Edge within the Knowledge Graph. Instances of EdgeBinding may include
725721
extra annotation (such annotation is not yet fully standardized).
726722
Edge bindings are captured within a specific reasoner's Analysis
727723
object because the Edges in the Knowledge Graph that get bound to
728724
the input Query Graph may differ between reasoners.
729725
properties:
730-
id:
731-
type: string
732-
description: The key identifier of a specific KnowledgeGraph Edge.
726+
ids:
727+
type: array
728+
items:
729+
type: string
730+
minItems: 1
731+
description: The key identifiers of specific KnowledgeGraph Edges.
733732
additionalProperties: true
734733
required:
735734
- id
736735
PathBinding:
737736
type: object
738737
description: >-
739-
A instance of PathBinding is a single binding of an input QueryGraph
740-
path (the key to this object) with the AuxiliaryGraph id containing
738+
A PathBinding object binds a single QueryGraph path (the key to
739+
this object) to one or more relevant AuxiliaryGraph ids containing
741740
a list of edges in the path. The Auxiliary Graph does not convey any
742741
order of edges in the path.
743742
properties:
744-
id:
745-
type: string
746-
description: The key identifier of a specific auxiliary graph.
743+
ids:
744+
type: array
745+
items:
746+
type: string
747+
minItems: 1
748+
description: The key identifiers of specific auxiliary graphs.
747749
additionalProperties: true
748750
required:
749751
- id

0 commit comments

Comments
 (0)