OpenAPITools / OpenAPITools/openapi-generator

[BUG][CSHARP][GENERICHOST] JsonConverter validation does not handle non-required nullable reference types correctly.

Open
#23,190 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

If you leave a property as non-required and enable nullable reference types the Read/WriteProperties in the JsonConvert will still require non-null values.

(Read)

if (message.IsSet && message.Value == null)
    throw new ArgumentNullException(nameof(message), "Property is not nullable for class HelloWorldPostRequest.");

and

(WriteProperties)

if (helloWorldPostRequest.MessageOption.IsSet && helloWorldPostRequest.Message == null)
    throw new ArgumentNullException(nameof(helloWorldPostRequest.Message), "Property is required for class HelloWorldPostRequest.");
openapi-generator version

7.20.0

OpenAPI declaration file content or url

(Just using one of the sample specs)

openapi: 3.1.0                                                                                                                                                                                            
  info:                                                                                                                                                                                                     
    title: Minimal reproduction for csharp webhook bug                                                                                                                                                      
    version: 1.0.0                                                                                                                                                                                          
    description: This is an example API to reproduce a bug with webhooks in csharp codegen
  tags:
    - name: Test
      description: This is a test
  webhooks:
    helloWorld:
      post:
        summary: Example webhook
        responses:
          "204":
            description: Webhook processed
          "500":
            description: Webhook not processed
        description: Send when an example is needed
        requestBody:
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                description: The payload of the HelloWorld webhook
          description: Contains the details of the hello world webhook
Generation Details

Latest, nullableReferenceTypes as true.

Steps to reproduce

Generate using the generichost csharp library.

Related issues/PRs
Suggest a fix

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 generating the sample webhook spec with the C# generichost library and nullableReferenceTypes enabled, then inspect the generated JsonConvert Read and WriteProperties paths. Verify that a non-required nullable reference property can remain null without either path throwing an ArgumentNullException.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.