Aegis DIDComm vocabulary
The vocabulary https://w3id.org/aegis/didcomm# and the JSON-LD
context that maps the DIDComm service terms onto it,
https://w3id.org/aegis/didcomm/v1.
The context, version 1
The context document is /didcomm/v1,
served as application/ld+json. Its SHA-256 is
09ac38cba7e2c0209940a68e17c3be6ec65ca222d8383ba98eab4470ec1680b0.
It is published once and never changes: a correction is a new version at a
new path. It is a JSON-LD 1.1 context, and every term it defines is
protected.
Aries RFC 0067 and DIDComm Messaging v2.0 define these terms for DID
documents, but neither gives them an IRI or publishes a context. W3C DID Core
1.1 asks producers not to write terms that their @context does not
define (§6.2.3). A DID document that carries a DIDComm service names this
context after the DID Core base context:
"@context": [
"https://www.w3.org/ns/did/v1.1",
"https://w3id.org/aegis/didcomm/v1"
]
Each term below keeps the meaning its specification gives it. Quotations are from Aries RFC 0067: DIDComm DID document conventions, §3.2 "Service Conventions" and DIDComm Messaging v2.0, §9.4.9 "Service Endpoint".
Terms
did-communication
- IRI
https://w3id.org/aegis/didcomm#did-communication- Kind
- A service type: the value of a DID document service's
type. - Scoped terms
priority,recipientKeys,routingKeys,accept- Source
- Aries RFC 0067, §3.2
type : Required by the Service Endpoints Spec. It is mandatory that this field is set to did-communication
DIDCommMessaging
- IRI
https://w3id.org/aegis/didcomm#DIDCommMessaging- Kind
- A service type: the value of a DID document service's
type. Its scoped context propagates into the objects of the service'sserviceEndpoint. - Scoped terms
uri,accept,routingKeys- Source
- DIDComm Messaging v2.0, §9.4.9
type- REQUIRED. MUST beDIDCommMessaging.
priority
- IRI
https://w3id.org/aegis/didcomm#priority- Value
- An
xsd:nonNegativeIntegerliteral. - Used in
did-communication- Source
- Aries RFC 0067, §3.2
priority : This represents the priority of the service endpoint, used for distinction when multipledid-communicationservice endpoints are present in a single DID document. It is mandatory that this field is set to an unsigned integer with the default value of0.
recipientKeys
- IRI
https://w3id.org/aegis/didcomm#recipientKeys- Value
- A set of IRIs (
@type: @id,@container: @set). - Used in
did-communication- Source
- Aries RFC 0067, §3.2
recipientKeys : This is an array of did key references used to denote the default recipients of an endpoint.
routingKeys
- IRI
https://w3id.org/aegis/didcomm#routingKeys- Value
- An ordered list of IRIs (
@type: @id,@container: @list). - Used in
did-communication,DIDCommMessaging- Source
- Aries RFC 0067, §3.2; DIDComm Messaging v2.0, §9.4.9
routingKeys: This is an array of did key references, ordered from most destward to most srcward, used to denote the individual routing hops in between the sender and recipients. (Aries RFC 0067)
routingKeys - OPTIONAL. An ordered array of strings referencing keys to be used when preparing the message for transmission as specified in Sender Process to Enable Forwarding. (DIDComm Messaging v2.0)
accept
- IRI
https://w3id.org/aegis/didcomm#accept- Value
- An ordered list of string literals (
@container: @list), each a media type. - Used in
did-communication,DIDCommMessaging- Source
- Aries RFC 0067, §3.2; DIDComm Messaging v2.0, §9.4.9
accept- [optional] an array of media types in the order of preference for sending a message to the endpoint. Ifacceptis not specified, the sender uses its preferred choice for sending a message to the endpoint. (Aries RFC 0067)
accept- OPTIONAL. An array of media types in the order of preference for sending a message to the endpoint. These identify a profile of DIDComm Messaging that the endpoint supports. Ifacceptis not specified, the sender uses its preferred choice for sending a message to the endpoint. (DIDComm Messaging v2.0)
uri
- IRI
https://w3id.org/aegis/didcomm#uri- Value
- An IRI (
@type: @id). - Used in
DIDCommMessaging, in each object of itsserviceEndpoint- Source
- DIDComm Messaging v2.0, §9.4.9
uri - REQUIRED. MUST contain a URI for a transport specified in the transports section of this spec, or a URI from Alternative Endpoints.