Skip to content

Commit 1fb4b8b

Browse files
authored
Clarify the absence of link between author_id and author_label. (#451)
Resolves [#344] There is not supposed to be any link between `author_id` and `author_label`. In particular, `author_label[n]` is _not_ intended to be the human-friendly label of `author_id[n]`. This has seemingly always been the intention (see notably this comment: #344 (comment)) but has never been made explicit in the schema, which is what this PR is about. Likewise for `reviewer_id`/`reviewer_label` and `creator_id`/`creator_label`.
1 parent 83400bb commit 1fb4b8b

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

src/sssom_schema/schema/sssom_schema.yaml

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,12 @@ slots:
395395
- value: orcid:0000-0002-7356-1779
396396
description: The ORCID of the creator of the mapping.
397397
creator_label:
398-
description: A string identifying the creator of this mapping. In the spirit of
399-
provenance, consider using creator_id instead.
398+
description: >-
399+
A string representing the creator of this mapping. This should only be used in the
400+
absence of a proper semantic identifier (which would be stored in creator_id) for
401+
that creator. It is not expected that there should be any link between creator_id
402+
and creator_label; in particular, creator_label is not intended to provide a
403+
human-friendly version of an identifier in creator_id.
400404
range: string
401405
multivalued: true
402406
examples:
@@ -417,8 +421,12 @@ slots:
417421
- value: orcid:0000-0002-7356-1779
418422
description: The ORCID of the author of the mapping.
419423
author_label:
420-
description: A string identifying the author of this mapping. In the spirit of
421-
provenance, consider using author_id instead.
424+
description: >-
425+
A string representing the author of this mapping. This should only be used in the
426+
absence of a proper semantic identifier (which would be stored in author_id) for that
427+
author. It is not expected that there should be any link between author_id and
428+
author_label; in particular, author_label is not intended to provide a human-friendly
429+
version of an identifier in author_id.
422430
range: string
423431
multivalued: true
424432
examples:
@@ -438,8 +446,12 @@ slots:
438446
- value: orcid:0000-0002-7356-1779
439447
description: The ORCID of the reviewer of the mapping.
440448
reviewer_label:
441-
description: A string identifying the reviewer of this mapping. In the spirit of
442-
provenance, consider using reviewer_id instead.
449+
description: >-
450+
A string representing the reviewer of this mapping. This should only be used in the
451+
absence of a proper semantic identifier (which would be stored in reviewer_id) for
452+
that reviewer. It is not expected that there should be any link between reviewer_id
453+
and reviewer_label; in particular, reviewer_label is not intended to provide a
454+
human-friendly version of an identifier in reviewer_id.
443455
range: string
444456
multivalued: true
445457
examples:

0 commit comments

Comments
 (0)