add error_msg to BaseReply failure schema #34
Closed
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.
According to the documentation, all BaseReply failure messages must contain
payload.error_msg
, but there is no mention of this in the JSON schema. As a consequence, the generated Python Pydantic models cannot be used to generate failure messages with anerror_msg
.This PR modifies the schema so that an
error_msg
is present.This PR does not make
error_msg
required, even though the docs require it. Doing so would make the generated Pydantic models incompatible with other Python codes that might use these.