OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA] AnyOf enum or format uuid yields invalid code

Open
#16,868 2 comments 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 anyOf in combination with enum and format: uuid yields invalid code.

openapi-generator version

7.0.1

OpenAPI declaration file content or url
openapi: 3.1.0
info:
  version: 0.1.0
  title: ''
  description: ''
paths:
  /foo/:
    post:
      operationId: foo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Patch_Uuid'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: ''
components:
  schemas:
    Patch_Uuid:
      anyOf:
      - type: string
        format: uuid
      - type: string
        enum:
        - delete
Generation Details

The generated PatchUuid.java contains:

public static void validateJsonElement(JsonElement jsonElement) throws IOException {
    // ...
    try {
        UUID.validateJsonElement(jsonElement);
        return;
    } catch (Exception e) {
        // ...
    }
    // ...
}

Because there is no such method validateJsonElement for class UUID, compilation fails. It should rather be sth like UUID.fromString(jsonElement.getAsString());

Steps to reproduce

Use the openapi-generator-maven-plugin to generate client code for okhttp-gson

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

Reproduce the issue with the openapi-generator-maven-plugin, the okhttp-gson client, and the provided OpenAPI YAML. Start by inspecting the generated PatchUuid.java validation code and confirm how the anyOf branches handle UUID and enum values. Done means the generated Java code compiles and validates both UUID and enum inputs correctly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.