Skip to content

EdgeBinding descriptions should be refined? #576

Closed

Description

@edeutsch

In the TRAPI 2.0 schema https://github.com/NCATSTranslator/ReasonerAPI/blob/2.0/TranslatorReasonerAPI.yaml
The EdgeBinding description is maybe a little confusing with its mention of id:

    EdgeBinding:
      type: object
      description: >-
        An EdgeBinding object defines all relevant KnowledgeGraph Edge mappings,
        identified by the corresponding 'id' object key identifier of the
        Edge within the knowledge graph. Instances of EdgeBinding may include
        extra annotation (such annotation is not yet fully standardized).
        EdgeBindings are captured within a specific reasoner's Analysis
        object because the Edges in the KnowledgeGraph that get bound to
        the input QueryGraph may differ between reasoners.
      properties:
        ids:
          type: array
          items:
            type: string
          minItems: 1
          description: The key identifiers of specific KnowledgeGraph Edges.
      additionalProperties: true
      required:
        - ids

maybe change:

        An EdgeBinding object defines all relevant KnowledgeGraph Edge mappings,
        identified by the corresponding 'id' object key identifier of the
        Edge within the knowledge graph. Instances of EdgeBinding may include

to:

        An EdgeBinding object defines all relevant KnowledgeGraph Edge mappings,
        identified by the corresponding object key identifiers of the
        Edges within the knowledge graph. Instances of EdgeBinding may include

Activity

  1. tokebe commented on Oct 15, 2026

    @tokebe
    Contributor

    PR'd #577

  2. added a commit that references this issue on Oct 15, 2026
  3. colleenXu commented on Oct 23, 2026

    @colleenXu
    Contributor

    @edeutsch Can this issue be closed?

  4. edeutsch commented on Nov 5, 2026

    @edeutsch
    CollaboratorAuthor

    yes, closing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions