Skip to content

add error_msg to BaseReply failure schema #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

guusbertens
Copy link

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 an error_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.

@guusbertens guusbertens requested a review from a team as a code owner May 23, 2025 21:53
@Mythir
Copy link
Contributor

Mythir commented May 26, 2025

Hey Guus, thanks for the PR! This issue has been on our radar since you brought it up during the meeting we had. We still have to make a final decision on it, but I'll see if I can expedite it a little bit. Maybe we can even go a bit further than your suggested change and unify all the failure messages into a single schema.

@guusbertens guusbertens closed this by deleting the head repository Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants