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

Disable warning CS8604 "Possible null reference argument for parameter" in generated code #4422

Conversation

NoahStolk
Copy link
Contributor

We'd like to use <WarningsAsErrors>nullable</WarningsAsErrors> in our code base to enforce strict NRT checks. However, a lot of CS8604 warnings are emitted in generated NSwag code, causing build errors when enabling this build property.

image

Seeing that CS8603 is already disabled, it seems reasonable to disable CS8604 as well.

An alternative would be to disable NRT warnings in generated code altogether, using #nullable disable warnings, which disables these warnings if I'm not mistaken.

@NoahStolk NoahStolk changed the title Disable warning CS8604 "Possible null reference argument for parameter" in code generation file header template Disable warning CS8604 "Possible null reference argument for parameter" in generated code May 11, 2023
@RicoSuter RicoSuter merged commit 57f6b27 into RicoSuter:master Aug 15, 2023
@RicoSuter
Copy link
Owner

Thanks for the PR.

@NoahStolk NoahStolk deleted the disable-warning-CS8604-in-code-generation-file-header-template branch August 15, 2023 19:33
shuruev added a commit to servicetitan/NSwag that referenced this pull request Nov 16, 2023
* Update README.md

* Add nswag.cmd (RicoSuter#4255)

* v13.18.1

* v13.18.2

* Remove description from OpenApiResponse when serializing for Swagger v2 (RicoSuter#4314)

* Remove description from OpenApiResponse when serializing for Swagger v2 to prevent error "Structural error at paths.somepath.get.responses.304 should NOT have additional properties additionalProperty: description" [PR].

* Remove description from OpenApiResponse when serializing for Swagger v2 to prevent error "Structural error at paths.somepath.get.responses.304 should NOT have additional properties additionalProperty: description" [PR].

* Add check for IsBindingAllowed so that BindNever attribute works correctly

* Add CS0612 to the File.Header.liquid (RicoSuter#4409)

OpenApi which contains deprecated schemas correctly generates `[Obsolete]` attribute. If the API document does not propagate `deprecate` all the way to path/method resulting c# code produce warning CS0612: '...' is obsolete

* Update Client.Class.liquid (RicoSuter#4402)

Fix Newtonsoft.Json being used instead of System.Text.Json

* Descriptive exception for duplicate XML doc line (RicoSuter#2863) (RicoSuter#4388)

Duplicate response code in XML documentation response xml tag causes
somewhat hard to debug exception, which is now made more descriptive.

Did not yet figure out how to make an unit test for this one or if some
other other exception type would be more suitable than
InvalidOperationException.

Bug: Duplicate return code declaration causes nasty exception
id: RicoSuter#2863

Co-authored-by: Antti Viita <[email protected]>

* Revert PR RicoSuter#4314

* v13.18.3

* Improve NRT support for API parameters

* Required path parameters are not nullable (when NRT is off)

* v13.18.4

* Add enforceNotNull parameter and use for required path parameters

* v13.18.5

* Add File.Footer.liquid (RicoSuter#4411)

* Swagger UI v4.18.3, closes RicoSuter#4311 and RicoSuter#4387 (v13.18.5)

* add axios abort signal (RicoSuter#4282)

* add axios abort signal

* unit test

* Add support for MSBuild transitive dependency flow RicoSuter#4026 (RicoSuter#4338)

* Use GNU tar for cache and install .NET in single step (RicoSuter#4251)

* Unwrap ValueTask<T> return types (RicoSuter#4374)

* Unwrap ValueTask<T> return types, same as Task<T>, unwrap (Value)Task<ActionResult<T>> and unify unwrapping for consistency RicoSuter#4373

* lahma suggestion for performance

* cleanup

* NJsonSchema v10.9.0

* Fix build

* Revert "Fix build"

This reverts commit 21bf926.

* Fix build

* Fix dep

* Add .NET 5 SDK

* Improve build

* v13.19.0

* fix default value docs of SerializeTypeInformation, closes RicoSuter#4480

* Add SwaggerRoutesFactory to SwaggerUi3Settings

* Disable warning CS8604 "Possible null reference argument for parameter" in generated code (RicoSuter#4422)

* Disable warning CS8604 "Possible null reference argument for parameter" in code generation file header template

* Restore warning in file footer

* Update Client.Class.liquid (RicoSuter#4471)

* Update Client.Class.liquid

fix RicoSuter#4466

* Update Client.Class.liquid

---------

Co-authored-by: Rico Suter <[email protected]>

* install .net 3.1 sdk

* v13.20.0

* Set ChocolateyPush source

* Post-merge adjustments

* Updated more Newtonsoft.Json versions, for consistency

---------

Co-authored-by: Rico Suter <[email protected]>
Co-authored-by: Patrick Hofman <[email protected]>
Co-authored-by: Jan Trejbal <[email protected]>
Co-authored-by: Jean-Luc <[email protected]>
Co-authored-by: Antti Viita <[email protected]>
Co-authored-by: Antti Viita <[email protected]>
Co-authored-by: Rico Suter <[email protected]>
Co-authored-by: Lydon Chandra <[email protected]>
Co-authored-by: Daniel Sack <[email protected]>
Co-authored-by: Marko Lahma <[email protected]>
Co-authored-by: Alasdair <[email protected]>
Co-authored-by: Noah Stolk <[email protected]>
Co-authored-by: Alireza Mahdavi <[email protected]>
lahma pushed a commit to lahma/NSwag that referenced this pull request Jan 20, 2024
…r" in generated code (RicoSuter#4422)

* Disable warning CS8604 "Possible null reference argument for parameter" in code generation file header template

* Restore warning in file footer
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