OpenAPITools / OpenAPITools/openapi-generator

[BUG] Interface is typed as enum instead of string for type string with enum in typescript-nestjs

Open
#20,395 0 comments 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

I am using the openapi-cli tool to generate client code for typescript-nestjs application. But I have an issues with the typing of enums. They seem to be defined as string but the generated code types them as enum. Might not be a bug, but rather my lack of knowledge.

openapi-generator version

7.10.0

OpenAPI declaration file content or url

Link to file

geometry:
          type: object
          properties:
            type:
              type: string
              enum:
                - Point
                - Multipoint
                - Polygon
Generation Details

openapi-generator-cli generate -g typescript-nestjs -i assets/swagger.yml -o --skip-validate-spec

i had to use --skip-validate-spec, because there are some issues on the swagger definition. It's not mine it's a decleration file i got.

Steps to reproduce

use above commands to generate a client -> type of enum is declared as enum instead of string

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 with the OpenAPI declaration in the linked Pastebin content and assets/swagger.yml, then run the shown openapi-generator-cli command with the typescript-nestjs generator. Compare the generated type for geometry.type with the declared string enum and determine the expected output before checking the relevant generator templates or tests.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.