Skip to content

docs: explain indexAllocator for status updates#625

Draft
PatStLouis wants to merge 1 commit intomainfrom
document-index-allocator-594
Draft

docs: explain indexAllocator for status updates#625
PatStLouis wants to merge 1 commit intomainfrom
document-index-allocator-594

Conversation

@PatStLouis
Copy link
Copy Markdown
Collaborator

@PatStLouis PatStLouis commented Apr 14, 2026

Expand OpenAPI description and Update Status prose: why index bookkeeping exists, when multiple allocators apply, linkage to issuance, and that values are implementation-defined.

Fix UpdateCredentialStatusRequest example JSON (boolean true).

Closes #594.


💥 Error: 500 Internal Server Error 💥

PR Preview failed to build. (Last tried on Apr 14, 2026, 6:29 PM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 Spec Generator - Spec Generator is the web service used to build bikeshed/ReSpec specs

🔗 Related URL

Error output:

EISDIR: illegal operation on a directory, open 'uploads/M1Ob45/'

This seems to be an issue with the Spec Generator service. PR Preview doesn't manage this service and so has no control over it. If you've identified an issue with it, you can report the issue to the maintainers of Spec Generator directly. Please be courteous. Thank you!

If you don't have enough information above to solve the error by yourself or if the issue doesn't seem related to Spec Generator, you can file an issue with PR Preview.

Expand OpenAPI description and Update Status prose: why index bookkeeping
exists, when multiple allocators apply, linkage to issuance, and that
values are implementation-defined.

Fix UpdateCredentialStatusRequest example JSON (boolean true).

Closes #594.

Signed-off-by: Patrick St-Louis <patrick.st-louis@opsecid.ca>
Made-with: Cursor
Comment thread oas.yaml
internal bookkeeping (free lists, counters, per-tenant pools, etc.) so indices are
not double-assigned and updates target the correct row. When multiple allocators
exist—for example, separate pipelines per tenant, environment, or
`statusPurpose`—`indexAllocator` tells the service which registry or policy to
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`statusPurpose``indexAllocator` tells the service which registry or policy to
`statusPurpose` `indexAllocator` tells the service which registry or policy to

Comment thread index.html

<p>
Status mechanisms associate each [=verifiable credential=] with a
<code>statusListIndex</code> in a list (see, for example, [[VC-BITSTRING-STATUS-LIST]]).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<code>statusListIndex</code> in a list (see, for example, [[VC-BITSTRING-STATUS-LIST]]).
<code>statusListIndex</code> in a list (see, for example, the [[[VC-BITSTRING-STATUS-LIST]]] specification).

@PatStLouis PatStLouis marked this pull request as draft April 14, 2026 19:59
@PatStLouis PatStLouis marked this pull request as draft April 14, 2026 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document indexAllocator in more detail

3 participants