OpenAPITools / OpenAPITools/openapi-generator

[BUG][csharp-netcore][aspnetcore] Specifying default value for arrays has no effect

Open
#14,879 1 comment 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)
Description

When a default array value is specified for a model property, it doesn't show up anywhere usable, judging by the debugModels output. defaultValue shows up for other types, such as strings.

openapi-generator version

6.4.0-SNAPSHOT
commit : 6b06441
built : 2023-02-03T13:39:00Z

OpenAPI declaration file content or url

spec.yaml

openapi: 3.0.3
info:
  version: 1.0.0
  title: "Things"

paths: {}

components:
  schemas:
    ThingArray:
      properties:
        things:
          type: array
          items:
            type: string
          default: ["a", "b", "c"]
Generation Details

To produce the debugModels output: (try with aspnetcore as well)
docker run --rm -v ${PWD}:/openapi openapitools/openapi-generator-cli generate -g csharp-netcore --global-property debugModels -i /openapi/spec.yaml

Steps to reproduce

Run command above in same directory as the spec above.

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 with spec.yaml and run the provided Docker command using the csharp-netcore generator, then repeat with aspnetcore. Trace the debugModels output for ThingArray.things and compare it with the string defaultValue behavior; done means the array default appears in a usable result for the affected generators.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.