Payloads#
Our COAR Notify Server is an implementation of the COAR Notify Protocol v1.0.1, please refer to their specification to identify all the required keys and their meanings.
This documentation will provide extra requirements for the kind of COAR Notifications we handle.
Mention of a software in a scientific publication#
id
MUST be a UUIDtype
indicate this is an Announce Relationship COAR Notificationtarget
describes the system which is intended to receive the notification, our inbox for instanceactor
describes the party responsible for this activityobject
describes the relationship itself,subject
is the identifier of your resource which cites/mentions our resourceobject
(a SWHID or an origin URL)context
identifies the resource on thetarget
which is the object of the relationship
Here’s an example payload:
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://coar-notify.net"
],
"id": "urn:uuid:6908e2d0-ab41-4fbf-8b27-e6d6cf1f7b95",
"type": [
"Announce",
"coar-notify:RelationshipAction"
],
"target": {
"id": "https://www.softwareheritage.org",
"inbox": "https://inbox.staging.swh.network",
"type": "Service"
},
"actor": {
"id": "https://your-organization.tld",
"name": "Your Organization",
"type": "Organization"
},
"context": {
"id": "swh:1:dir:ec88e5b901c034d5a91aa133e824d65cff3788a3;origin=https://github.com/rdicosmo/parmap;visit=swh:1:snp:25490d451af2414b2a08ece0df643dfdf2800084;anchor=swh:1:rev:db44dc9cf7a6af7b56d8ebda8c75be3375c89282",
"type": [
"sorg:SoftwareSourceCode"
]
},
"object": {
"as:subject": "https://your-organization.tld/item/12345/",
"as:relationship": "https://w3id.org/codemeta/3.0#citation",
"as:object": " swh:1:dir:ec88e5b901c034d5a91aa133e824d65cff3788a3;origin=https://github.com/rdicosmo/parmap;visit=swh:1:snp:25490d451af2414b2a08ece0df643dfdf2800084;anchor=swh:1:rev:db44dc9cf7a6af7b56d8ebda8c75be3375c89282",
"id": "urn:uuid:74FFB356-0632-44D9-B176-888DA85758DC",
"type": "Relationship"
},
"origin": {
"id": "https://your-organization.tld/repository",
"inbox": "https://inbox.your-organization.tld",
"type": "Service"
}
}