OpenAPITools / OpenAPITools/openapi-generator

[REQ] [csharp] Handling of nullable and required properties

Open
#22,254 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
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.

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.