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

Adding mapping registry convenience fields to the SSSOM data model #264

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
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
22 changes: 22 additions & 0 deletions src/sssom_schema/schema/sssom_schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,25 @@ slots:
multivalued: true
inlined_as_list: true
recommended: true
mapping_registry_mapping_id:
description: An optional identifier of the mapping as provided by a specific mapping registry, NOT by the mapping provider.
There are no restrictions on how it this id should be formed, and tools should feel free to use their own schemes.
The purpose of this field is not to provide a unique identifier (which would be used in provenance-related work), but a conventient field
for an API and a UI (of a Mapping Registry) to retrieve information. It should be possible to ensure that that the
ID works to retrieve data from the API across different releases of the registry.
range: EntityReference
examples:
- value: REGISTRY:A989886786786
description: A database identifier that represents the identity of this mapping. It may resolve to a website containing information about this mapping.
mapping_registry_mapping_set_id:
description: An optional reference to a mapping set provided by a specific mapping registry,
NOT by the mapping provider. Any mapping registry can (and will) freely overwrite this field.
The purpose of this field is not to provide additional metadata, but a conventient field
for an API and a UI (of a Mapping Registry) to link back a specific mapping to its mapping set.
examples:
- value: REGISTRY:M12345678
description: A database identifier that represents the identity of this mapping set. It will resolve to a website cotaining information about this mapping.
range: EntityReference
subject_id:
description: The ID of the subject of the mapping.
range: EntityReference
Expand Down Expand Up @@ -497,6 +516,7 @@ classes:
- see_also
- other
- comment
- mapping_registry_mapping_set_id
mapping:
description: Represents an individual mapping between a pair of entities
slots:
Expand Down Expand Up @@ -540,6 +560,8 @@ classes:
- see_also
- other
- comment
- mapping_registry_mapping_id
- mapping_registry_mapping_set_id
class_uri: owl:Axiom
mapping registry:
description: A registry for managing mapping sets. It holds a set of
Expand Down