Skip to content
GitLab

[C#] Emit Default is true for required properties.

Closed Administrator requested to merge github/fork/dhedey/fix/csharp-emit-default-for-required-properties into master

Created by: dhedey

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: https://github.com/OpenAPITools/openapi-generator/pull/11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

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.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)