Skip to content

Commit

Permalink
Add and fix anchors from vocabulary document to specification.
Browse files Browse the repository at this point in the history
  • Loading branch information
msporny committed Dec 28, 2023
1 parent cb50d01 commit e7d7fe9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 27 deletions.
46 changes: 22 additions & 24 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -467,13 +467,13 @@ <h3>BitstringStatusListCredential</h3>
</tr>
<tr>
<td>credentialSubject.type</td>
<td>
<td id="BitstringStatusList">
The `type` of the credential <a>subject</a>, which is the
status list, MUST be `BitstringStatusList`.
</td>
</tr>
<tr>
<td>credentialSubject.statusPurpose</td>
<td id="statusPurpose">credentialSubject.statusPurpose</td>
<td>
The purpose of the status entry MUST be a string. While the value of the
string is arbitrary, the following values MUST be used for their intended
Expand Down Expand Up @@ -505,7 +505,7 @@ <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 defined
`credentialSubject.statusMessage`. `credentialSubject.size` MUST be defined
with this `statusPurpose`.
</td>
</tr>
Expand All @@ -514,7 +514,7 @@ <h3>BitstringStatusListCredential</h3>
</td>
</tr>
<tr>
<td>credentialSubject.encodedList</td>
<td id="encodedList">credentialSubject.encodedList</td>
<td>
The `encodedList` property of the credential <a>subject</a> MUST be
the GZIP-compressed [[RFC1952]], base-64 encoded [[RFC4648]] bitstring values
Expand All @@ -529,7 +529,7 @@ <h3>BitstringStatusListCredential</h3>
</td>
</tr>
<tr>
<td>credentialSubject.ttl</td>
<td id="ttl">credentialSubject.ttl</td>
<td>
The `ttl` indicates the "time to live" in milliseconds. This property MAY be
present. If not present, implementers MUST use a value of `300000` for this
Expand All @@ -541,39 +541,37 @@ <h3>BitstringStatusListCredential</h3>
</td>
</tr>
<tr>
<td>credentialSubject.size</td>
<td id="size">credentialSubject.size</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.statusMessages` MUST be present, and the number of status
`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>
credentialSubject.statusMessages
</td>
<td>
The `statusMessages` property MUST be an array. If present,
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`. `statusMessages` MAY be present if
`size` is `1`. `statusMessages` MUST be present if
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
associated with the bit value of `0` is "unset" and the bit
value of `1` is "set".
If present, elements in the `statusMessages` array MUST contain at
If present, elements in the `statusMessage` array MUST contain at
minimum two properties:
<ul>
<li>
<li id="status">
`status`, being a string of the hex value of the status
</li>
<li>
`value`, being a string containing the associated message
<li id="message">
`message`, being a string containing the associated message
</li>
</ul>
Implementers MAY add additional values to objects in the `statusMessages` array.
Implementers MAY add additional values to objects in the `statusMessage` array.
Implementers MAY use the string value of `undefined` in the value to indicate
that a corresponding status is not defined for the associated status value, but
that it may be defined in the future. Rules for how to handle various status
Expand All @@ -583,7 +581,7 @@ <h3>BitstringStatusListCredential</h3>
</td>
</tr>
<tr>
<td>credentialSubject.reference</td>
<td id="reference">credentialSubject.reference</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`
Expand Down Expand Up @@ -640,10 +638,10 @@ <h3>BitstringStatusListCredential</h3>
"statusPurpose": "<span class="highlight">status</span>",
"reference": "https://example.org/status-dictionary/",
"size": 2,
"statusMessages": [
{"status":"0x0", "value":"valid"},
{"status":"0x1", "value":"invalid"},
{"status":"0x2", "value":"pending_review"},
"statusMessage": [
{"status":"0x0", "message":"valid"},
{"status":"0x1", "message":"invalid"},
{"status":"0x2", "message":"pending_review"},
...
],
"encodedList": "H4sIAAAAAAAAA-3BMQEAAADAAAAAAAAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA"
Expand Down Expand Up @@ -749,7 +747,7 @@ <h3>Validate Algorithm</h3>
return `true` if `status` is `1`, and return `false`
if `status` has any other value. For other `statusPurpose`,
return the corresponding `value` of the `status`
as indicated in the `statusMessages` array.
as indicated in the `statusMessage` array.
</li>
</ol>
</section>
Expand Down
6 changes: 3 additions & 3 deletions vocab/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ property:
domain: sl:BitstringStatusList
range: xsd:string

- id: value
label: Hexadecimal value of a message
defined_by: https://www.w3.org/TR/vc-bitstring-status-list/#value
- id: status
label: Hexadecimal value of a status message
defined_by: https://www.w3.org/TR/vc-bitstring-status-list/#status
range: xsd:string

- id: message
Expand Down

0 comments on commit e7d7fe9

Please sign in to comment.