Skip to content

Conversation

@marceljk
Copy link
Contributor

@marceljk marceljk commented Oct 21, 2025

Description

When the api spec contains a object, where a property has a default value and uses an allOf to a primitive type, like long or float, the generated code can not be compiled because L or f are missing at the end of the defaultValue.

Api spec example:

openapi: 3.0.0
info:
  version: 0.1.0
  title: ''
  description: ''
paths:
  /foo:
    get:
      responses:
        default:
          description: response
          content:
            application/json:
              schema:
                type: object
                properties:
                  long:
                    $ref: '#/components/schemas/AllOfRefToLong'
                  float:
                    $ref: '#/components/schemas/AllOfRefToFloat'
                  double:
                    $ref: '#/components/schemas/AllOfRefToDouble'
components:
  schemas:
    LongId:
      description: "Id as long"
      type: integer
      format: int64
    Weight:
      description: "Weight as float"
      format: float
      type: number
    Height:
      description: "Height as double"
      format: double
      type: number
    AllOfRefToLong:
      description: "Object with allOf ref to long"
      type: object
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/LongId'
          default: 10
    AllOfRefToFloat:
      description: "Object with allOf ref to float"
      type: object
      properties:
        weight:
          allOf:
            - $ref: '#/components/schemas/Weight'
          default: 7.89
    AllOfRefToDouble:
      description: "Object with allOf ref to double"
      type: object
      properties:
        height:
          allOf:
            - $ref: '#/components/schemas/Height'
          default: 32.1

Generate a java client:

# generate
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate --generator-name java --input-spec allOf-defaultValue.yaml --output "allOf-defaultValue-fix"

# run the tests
cd allOf-defaultValue-fix
chmod +x gradlew
./gradlew test

Compile error output without the fix:

> Task :compileJava FAILED
warning: [options] source value 8 is obsolete and will be removed in a future release
warning: [options] target value 8 is obsolete and will be removed in a future release
warning: [options] To suppress warnings about obsolete options, use -Xlint:-options.
/Users/<user>/tmp/openapi-generator/allOf-defaultValue-fix/src/main/java/org/openapitools/client/model/AllOfRefToLong.java:58: error: incompatible types: int cannot be converted to Long
  private Long id = 10;
                    ^
/Users/<user>/tmp/openapi-generator/allOf-defaultValue-fix/src/main/java/org/openapitools/client/model/AllOfRefToFloat.java:58: error: incompatible types: double cannot be converted to Float
  private Float weight = 7.89;
                         ^
2 errors
3 warnings

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileJava'.
> Compilation failed; see the compiler error output for details.

* Try:
> Run with --info option to get more log output.
> Run with --scan to get full insights.

Deprecated Gradle features were used in this build, making it incompatible with Gradle 9.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

For more on this, please refer to https://docs.gradle.org/8.7/userguide/command_line_interface.html#sec:command_line_warnings in the Gradle documentation.

BUILD FAILED in 697ms
1 actionable task: 1 executed

Implementation

  • In order to fix this issue, some additional checks were added in the toDefaultValue() function, to check for allOf schemas, if they are a long, double or float and return the defaultValue correctly defined

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg

@wing328
Copy link
Member

wing328 commented Oct 31, 2025

thanks for the fix

looks good to me

let's give it a try

@wing328 wing328 merged commit 66b7420 into OpenAPITools:master Oct 31, 2025
88 of 89 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants