OpenAPITools / OpenAPITools/openapi-generator

[BUG][CSHARP] Duplicate assignment of nullable properties in models constructor

Open
#11,859 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 (example)?
  • [ ✅ ] 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)

Hello,

Issue is purely esthetic and doesn't affect functionality of the code.
Using version 5.4.0 of openapi generator cli it seems like it assigns model properties twice when they are covered
with "nullable" set to true.
Weird thing is that when I manually changed it to x-nullable it seem to work just fine.

Openapi-generator-cli : version 5.4.0
Openapi spec : version 3.0.1
Client lang: csharp

Example entity:

"CommentEntity": {
        "type": "object",
        "properties": {
          "commentId": {
            "type": "string",
            "format": "uuid",
            "nullable":true
          },
          "containerId": {
            "type": "string",
            "format": "uuid",
            "x-nullable": true
          }
      }

Generated model:

    /// <summary>
    /// CommentEntity
    /// </summary>
    [DataContract]
    public partial class CommentEntity :  IEquatable<CommentEntity>, IValidatableObject
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="CommentEntity" /> class.
        /// </summary>
        /// <param name="commentId">commentId.</param>
        public CommentEntity(Guid? commentId = default(Guid?),Guid? containerId = default(Guid?))
        {
            this.CommentId = commentId;
            this.CommentId = commentId;
            this.ContainerId = containerId;
        }

Expected output would look like containerId param - single assignment of property

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

Reproduce the issue with the supplied OpenAPI 3.0.1 schema using OpenAPI Generator CLI 5.4.0, then trace the C# model-generation path that renders the constructor. Done means each nullable property is assigned once, while the existing x-nullable behavior remains correct; check for a suitable generator regression test.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
api, 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.