Draft Marked for review

Scenario 3: Overlay Journal Announces Review and Endorsement of Pre-print to Aggregator

An overlay journal announces that it has reviewed and endorsed a pre-print to a 'downstream' aggregation service.

Overlay Journal

Notifications

Aggregator

The overlay journal conducts the review.

The overlay journal notifies the aggregator of a new review

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type array which should be an array including Announce from AS 2.0 and coar-notify:ReviewSuccess from Notify.

actor

The activity may have an actor describing the reviewer. The actor:

  • has an id which must be an HTTP URI identifying the reviewer.
  • has a type which should be an array and, in any case, must include [Person] from AS 2.0.
  • may have an ldp:inbox which must be an HTTP URI
  • may have a name

object

The activity has an object representing the journal-review. The objecthas:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should be an array containing Document from AS 2.0.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • An coar-notify:reviews which contains the details of the resource which has been reviewed. The coar-notify:reviews property has:
    • An id containing the HTTP URI of the content file for the resource.
    • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

origin

The activity has an origin describing the system which has initiated the activity. The origin has:

  • An id which is an HTTP URI identifying the overlay-journal.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the overlay-journal

target

The activity has a target describing the system which has initiated the activity. The target has:

  • An id which is an HTTP URI identifying the aggregation-service.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the aggregation-service

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "http://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://isni.org/isni/0000000122832703",
    "inbox": "https://hgwells.com/ldn/inbox",
    "name": "H G Wells",
    "type": [
      "Person"
    ]
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "object": {
    "coar-notify:reviews": {
      "id": "https://repository.org/preprint/201203/421/",
      "ietf:cite-as": "https://doi.org/10.5555/12345680"
    },
    "id": "https://overlay-journal.org/reviews/000001/00001",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://overlay-journal.org",
    "inbox": "https://overlay-journal.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "target": {
    "id": "https://aggregator-service.org",
    "inbox": "https://aggregator-service.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "type": [
    "Announce",
    "coar-notify:ReviewSuccess"
  ]
}
The aggregator creates a link to the review

The overlay journal notifies the aggregator that a resource has been endorsed, and provides a link to evidence of that endorsement.

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type array which should be an array including Announce from AS 2.0 and coar-notify:EndorsementSuccess from Notify.

object

The activity has an object representing the endorsement. The objecthas:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should be an array containing Page from AS 2.0.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • An coar-notify:endorses which contains the details of the resource which has been reviewed. The coar-notify:endorses property has:
    • An id containing the HTTP URI of the content file for the resource.
    • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

origin

The activity has an origin describing the system which has initiated the activity. The origin has:

  • An id which is an HTTP URI identifying the overlay-journal.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the overlay-journal

target

The activity has a target describing the system which has initiated the activity. The target has:

  • An id which is an HTTP URI identifying the aggregation-service.
  • A type which should be an array including the value [Service] from AS 2.0.
  • An ldp:inbox which is the HTTP URI of the LDN inbox for the aggregation-service

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "http://purl.org/coar/notify"
  ],
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "object": {
    "coar-notify:endorses": {
      "id": "https://repository.org/preprint/201203/421/",
      "ietf:cite-as": "https://doi.org/10.5555/12345680"
    },
    "id": "https://overlay-journal.org/articles/00001/",
    "ietf:cite-as": "https://overlay-journal.org/articles/00001/",
    "type": [
      "Page",
      "sorg:WebPage"
    ]
  },
  "origin": {
    "id": "https://overlay-journal.org",
    "inbox": "https://overlay-journal.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "target": {
    "id": "https://aggregator-service.org",
    "inbox": "https://aggregator-service.org/requests/inbox/",
    "type": [
      "Service"
    ]
  },
  "type": [
    "Announce",
    "coar-notify:EndorsementSuccess"
  ]
}
The aggregator creates a link to the endorsement