Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BitstringStatusList context to align with latest spec. #109

Merged
merged 6 commits into from
Jan 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions contexts/2021/v1.jsonld
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"@context": {
"@protected": true,

"StatusList2021Credential": {
"@id":
"https://w3id.org/vc/status-list#StatusList2021Credential",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",

"description": "http://schema.org/description",
"name": "http://schema.org/name"
}
},

"StatusList2021": {
"@id":
"https://w3id.org/vc/status-list#StatusList2021",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",

"statusPurpose":
"https://w3id.org/vc/status-list#statusPurpose",
"encodedList": "https://w3id.org/vc/status-list#encodedList"
}
},

"StatusList2021Entry": {
"@id":
"https://w3id.org/vc/status-list#StatusList2021Entry",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",

"statusPurpose":
"https://w3id.org/vc/status-list#statusPurpose",
"statusListIndex":
"https://w3id.org/vc/status-list#statusListIndex",
"statusListCredential": {
"@id":
"https://w3id.org/vc/status-list#statusListCredential",
"@type": "@id"
}
}
}
}
}
51 changes: 28 additions & 23 deletions contexts/v1.jsonld
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,56 @@
"@context": {
"@protected": true,

"StatusList2021Credential": {
"@id":
"https://w3id.org/vc/status-list#StatusList2021Credential",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",
"BitstringStatusListCredential": "https://www.w3.org/ns/credentials/status#BitstringStatusListCredential",

"description": "http://schema.org/description",
"name": "http://schema.org/name"
}
},

"StatusList2021": {
"@id":
"https://w3id.org/vc/status-list#StatusList2021",
"BitstringStatusList": {
"@id": "https://www.w3.org/ns/credentials/status#BitstringStatusList",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",

"statusPurpose":
"https://w3id.org/vc/status-list#statusPurpose",
"encodedList": "https://w3id.org/vc/status-list#encodedList"
"https://www.w3.org/ns/credentials/status#statusPurpose",
"encodedList":
"https://www.w3.org/ns/credentials/status#encodedList",
"ttl": "https://www.w3.org/ns/credentials/status#ttl",
"statusReference":
"https://www.w3.org/ns/credentials/status#statusReference",
"statusSize":
"https://www.w3.org/ns/credentials/status#statusSize",
"statusMessage": {
"@id": "https://www.w3.org/ns/credentials/status#statusMessage",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",

"status": "https://www.w3.org/ns/credentials/status#status",
"message": "https://www.w3.org/ns/credentials/status#message"
}
}
}
},

"StatusList2021Entry": {
"BitstringStatusListEntry": {
"@id":
"https://w3id.org/vc/status-list#StatusList2021Entry",
"https://www.w3.org/ns/credentials/status#BitstringStatusListEntry",
"@context": {
"@protected": true,

"id": "@id",
"type": "@type",

"statusPurpose":
"https://w3id.org/vc/status-list#statusPurpose",
"https://www.w3.org/ns/credentials/status#statusPurpose",
"statusListIndex":
"https://w3id.org/vc/status-list#statusListIndex",
"https://www.w3.org/ns/credentials/status#statusListIndex",
"statusListCredential": {
"@id":
"https://w3id.org/vc/status-list#statusListCredential",
"https://www.w3.org/ns/credentials/status#statusListCredential",
"@type": "@id"
}
}
Expand Down
42 changes: 21 additions & 21 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -541,8 +541,8 @@ <h3>BitstringStatusListCredential</h3>
<td>
Used to indicate a status message associated with a <a>verifiable
credential</a>. The status message descriptions MUST be defined in
`credentialSubject.statusMessages`. `credentialSubject.size` MUST be specified
when this `statusPurpose` value is used.
`credentialSubject.statusMessages`. `credentialSubject.statusSize` MUST be
specified when this `statusPurpose` value is used.
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -577,24 +577,24 @@ <h3>BitstringStatusListCredential</h3>
</td>
</tr>
<tr>
<td id="size">credentialSubject.size</td>
<td id="statusSize">credentialSubject.statusSize</td>
<td>
The `size` indicates the size of the status entry in bits. `size` MAY be
provided. If `size` is not present as a property of the `credentialStatus`, then
`size` MUST be processed as `1`. `size` MUST be an integer greater than zero.
If `size` is provided and is greater than `1`, then the property
`credentialStatus.statusMessage` MUST be present, and the number of status
messages must equal the number of possible values.
The `statusSize` indicates the size of the status entry in bits. `statusSize`
MAY be provided. If `statusSize` is not present as a property of the
`credentialStatus`, then `statusSize` MUST be processed as `1`. `statusSize`
MUST be an integer greater than zero. If `statusSize` is provided and is greater
than `1`, then the property `credentialStatus.statusMessage` MUST be present,
and the number of status messages must equal the number of possible values.
</td>
</tr>
<tr>
<td id="statusMessage">credentialSubject.statusMessage</td>
<td>
The `statusMessage` property MUST be an array. If present,
the length of the array must equal the number of possible status states
indicated by `size`. `statusMessage` MAY be present if
`size` is `1`. `statusMessage` MUST be present if
`size` is greater than `1`. If not present, the message value
indicated by `statusSize`. `statusMessages` MAY be present if
`statusSize` is `1`. `statusMessages` MUST be present if
`statusSize` is greater than `1`. If not present, the message value
associated with the bit value of `0` is "unset" and the bit
value of `1` is "set".
If present, elements in the `statusMessage` array MUST contain at
Expand All @@ -617,16 +617,16 @@ <h3>BitstringStatusListCredential</h3>
</td>
</tr>
<tr>
<td id="reference">credentialSubject.reference</td>
<td id="statusReference">credentialSubject.statusReference</td>
<td>
The `reference` property provides a point for implementers to include a [[URL]]
to material related to the status. An implementer MAY include the `reference`
property, and if they do, the value MUST be a [[URL]] or an array of URLs.
Implementers using a `statusPurpose` of `status` are strongly encouraged to
provide a `reference`.
The `statusReference` property provides a point for implementers to include a
[[URL]] to material related to the status. An implementer MAY include the
`statusReference` property, and if they do, the value MUST be a [[URL]] or an
array of URLs. Implementers using a `statusPurpose` of `status` are strongly
encouraged to provide a `statusReference`.
<p class="note" title="Details around reference">
`reference` is especially important when interpretation of the status for a
credential may involve some understanding of the business case involved.
`statusReference` is especially important when interpretation of the status for
a credential may involve some understanding of the business case involved.
</p>
</td>
</tr>
Expand Down Expand Up @@ -832,7 +832,7 @@ <h3>Bitstring Generation Algorithm</h3>
corresponding `statusListIndex` value in
a credential in `issuedCredentials`, set the value to the
appropriate status. The position of the value is computed as `statusListIndex`
times the `size`.
times the `statusSize`.
</li>
<li>
Generate a |compressed bitstring| by using the GZIP
Expand Down
6 changes: 3 additions & 3 deletions vocab/vocabulary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ontology:
value: Verifiable Credentials Bitstring Status List v1.0

- property: dc:description
value: RDFS [[RDF-SCHEMA]] vocabulary used by the [[[VC-BITSTRING-STATUS-LIST]]] [[VC-BITSTRING-STATUS-LIST]]
value: RDFS [[RDF-SCHEMA]] vocabulary used by the [[[VC-BITSTRING-STATUS-LIST]]] [[VC-BITSTRING-STATUS-LIST]]

- property: rdfs:seeAlso
value: https://www.w3.org/TR/vc-bitstring-status-list/
Expand Down Expand Up @@ -64,7 +64,7 @@ property:

- id: size
label: Bitstring entry size in bits
defined_by: https://www.w3.org/TR/vc-bitstring-status-list/#size
defined_by: https://www.w3.org/TR/vc-bitstring-status-list/#statusSize
domain: cs:BitstringStatusList
range: xsd:string

Expand All @@ -86,6 +86,6 @@ property:

- id: reference
label: Reference documentation for status messages
defined_by: https://www.w3.org/TR/vc-bitstring-status-list/#reference
defined_by: https://www.w3.org/TR/vc-bitstring-status-list/#statusReference
domain: cs:BitstringStatusList
range: xsd:string
Loading