Skip to content
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

[csharp-netcore] Fix handling of Dictionary query parameters and fix deepObject style parameter handling #8848

Merged
merged 7 commits into from
Mar 3, 2021

Conversation

Blackclaws
Copy link
Contributor

@Blackclaws Blackclaws commented Feb 26, 2021

This was triggered by this issue which it should close #8798

Looking into the issue I found that indeed SwaggerUI and the csharp-netcore client libraries were generating different queries. Neither of which was getting read by the newly updated aspnetcore generator (#8826). It appears that neither format was acceptable there and this is also something Swashbuckle needs to fix (domaindrivendev/Swashbuckle.AspNetCore#2034) as their generated spec does not actually work with the controller its supposed to query.

This pull request does two things:

  • Fix default handling so that it corresponds to what SwaggerUI is doing for Dictionaries
  • Fix deepObject handling so that it works for required parameters as well
  • Fix deepObject handling for Dictionary style inline objects with no properties defined (this might not be completely to spec, but it makes sense to do so, see also: https://swagger.io/docs/specification/serialization/,
  • Fix NullPointerException caused by the DefaultCodegen not finding a Schema

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Closes #8798

@wing328
Copy link
Member

wing328 commented Mar 3, 2021

cc @OpenAPITools/generator-core-team as well since the change covers DefaultCodegen

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I've not tested it locally

@wing328 wing328 merged commit 8c2a0ce into OpenAPITools:master Mar 3, 2021
@wing328
Copy link
Member

wing328 commented Mar 3, 2021

@Reinhard-PTV can you please test the test latest master to see if this change also works for your use case? Thank you.

@wing328
Copy link
Member

wing328 commented Mar 4, 2021

@Reinhard-PTV thank you.

We've added a new library option httpclient so you may want to give it a try as well if you prefer it over restsharp.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants