NCATSTranslator / ReasonerAPI

NCATS Biomedical Translator Reasoners Standard API
34 stars 28 forks source link

association property addition is buried in MetaQualifier PR #426

Open colleenXu opened 1 year ago

colleenXu commented 1 year ago

I noticed that there's something that seems unrelated to MetaQualifiers in the MetaQualifier PR: this new association property on MetaEdges (see below).

In https://github.com/NCATSTranslator/ReasonerAPI/pull/387/files:

        association:
          type: object
          $ref: '#/components/schemas/BiolinkEntity'
          description: >-
            The Biolink association type (entity) that this edge represents.
            Associations are classes in Biolink
            that represent a relationship between two entities.
            For example, the association 'gene interacts with gene'
            is represented by the Biolink class,
            'biolink:GeneToGeneAssociation'.  If association
            is filled out, then the testing harness can
            help validate that the qualifiers are being used
            correctly.
          example: biolink:ChemicalToGeneAssociation

I am wondering if:

sierra-moxon commented 1 year ago

Good to add this discussion to the TRAPI call agenda :)

RichardBruskiewich commented 1 year ago

Thanks @colleenXu for your comments. I'm leaving @sierra-moxon to mainly comment on this (as she has above). I do note, however, your mention of the type: object versus $ref. In fact, we should likely remove the type: object property and move the $ref to after the example: tag, since the $ref effectively effectively overwrites any subschema tags which follow it (see see $ref and Sibling Elements on https://swagger.io/docs/specification/using-ref/).

I've now submitted a PR for this: https://github.com/NCATSTranslator/ReasonerAPI/pull/428. @sierra-moxon, if we need to adjust anything else in this particular MetaEdge.association property, we can perhaps use this PR to achieve this?

edeutsch commented 1 year ago

Still not sure that this was addressed in #428. @colleenXu is this still a concern? Not a schema issue, but an implementation discussion still needs to happen.

colleenXu commented 1 year ago

428 only addressed 1 of my original post's bullet points (on inheritance).

I'm not sure that the other points have been addressed: