OpenAPITools / OpenAPITools/openapi-generator

[BUG][Dart-Dio] - Default value for enums is broken

Open
#22,120 3 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
  • [ x ] Have you provided a full/minimal spec to reproduce the issue?
  • [ x ] Have you validated the input using an OpenAPI validator?
  • [ x ] Have you tested with the latest master to confirm the issue still exists?
  • [ x ] Have you searched for related issues/PRs?
  • [ x ] What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

The generated dart code is invalid when enums have a default value.

openapi-generator version

Using 7.16, it worked in 7.13, I think it was a regression with pr #21355

OpenAPI declaration file content or url
{
    "openapi": "3.1.0",
    "info": {
        "title": "Simple",
        "version": "0.0.1"
    },
    "paths": {},
    "components": {
        "schemas": {
            "TestItem": {
                "properties": {
                    "productTypeSetting": {
                        "default": "physical",
                        "enum": [
                            "physical",
                            "service",
                            "perProduct"
                        ],
                        "type": "string"
                    }
                },
                "type": "object",
                "title": "TestItem"
            }
        }
    },
    "tags": []
}
Generation Details

Simple command:
openapi-generator generate -i openapi.json -g dart-dio

Steps to reproduce

Run the generation command

Related issues/PRs

#21355

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 openapi-generator generate -i openapi.json -g dart-dio with the declaration in the issue and compare generation on versions 7.13 and 7.16. Investigate the change associated with PR #21355 and the dart-dio enum generation path. Done means the generated Dart code is valid when an enum has a default value, without regressing the listed enum values.

Written by the indexing model from the issue text.

Assessment

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