responses: make messages and errors default if not present #175
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
Both fields are often not returned by certain cloudflare APIs (the Zero Trust API is a good example). Allowing serde to default them if not present allows these APIs to be used with this crate.
adamchalmers
reviewed
Mar 8, 2022
| @@ -9,7 +9,9 @@ use serde_json::value::Value as JsonValue; | |||
| pub struct ApiSuccess<ResultType> { | |||
| pub result: ResultType, | |||
| pub result_info: Option<JsonValue>, | |||
| #[serde(default)] | |||
There was a problem hiding this comment.
I think it's more correct to make this Option<JsonValue>, rather than defaulting to JsonValue::Null. What do you think @sssilver -- one downside is that it would be a breaking change (although a very easy to fix one)
There was a problem hiding this comment.
I agree with @adamchalmers here. The reason I chose to do it this way is that I felt that we could do just a simple patch release with the changes from this and #174 if we kept this nonbreaking. However, I think that Adam's idea is the better API, and I was originally contemplating doing that for this reason.
|
@adamchalmers @sssilver I'd like to get this in. Which approach do we want to go with here? |
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.
Both fields are often not returned by certain cloudflare APIs (the Zero Trust API is a good example). Allowing serde to default them if not present allows these APIs to be used with this crate.