Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #10459
Closed
Open
Issue created Sep 23, 2021 by Administrator@rootContributor4 of 6 checklist items completed4/6 checklist items

[BUG] [Typescript] Wrong usage of RequiredError

Created by: bodograumann

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

The RequiredError in the typescript generated code looks like this:

export class RequiredError extends Error {
    name: "RequiredError" = "RequiredError";
    constructor(public field: string, msg?: string) {
        super(msg);
    }
}

Cf. https://github.com/OpenAPITools/openapi-generator/blob/master/samples/openapi3/client/petstore/typescript/builds/default/apis/baseapi.ts#L32-L37

It is used like this though:

 throw new RequiredError('Required parameter pet was null or undefined when calling addPet.');

Cf. https://github.com/OpenAPITools/openapi-generator/blob/master/samples/openapi3/client/petstore/typescript/builds/default/apis/PetApi.ts#L29

I.e. the field parameter is missing in the construction. In practice this means, the error message is empty and the message string is set on the field attribute of the error.

openapi-generator version

5.1.1 locally and also on current main.

Suggest a fix

RequiredError should get two parameters method and field. The error message can then be generated at a single point. As a bonus the API name can also be included as a prefix in the method parameter.

Assignee
Assign to
Time tracking