fix: mark embedded auth type parameters required in OpenRPC - #802
Open
wakqasahmed wants to merge 1 commit into
Open
Conversation
Fixes Universal-Commerce-Protocol#787. The Embedded Protocol prose defines the ec.auth/ep.cart.auth authorization request 'type' as REQUIRED, but the OpenRPC content descriptors for both methods omitted "required": true. Under OpenRPC an omitted required defaults to false, so downstream generators produced an optional type param, contradicting the normative prose. Added a small contract test that fails if either descriptor drifts from required=true again.
damaz91
added
the
status:needs-triage
carolinerg1
added
status:under-review
and removed
status:needs-triage
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
3 participants
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.
Fixes #787.
The Embedded Protocol prose defines the
ec.auth/ep.cart.authauthorization requesttypeas REQUIRED, but the OpenRPC content descriptors for both methods omitted"required": true. Under OpenRPC an omittedrequireddefaults to false, so downstream generators produced an optionaltypeparam, contradicting the normative prose and permitting requests a conforming embedded context should never send.Added
scripts/test_embedded_auth_required.py, a small contract test asserting both descriptors stayrequired: true(verified it fails against the pre-fix schema and passes after).I read AGENTS.md's note that core schema edits may need an Enhancement Proposal -- treating this as a straightforward correction to match already-published normative prose rather than a new/breaking change, per how the issue itself describes it, but happy to follow whatever process the maintainers prefer if they see it differently.