OpenAPITools / OpenAPITools/openapi-generator

[BUG] [csharp] Required properties not sorted in ctor

Open
#20,589 1 comment 2 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)
Description

Using the csharp emitter the required properties should not get a default value and they must then come first in the ordering.

Currently, it does not order the constructor doc or parameters based on being required flag. Additionally, the required properties are given a default value in the constructor. This is present in existing generated code which have required properties and optional properties.

openapi-generator version
OpenAPI declaration file content or url

samples/client/echo_api/csharp/restsharp/net8/EchoApi/src/Org.OpenAPITools/Model/Pet.cs

Generation Details

./bin/generate-samples.sh ./bin/configs/csharp-restsharp-net8-echo-api.yaml

Steps to reproduce

view the Pet.cs file ctor and param documentation

Related issues/PRs
Suggest a fix

Sort order should be done before the template generation for the readWriteVars. not sure where this logic is though.

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 running ./bin/generate-samples.sh ./bin/configs/csharp-restsharp-net8-echo-api.yaml and inspect samples/client/echo_api/csharp/restsharp/net8/EchoApi/src/Org.OpenAPITools/Model/Pet.cs. Trace the readWriteVars ordering and template generation used for the constructor documentation and parameters. Done means required properties appear first and do not receive default values in the generated constructor.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.