Skip to content

Managing an Embargo

This page is not normative

This page is not considered a core part of the Vultron Protocol as proposed in the main documentation. Although within the page we might provide guidance in terms of SHOULD, MUST, etc., the content here is not normative.

This diagram is similar to the one shown in Establishing an Embargo, but it also shows the decisions and activities that are used to manage an embargo once it has been established. Once established, an embargo can be modified via a propose/accept/reject cycle. It can also be terminated or removed from a case.



Embargo Management in Vultron

The Vultron protocol contains quite a bit of detail about Embargo Management and how participants are expected to interact with embargoes. Please refer to that section for more information.

flowchart TB
    subgraph as:Invite
        EmProposeEmbargo
    end
    subgraph as:Accept
        EmAcceptEmbargo
    end
    subgraph as:Reject
        EmRejectEmbargo
    end
    subgraph as:Add
        ActivateEmbargo
        AddEmbargoToCase
    end
    subgraph as:Remove
        RemoveEmbargoFromCase
    end
    subgraph as:Announce
        AnnounceEmbargo
    end 
    start([Start])
    start --> f{Ask first?}
    f -->|n| AddEmbargoToCase
    v -->|y| t{Terminate?}
    p{Propose?} -->|y| EmProposeEmbargo
    EmAcceptEmbargo --> ActivateEmbargo
    EmProposeEmbargo --> a{Accept?}
    EmRejectEmbargo --> v
    f -->|y| v{Active?}
    a -->|y| EmAcceptEmbargo
    a -->|n| EmRejectEmbargo
    t -->|n| p
    t{Terminate?} -->|y| RemoveEmbargoFromCase
    ActivateEmbargo --> t
    AddEmbargoToCase --> t
    v -->|n| p
    p -->|n| v
    RemoveEmbargoFromCase --> p

Propose Embargo

An actor proposes an embargo to a case.

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Invite",
  "id": "https://for.example/89846dab-0b13-4923-9c2e-a4b7b09a3852",
  "name": "https://vultron.example/organizations/vendor Invite Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00 to https://vultron.example/cases/VDR-20991514",
  "context": null,
  "summary": "We propose to embargo case 1 for 90 days.",
  "actor": "https://vultron.example/organizations/vendor",
  "target": "https://vultron.example/cases/VDR-20991514",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-10-07T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-10-07T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 90 days."
  }
}

Accept Embargo

An actor accepts an embargo proposal.

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Accept",
  "id": "https://for.example/011afe72-70f1-483b-ac2d-6609876913f6",
  "name": "https://vultron.example/organizations/vendor Accept Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
  "context": "https://vultron.example/cases/1",
  "inReplyTo": "https://vultron.example/cases/1/polls/1",
  "to": "https://vultron.example/cases/1/participants",
  "actor": "https://vultron.example/organizations/vendor",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-10-07T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-10-07T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 90 days."
  }
}

Reject Embargo

An actor rejects an embargo proposal.

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Reject",
  "id": "https://for.example/ee859ce7-570a-49a3-bf2b-b0dfe8d6cc9d",
  "name": "https://vultron.example/organizations/vendor Reject Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-08-23T00:00:00+00:00",
  "context": "https://vultron.example/cases/1",
  "inReplyTo": "https://vultron.example/cases/1/polls/1",
  "to": "https://vultron.example/cases/1/participants",
  "actor": "https://vultron.example/organizations/vendor",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-08-23T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-08-23T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-08-23T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 45 days."
  }
}

Activate Embargo

The case owner activates an embargo. This is a special case of adding an embargo to a case, performed in reply to an embargo proposal.

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Add",
  "id": "https://for.example/b5491b6d-43cd-44ff-ba9a-5cd7dc668d39",
  "name": "https://vultron.example/organizations/vendor Add Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00 to https://vultron.example/cases/VDR-20991514",
  "inReplyTo": "https://for.example/128a8e4e-0121-4448-99ed-8355735ca90d",
  "to": "https://vultron.example/cases/VDR-20991514/participants",
  "actor": "https://vultron.example/organizations/vendor",
  "target": "https://vultron.example/cases/VDR-20991514",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-10-07T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-10-07T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 90 days."
  }
}

Add Embargo to Case

The case owner adds an embargo to the case. This is the generic form of activating an embargo, and is mainly included to allow for a case owner to add an embargo to a case without having to first propose the embargo to the case. In most cases, the case owner will activate an embargo in response to an embargo proposal.

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Add",
  "id": "https://for.example/8625f8de-6eb2-4cd0-bbdd-e4d0f675d5a2",
  "name": "https://vultron.example/organizations/vendor Add Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00 to https://vultron.example/cases/VDR-20991514",
  "to": "https://vultron.example/cases/VDR-20991514/participants",
  "actor": "https://vultron.example/organizations/vendor",
  "target": "https://vultron.example/cases/VDR-20991514",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-10-07T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-10-07T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 90 days."
  }
}

Announce Embargo

The case owner announces an embargo to the case. This is meant to remind case participants of the embargo terms.

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Announce",
  "id": "https://for.example/fd5e21e3-0c1c-457d-9b27-a981b113611e",
  "name": "https://vultron.example/organizations/vendor Announce Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
  "context": "https://vultron.example/cases/VDR-20991514",
  "to": "https://vultron.example/cases/VDR-20991514/participants",
  "actor": "https://vultron.example/organizations/vendor",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-10-07T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-10-07T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 90 days."
  }
}

Announce Embargo

The AnnounceEmbargo activity is used to indicate that an embargo has been established or to remind participants of its status. It is used to announce the embargo to the case participants. It is also used to draw attention to significant changes to the embargo status over and above the corresponding CaseStatus messages, such as when an embargo is deactivated or removed from a case.

Remove Embargo From Case

{
  "@context": "https://www.w3.org/ns/activitystreams",
  "asType": "Remove",
  "id": "https://for.example/f58f557d-592e-4e8f-abfa-9ff2fc1e25b3",
  "name": "https://vultron.example/organizations/vendor Remove Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00 from https://vultron.example/cases/VDR-20991514",
  "actor": "https://vultron.example/organizations/vendor",
  "origin": "https://vultron.example/cases/VDR-20991514",
  "object": {
    "@context": "https://www.w3.org/ns/activitystreams",
    "type": "EmbargoEvent",
    "id": "https://vultron.example/cases/VDR-20991514/embargo_events/2024-10-07T00:00:00+00:00",
    "name": "Embargo for https://vultron.example/cases/VDR-20991514 start: 2024-07-09T20:17:00+00:00 end: 2024-10-07T00:00:00+00:00",
    "context": "https://vultron.example/cases/VDR-20991514",
    "startTime": "2024-07-09T20:17:00+00:00",
    "endTime": "2024-10-07T00:00:00+00:00",
    "published": "2024-07-09T20:17:19+00:00",
    "updated": "2024-07-09T20:17:19+00:00",
    "content": "We propose to embargo VENDOR Case #20991514 for 90 days."
  }
}