Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add subattributes to attributes #268

Merged
merged 2 commits into from
Jul 29, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 84 additions & 2 deletions TranslatorReasonerAPI.yaml
Original file line number Diff line number Diff line change
@@ -605,10 +605,92 @@ components:
description: >-
Generic attribute for a node or an edge that expands the key-value
pair concept by including fields for additional metadata. These fields
can be used to describe the source of the statement made in key-value
can be used to describe the source of the statement made in a key-value
pair of the attribute object, or describe the attribute's value itself
including its semantic type, or a url providing additional information
about it.
about it. An attribute may be further qualified with a SubAttribute
(for example to provide confidence intervals on a value).
properties:
attribute_type_id:
$ref: '#/components/schemas/CURIE'
description: >-
The 'key' of the attribute object, holding a CURIE of an ontology
property defining the attribute (preferably the CURIE of a
Biolink association slot). This property captures the relationship
asserted to hold between the value of the attribute, and the node
or edge from which it hangs. For example, that a value of
'0.000153' represents a p-value supporting an edge, or that
a value of 'ChEMBL' represents the original source of the knowledge
expressed in the edge.
example: Biolink:has_p-value_evidence, Biolink:has_original_source
original_attribute_name:
type: string
description: >-
The term used by the original source of an attribute to describe
the meaning or significance of the value it captures. This may be
a column name in a source tsv file, or a key in a source json
document for the field in the data that held the attribute's
value. Capturing this information where possible lets us preserve
what the original source said. Note that the data type is string'
but the contents of the field could also be a CURIE of a third
party ontology term.
example: p-value
nullable: true
value:
description: >-
Value of the attribute. May be any data type, including a list.
example: 0.000153
value_type_id:
allOf:
- $ref: '#/components/schemas/CURIE'
description: >-
CURIE describing the semantic type of an attribute's value. Use
a Biolink class if possible, otherwise a term from an external
ontology. If a suitable CURIE/identifier does not exist, enter a
descriptive phrase here and submit the new type for consideration
by the appropriate authority.
example: EDAM:data_1187
nullable: true
attribute_source:
type: string
description: >-
The source of the core assertion made by the key-value pair of an
attribute object. Use a CURIE or namespace designator for this
resource where possible.
example: UniProtKB
nullable: true
value_url:
type: string
description: >-
Human-consumable URL linking to a web document that provides
additional information about an attribute's value (not the node
or the edge fom which it hangs).
example: https://pubmed.ncbi.nlm.nih.gov/32529952
nullable: true
description:
type: string
description: >-
Human-readable description for the attribute and its value.
example: Assertion Authored By Dr. Trans L. Ator
nullable: true
attributes:
type: array
description: >-
A list of attributes providing further information about the
parent attribute (for example to provide provenance
information about the parent attribute).
items:
$ref: '#/components/schemas/SubAttribute'
nullable: true
required:
- attribute_type_id
- value
additionalProperties: false
SubAttribute:
type: object
description: >-
Second-level attribute that can be used to qualify information
contained in a primary Attribute attached to a Node or Edge.
properties:
attribute_type_id:
$ref: '#/components/schemas/CURIE'