-
Notifications
You must be signed in to change notification settings - Fork 53
docs: explain indexAllocator for status updates #625
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
Draft
PatStLouis
wants to merge
4
commits into
main
Choose a base branch
from
document-index-allocator-594
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3765,6 +3765,38 @@ <h5>Update Status</h5> | |||||
| list credential accordingly. | ||||||
| </p> | ||||||
|
|
||||||
| <p> | ||||||
| Issuer instances are responsible for assigning one or more status entries to | ||||||
| the Verifiable Credentials they issue. Issuer software is expected to ensure | ||||||
| that it does not overallocate or misallocate status metadata (e.g., status | ||||||
| lists or list indexes), as this overallocated, misallocated, or unused | ||||||
| information can create privacy harms both to holders and issuers of Verifiable | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Credentials. In architectures that are highly available, horizontally scalable, | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| or distributed, or any combination of these, this can can be especially | ||||||
| challenging unless status allocation state is appropriately shared, identified, | ||||||
| and referenced across disparate components. The `indexAllocator` field can be | ||||||
| used to identify and refer to shared state, allowing for better coordination | ||||||
| as well as atomic allocation and use of status metadata. | ||||||
| </p> | ||||||
| <p> | ||||||
| Status mechanisms associate each [=verifiable credential=] with a | ||||||
| <code>statusListIndex</code> in a list (see, for example, the [[[VC-BITSTRING-STATUS-LIST]]] specification). | ||||||
| Implementations that assign those indices usually track which values are in use so | ||||||
| indices are not reused incorrectly and status updates modify the correct entry. When a | ||||||
| status service supports more than one such tracker—such as separate allocators per | ||||||
| tenant, deployment, or <code>statusPurpose</code>—the optional <code>indexAllocator</code> | ||||||
| request field names which allocator context applies to this update. The same identifier | ||||||
| would typically have been fixed or returned when the index was originally assigned at | ||||||
| issuance (or when the list was provisioned), so issuance and status-update flows stay | ||||||
| consistent even though list creation and credential issuance are separate API surfaces | ||||||
| in this specification. | ||||||
| </p> | ||||||
|
|
||||||
| <p class="note" title="indexAllocator values"> | ||||||
| Permitted <code>indexAllocator</code> strings are implementation-defined; this | ||||||
| specification does not mandate particular values or a discovery mechanism for them. | ||||||
| </p> | ||||||
|
|
||||||
| <div class="api-detail" | ||||||
| data-api-endpoint="post /credentials/status"></div> | ||||||
| </section> | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.