docs(changelog): name the openid4vci surface and the consumer's obligations - #148
Merged
Conversation
…ations 1.23.0 shipped openvc.openid4vci to PyPI, but its changelog entry named five of the fourteen public symbols and carried neither of the two obligations ADR-0007 places on the integrator. A release note is where an integrator actually reads them, and there is a downstream issuer being built against exactly this contract. Adds the full surface list, and both obligations: check_nonce must be atomic (a SET NX or a DELETE ... RETURNING, never a read-then-write, and explicitly not openvc.cache.TtlCache, whose documented lack of single-flight is fatal for a single-use token), and codes and identifiers are the consumer's to mint. The bounded claim was already correct and is untouched: OpenID4VCI 1.0 key-proof verification, not "issuance" and not HAIP. Closes #146
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #146.
1.23.0 already ships
openvc.openid4vci— it is on PyPI asopenvc-core 1.23.0(uploaded 2026-07-24 21:42), the wheel carries
openvc/openid4vci.pyandkeys.jwk_thumbprint, anddocs/api/openid4vci.mdand the wiki guide are live. So therelease half of #146 is done; what was missing is what the issue asks the release notes
to carry.
fourteen.
integrator reads before wiring this up. Both are now in the entry:
check_noncemustbe atomic — a
SET … NXor aDELETE … RETURNING, never a read-then-write, andexplicitly not
openvc.cache.TtlCache, whose documented lack of single-flight isbenign for a read cache and fatal for a single-use token — and codes and identifiers
(pre-authorized code,
transaction_id,notification_id) are the consumer's to mint.The bounded claim the issue asks to repeat — OpenID4VCI 1.0 key-proof verification,
not "issuance", not HAIP — was already stated correctly in both the changelog and the
GitHub release, and is untouched.
Docs only: no source, no test, no version change.