Clarify Connect error debug property type #199
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
Signed-off-by: Timo Stamm <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
akshayjshah
reviewed
Sep 10, 2024
| @@ -606,7 +606,7 @@ resulting object under the "debug" key. Clients must not depend on data in the | |||
| { | |||
| "type": "google.rpc.RetryInfo", | |||
| "value": "CgIIPA", | |||
| "debug": {"retryDelay": "30s"}, | |||
akshayjshah
approved these changes
Sep 10, 2024
timostamm
deleted the
tstamm/Clarify-Connect-error-debug-property-type
branch
jhump
pushed a commit
to connectrpc/conformance
that referenced
this pull request
Sep 11, 2024
Connect clients must not depend on data in the "debug" key when deserializing details from an Error or EndStreamResponse. This PR adds a test where the "debug" key contains data that does not match the error detail, and is not a JSON object (see clarification regarding the property type here [here](connectrpc/connectrpc.com#199)).
smaye81
pushed a commit
that referenced
this pull request
Sep 30, 2024
Signed-off-by: Steve Ayers <[email protected]>
smaye81
pushed a commit
that referenced
this pull request
Sep 30, 2024
Signed-off-by: Steve Ayers <[email protected]>
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.
The protocol spec refers to an "object" for the optional debug data in Error and EndStreamResponse. Since some well-known Protobuf types such as
google.protobuf.Timestampserialize to a JSON value, not an object, the debug data can actually contain any JSON value.