Fix description of error code for invalid state #182
Merged
Conversation
This file contains 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
tulshi
approved these changes
Jun 10, 2024
FragLegs
deleted the
171-clarify-expected-response-when-state-is-incorrect-for-verification-event
branch
appsdesh
reviewed
Jun 10, 2024
| @@ -1761,8 +1761,8 @@ sub_id | |||
| Upon receiving a Verification Event, the Event Receiver SHALL parse the SET and | |||
| validate its claims. In particular, the Event Receiver SHALL confirm that the | |||
| value for "state" is as expected. If the value of "state" does not match, an | |||
| error response of "setData" SHOULD be returned (see Section 2.3 of | |||
| {{RFC8935}} or {{RFC8936}}). | |||
| error response with the "err" field set to "invalid_state" SHOULD be returned (see Section 2.4 of | |||
There was a problem hiding this comment.
@FragLegs I feel we should link 2.3 from RFC8935 or an example
HTTP/1.1 400 Bad Request
Content-Language: en-US
Content-Type: application/json
{
"err": "invalid_state",
"description": "verification event contained "state" claim not expected by the reciever"
}
|
|
||
| Description | ||
|
|
||
| > Indicates that a Verification event contained a "state" claim that does not |
There was a problem hiding this comment.
To align with other SSF error code description, suggesting following
The SSF verification event contained "state" claim not expected by the receiver
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 the language around an invalid state in the Verification event and requests that we add
invalid_stateto the IANA registry of SET error codes.Please let me know if this seems like a reasonable format for the IANA request.