Skip to content

fix(java): validation of UUIDs in oneOf and anyOf schemas#21747

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
rubenhoenle:fix/validate-json-element-uuid
Aug 16, 2025
Merged

fix(java): validation of UUIDs in oneOf and anyOf schemas#21747
wing328 merged 1 commit intoOpenAPITools:masterfrom
rubenhoenle:fix/validate-json-element-uuid

Conversation

@rubenhoenle
Copy link
Copy Markdown
Contributor

@rubenhoenle rubenhoenle commented Aug 14, 2025

relates to #16868


I found out that the same thing described in #16868 also happens for one of schemas. Here's an example with both, one of and any of.

openapi: 3.1.0
info:
  version: 0.1.0
  title: ''
  description: ''
paths:
  /foo/:
    post:
      operationId: foo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneOfExample'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
  /bar/:
    post:
      operationId: bar
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnyOfExample'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
components:
  schemas:
    OneOfExample:
      oneOf:
      - type: string
        format: uuid
      - type: string
        enum:
        - delete
    AnyOfExample:
      anyOf:
      - type: string
        format: uuid
      - type: string
        enum:
        - delete

When generating the java code for the example, I will run into compile errors. With my fix they should be gone.

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

# run the tests
cd uuid-fix-output
chmod +x gradlew
./gradlew test

Compile error output (without this fix):

/home/<USER>/Developer/openapi-generator/uuid-fix-output/src/main/java/org/openapitools/client/model/AnyOfExample.java:103: error: cannot find symbol
                        UUID.validateJsonElement(jsonElement);
                            ^
  symbol:   method validateJsonElement(JsonElement)
  location: class UUID
/home/<USER>/Developer/openapi-generator/uuid-fix-output/src/main/java/org/openapitools/client/model/AnyOfExample.java:224: error: cannot find symbol
            UUID.validateJsonElement(jsonElement);
                ^
  symbol:   method validateJsonElement(JsonElement)
  location: class UUID
/home/<USER>/Developer/openapi-generator/uuid-fix-output/src/main/java/org/openapitools/client/model/OneOfExample.java:104: error: cannot find symbol
                        UUID.validateJsonElement(jsonElement);
                            ^
  symbol:   method validateJsonElement(JsonElement)
  location: class UUID
/home/<USER>/Developer/openapi-generator/uuid-fix-output/src/main/java/org/openapitools/client/model/OneOfExample.java:230: error: cannot find symbol
            UUID.validateJsonElement(jsonElement);
                ^
  symbol:   method validateJsonElement(JsonElement)
  location: class UUID
4 errors

> Task :compileJava FAILED

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 1m 52s
1 actionable task: 1 executed

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

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.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 16, 2025

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 16, 2025

thanks for the fix. let's give it a try

i'll add a test or 2 later.

have a nice weekend

@wing328 wing328 merged commit 030be5d into OpenAPITools:master Aug 16, 2025
12 of 14 checks passed
@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 16, 2025

FYI. Merged #21763 to add tests

Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
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