Nestjs swagger enum type. Initially, everything was fine as I had ENUM. value (Demo), so if in the future i add some new values to enum, it will be shown in my swagger UI. Apr 10, 2022 · Is there an existing issue for this? I have searched the existing issues Current behavior Using enums with number values results in incorrect Swagger examples. There are some tricks to it for certain special cases (eg. I actually improved it by changed from an array of values to Object. content_copy export enum AllowedColor { RED, GREEN, BLUE, } With this in place, register the AllowedColor enum using the registerEnumType function exported from the @nestjs/graphql package: content_copy registerEnumType Aug 15, 2020 · } Here is what that enum file looks like: // purchasable-type. com/lukeautry/tsoa) and its Swagger Generator works beautifully with enums. All values in an enum must adhere to the specified type. Jun 10, 2025 · Using NestJS Swagger and Orval for enum names management significantly improves type safety and development efficiency. Dec 6, 2017 · It looks like typescript enum types are not supported yet in rsponse definition i set ConfigModel as type response like this // model definition export enum EnvConfig { PROD, DEV } export class Con Nov 9, 2024 · In my NestJS application there is an entity which called Transaction. numerical enumeration without skipping numbers), but in general it cannot even always be done (eg. The specification will look like the following: Jul 27, 2021 · The example property of the ApiPropertyOptions solved my problem. ts export enum PurchasableType { CLINIC = 'CLINIC', EVENT = 'EVENT', LESSON = 'LESSON', RESERVATION = 'RESERVATION', TEAM = 'TEAM', } From there I can confidently expect the value of the enum to be one of the above values. js server-side applications using TypeScript and combining OOP, FP, and FRP principles. I've been using lukeatry/tsoa package (https://github. If you need to specify descriptions for enum items, you can do this in the description of the parameter or property: Jul 27, 2024 · Now, when Swagger generates the documentation for your NestJS application, it will show the possible values defined in the enum (STRING, NUMBER) for the ‘type’ parameter. The enumName property enables @nestjs/swagger to turn CatBreed into its own schema which in turns makes CatBreed enum reusable. By following these steps, you can ensure that NestJS Swagger supports using a mixed type with an enum in your application. with const enum). This pattern is especially beneficial for projects requiring Jul 11, 2019 · It's not that trivial to get all enumeration values. If some other value comes through, nest will throw a . For example export enum Size { SMALL NestJS is a framework for building efficient, scalable Node. Dec 6, 2017 · As far as I know, Enum type can be generated and can be in its own definitions. enum. However, the 3rd party which I was pulling information from, added a few new v Code first When using the code first approach, you define a GraphQL enum type by simply creating a TypeScript enum. Transaction has type field, which is enum of 4 possible values: Jul 27, 2024 · I'm having small issues with NestJs Swagger ApiProperty Type generation. dcwhxlj pvnv perzu txfqmp kkzbuiu bdz cabkaqu denmrq yxazw vlx