respect the 'by_alias' route config also in generated docs for 'json body' data #1193
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
|
Thank you for PR - could you also make a test case that covers this ? |
…the "by_alias" parameter. Also ran "make format" that altered client.py and schema.py, since CI was complaning about the formating.
…CI runs the format check
|
I have added tests for it now. Feel free to check it out. I think the CI should succeed. On another note: It seems like the "make lint" uses a ruff formatting that is incompatible with the formatting check on the CI. |
|
Hey @kristian-lindin this was super helpful for a similar issue I was facing, thanks! @vitalik is there anything else this needs before it's ready to merge? Happy to assist if so. |
|
@vitalik Please let me know if there is anything else I can do to move this PR forward. |
|
@vitalik As mentioned, I feel like this PR should be ready. Let me know if I can do anything to get this PR to move forward or help in any way! |
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.
if you have an alias_generator to_camel, the current behavior does not respect the by_alias config from the router when it comes to request body data and how the api documentation then is generated for that request body. Today the code that generates the request body docs, defaults to True without ever passing the operation.by_alias into the function.
This PR should correct that.