🤝Contributor

Directional link between research object and profile, indicating a contribution.

Relates a profile to a research object and indicates a contribution to the value of the publication.

Since any actor can create these relations, a gateway operator may choose to only show such indications created by the publication author or an otherwise trustworthy actor.

Schema

FieldTypeDescription

role

String

Role filled by the contributor

researchObjectID

ID

The research object contributed to

researchObjectVersion

Commit

Version when this relation was created

contributorID

ID

The profile of the contributor

fallbackInfo

String

JSON data with social handles, in case contributor does not have a profile

revoked

Boolean

Indicate if this contributor relation has been revoked.

Roles

To the largest possible extent, the contributor's role should be set according to CRediT, the Contributor Roles Taxonomy. This is to reduce the number of different values, making indexing easier. The linked page has definitions for each of the 14 contributor roles, with descriptions on what classifies as that type of contribution. If there is the need to use some other role identifier, that is still possible.

Contributors and profiles

If the contributor has created a profile in the protocol, it's advantageous to refer directly to that because the contributor can update their social handles and other information. Additionally, it makes it easier to find their own work and other contributions if there is an explicit link.

Otherwise, the fallbackInfo field allows a key-value map in JSON format for listing the contributor's handles on services like ORCiD, Google Scholar, etc.

Revocation

Since entity instances can be updated, but not deleted, the way to recall a contributor indication is by updating this field to true. Gateways should respect this and mark it as revoked from the version where it happened.

Last updated