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

[C#][client][csharp-netcore] Fix csharp netcore defaultheaders #3562

Merged
merged 2 commits into from
Aug 8, 2019
Merged

[C#][client][csharp-netcore] Fix csharp netcore defaultheaders #3562

merged 2 commits into from
Aug 8, 2019

Conversation

mario-d-s
Copy link
Contributor

@mario-d-s mario-d-s commented Aug 5, 2019

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.
    @mandrean (2017/08), @jimschubert (2017/09)

Description of the PR

Fix #3561

Previously, the .NET Core SDK would not send configured default headers. This PR fixes this and also "fixes" the strange singular name of the property by marking it obsolete and redirecting to the new correctly-named plural form.

This second change is a separate commit and is less important so I'd drop it if need be.

@mario-d-s mario-d-s changed the title Fix csharp netcore defaultheaders [csharp-netcore] Fix csharp netcore defaultheaders Aug 5, 2019
@mario-d-s mario-d-s changed the title [csharp-netcore] Fix csharp netcore defaultheaders [C#][client][csharp-netcore] Fix csharp netcore defaultheaders Aug 5, 2019
@wing328
Copy link
Member

wing328 commented Aug 6, 2019

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@@ -94,7 +94,7 @@ namespace {{packageName}}.Client
{
UserAgent = "{{#httpUserAgent}}{{.}}{{/httpUserAgent}}{{^httpUserAgent}}OpenAPI-Generator/{{packageVersion}}/csharp{{/httpUserAgent}}";
BasePath = "{{{basePath}}}";
DefaultHeader = new {{^net35}}Concurrent{{/net35}}Dictionary<string, string>();
DefaultHeaders = new {{^net35}}Concurrent{{/net35}}Dictionary<string, string>();
Copy link
Member

Choose a reason for hiding this comment

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

@mario-d-s I suggest we keep DefaultHeader as switching to DefaultHeaders will make this PR a breaking changes (without fallback), which means we will need to target this change to 5.0.x branch instead (scheduled to be released next year May)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As a matter of fact I do keep the DefaultHeader around and loop it through the new DefaultHeaders (both get and set), but marked it as obsolete (see). I subsequently adjusted the rest of the files from using the obsolete property to the new one.

That is not to say I might not have missed a place where this is a breaking change, in that case please let me know but it should be safe AFAIK.

Copy link
Member

Choose a reason for hiding this comment

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

Let's go with what you've and see if the community (users) spot anything we missed.

@mario-d-s
Copy link
Contributor Author

mario-d-s commented Aug 6, 2019

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

Oh thanks for spotting that! That's what you get when working from your day-job machine 😅. Let's get that straightened up. Fixed it!

@wing328
Copy link
Member

wing328 commented Aug 8, 2019

CircleCI failure has been fixed in the master.

@wing328 wing328 closed this Aug 8, 2019
@wing328 wing328 reopened this Aug 8, 2019
@wing328 wing328 merged commit fbb2f1e into OpenAPITools:master Aug 8, 2019
@wing328 wing328 added this to the 4.1.0 milestone Aug 8, 2019
@wing328
Copy link
Member

wing328 commented Aug 10, 2019

@mario-d-s thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

jimschubert added a commit that referenced this pull request Aug 11, 2019
* master: (122 commits)
  Fix #3604 by adding undefined as return type to headers and credentials methods in runtime.ts (#3605)
  Prepare 4.1.1-SNAPSHOT (#3603)
  Prepare 4.1.0 release (#3597)
  [java][client][jax-rs] Add a constant for Jackson @JsonProperty (#3560)
  restore openapi3 petstore.yaml (#3590)
  Add a new NodeJS Express server generator (#3567)
  [C#][client][csharp-netcore] Fix csharp netcore defaultheaders (#3562)
  Fix issue deserializing to nullptr (#3572)
  [OCaml] Add file post-processing (#3583)
  [dart2] Fix up test code generation, double deserialization, 'new' keyword deprecation (#3576)
  Run Qt5 client sample test (#3415)
  typescript-fetch: allow configuration of headers and credentials (#3586)
  using partials in ruby api_client (#3564)
  [OCaml] Added optional params support in API operations (#3568)
  [Rust Server] Generate valid Rustdocs for lazy_static items (#3556)
  Fix NPM build for Typescript-fetch (#3403)
  Expand path templates via resttemplate's uriTemplateHandler (#3500)
  Readme updated with a new tutorial and company using OpenAPI Generator (#3566)
  Fix logic of `getNullableType` of csharp server and client. (#3537)
  [Ruby] clean up Ruby dev dependencies (#3551)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] [csharp-netcore] DefaultHeader in Configuration are ignored
2 participants