OpenAPITools / OpenAPITools/openapi-generator
[REQ] [csharp] Handling of nullable and required properties
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
With the current csharp generators (except generichost), there is a confusion between required and nullable fields. Nullable fields and non-required fields are both using the csharp nullable operator "?". It leads to several problems.
- When a field is defined as not required and nullable, it's impossible to know if its value is missing or null.
- Model validation is sometimes incorrect (https://github.com/OpenAPITools/openapi-generator/issues/21090)
Describe the solution you'd like
Make a distinction between required and nullable fields. The solution used by generichost, using an Option struct for required fields seems good.
Describe alternatives you've considered
An alternative is moving to generichost but it's not possible for my project.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the existing C# generators with the generichost generator's handling of nullable and required properties. Read issue #21090 for the validation failure context and determine the affected generator models and tests. Done means required and nullable states are distinguishable without regressing model validation across the non-generichost C# generators.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100