OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript] String enum values containing "/*" are corrupted to "/_*"

Open
#24,572 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 string enum value contains the sequence /* (e.g. a wildcard pattern like foo/*), the generated value is silently corrupted to foo/_*, so the client-side constant no longer matches the value the server actually uses.

The cause is that AbstractTypeScriptClientCodegen.toEnumValue() runs the value through escapeText(), which applies escapeUnsafeCharacters():

// AbstractTypeScriptClientCodegen.java
@Override
public String escapeUnsafeCharacters(String input) {
    return input.replace("*/", "*_/").replace("/*", "/_*");
}

This rewrite protects text interpolated into block comments, but enum values are only emitted inside a string literal, where /* is harmless. Since templates receive the already-escaped value (there is no unescapedValue), this cannot be worked around with a custom template.

openapi-generator version

Reproduced with 7.3.0 and 7.17.0. Not a regression — escapeUnsafeCharacters is unchanged on current master.

OpenAPI declaration file content or url
openapi: 3.0.3
info:
  title: repro
  version: 1.0.0
paths: {}
components:
  schemas:
    Pattern:
      type: string
      enum:
        - "foo/*"
Generation Details
openapi-generator-cli generate -i spec.yaml -g typescript-fetch -o out
Steps to reproduce

Generate a client from the spec above and inspect out/models/Pattern.ts.

Actual:

export const Pattern = {
    Foo: 'foo/_*'
} as const;

Expected:

export const Pattern = {
    Foo: 'foo/*'
} as const;
Related issues/PRs

#23962 discusses the underlying design issue: escaping is applied while building the template data model, before the rendering context (comment vs. string literal) is known.

Suggest a fix

toEnumValue() should apply only string-literal-safe escaping (quotes, backslashes, newlines), leaving comment escaping to interpolation sites that are actually inside comments. Other generators share the same toEnumValue()escapeText() chain, so this is likely not limited to the TypeScript family, though I have only verified typescript-fetch.

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 in AbstractTypeScriptClientCodegen.java with toEnumValue() and escapeUnsafeCharacters(), then trace how the escaped value reaches the typescript-fetch model template. Reproduce with the provided spec and generation command, and inspect Pattern.ts. Done means the generated enum preserves foo/* while still handling string-literal escaping safely.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.