Enums not generated

[AsasInnab]

I can't seem to get enums to be generated. What I understand from the documentation is that enums should be generated by default.

I'm trying out the petstore example:
npx swagger-typescript-api -p https://petstore.swagger.io/v2/swagger.json -o ./generated2 --enum-names-as-values

And I get status as an union type instead of an enum although I have not set --union-enums flag:

export interface Pet {
  /** @format int64 */
  id?: number;
  category?: Category;

  /** @example doggie */
  name: string;
  photoUrls: string[];
  tags?: Tag[];

  /** pet status in the store */
  status?: 'available' | 'pending' | 'sold';
}

[dkocich]

I also noticed this. We have multiple docs and from YAML we get enums successfully but from JSON we do not and there is always string union...

[KlenoviKretochki]

I guess this happens because enam "status" is defined as a property of Pet with definition
{ type: 'string', enum: ['available', 'pending', 'sold'] } in swagger.json but this lib generates types relaying on 'components/schemas/...' from swagger.json
Working example (swagger.json)

  {
     ...,
     "components": {
          "schemas": {
              "Pet": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "$ref": "#/components/schemas/PetStatusEnum"
                    }
                  }
              },
              "PetStatusEnum": {
                  "type": "string",
                  "enum": ["available", "pending", "sold"]
              }
          }
     }
  }

It also makes PetStatusEnam reusable for other definitions

[magersoft]

I have the same issue, Enums not generated

my swagger schema

{
            "name": "type",
            "required": false,
            "in": "query",
            "schema": {
              "enum": [
                "TEXT",
                "DIGIT",
                "DATE",
                "TABLE"
              ],
              "type": "string"
            }
          },

but generated file

type: 'TEXT' | 'DIGIT' | 'DATE' | 'TABLE'

I have not set --union-enums flag

[LintaoAmons]

Facing the same issue~

[wirekang]

Same here.

[wirekang]

I found solution!

Not working example:

enum MyEnum {
  Asdf = 'asdf',
  Qwer = 'qwer',
}

export class MyClass {
  @ApiProperty({enum: MyEnum })
  my: MyEnum
}

Working example:

enum MyEnum {
  Asdf = 'asdf',
  Qwer = 'qwer',
}

export class MyClass {
  @ApiProperty({enum: MyEnum, enumName: "MyEnum" })
  my: MyEnum
}

If you set enumName property, as @aleshka-maple said, the type generated in components/schemas.

[magersoft]

I try this, but not working. I got same string in the generated file with different enumName property

[evtk]

Any updates on this? Having the exact same issue. Should just work out of the box right?

[js2me]

@evtk @dkocich @aleshka-maple @magersoft will add flag --extract-enums for extracting enums into enum

Currently It's not working as you want because I don't have any name for enums, but I with using --extract-enums flag swagger-typescript-api will generate enum name based on property and schema name

[js2me]

Any ideas of how can I name keys of enum construction based on this schema ?

enum TreeMode {
  100644 = 100644,
  100755= 100755,
  040000= 040000,
  160000= 160000,
  120000= 120000,
}

[dkocich]

we started naming enums manually based on the generated enum and the property so we can find the generated schema easily and migrate later to generated enums (so ...DTO + State/Type )

@js2me I would add an extra character in front of numeric values (something like _ / x / num) but those can be also -1, 0.1, etc. so it might be harder to check