Skip to content

OpenAPI generator: unescaped characters break TSDoc #5393

@alumni

Description

@alumni

Describe the Bug

The generated TSDoc contains invalid characters like @, { and }, e.g.:

    /**
     * Get all references of a given task (specified by path parameter "{taskId}").
     * @param taskId - ID of a task.
     * @returns The request builder, use the `execute()` method to trigger the request.
     */
    getTasksReferencesByTaskId: (taskId: string) =>

Steps to Reproduce

  1. download openapi spec from https://api.sap.com/api/CALM_TKM/overview
  2. run openapi-generator --input CALM_TKM.json --outputDir .

Expected Behavior

These characters should be escaped: "\{taskId\}"

Screenshots

Image

Used Versions

  • Node version via node -v: ...
  • NPM version via `npm -v: ...
  • SAP Cloud SDK version: ...
  • For CAP users, CAP version: ...

Code Examples

No response

Log File

No response

Affected Development Phase

Development

Impact

Inconvenience

Timeline

No response

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions