Generate wrong swagger when use union type

[honguyenhaituan]

Summary

Generate wrong swagger when use union type

• SDK Version: 3.0.5

I have a query dto like below:

type Query = {
    platform: 'android' | 'ios';
};

but when I generate swagger what I receive is

"schemas": {
	"Query": {
		"type": "object",
		"properties": {
			"platform": {
				"oneOf": [{ "const": "android" }, { "const": "ios" }]
			}
		},
		"required": ["platform"]
	}
},

and I found nothing about key word "const" in Open API document https://swagger.io/specification/.

In nestia version 2.6.4, I receive enum instead oneOf

"Query": {
      "type": "object",
      "properties": {
	      "platform": { "type": "string", "enum": ["android", "ios"] }
      },
      "nullable": false,
      "required": ["platform"]
}

[samchon]

https://json-schema.org/understanding-json-schema/reference/const

It is a spec of JSON schema of very wrong time ago

Also, OpenApi 3.1 supports it.

OAI/OpenAPI-Specification#1666 (comment)

[loucass003]

I am encountering issues with this currently.
IMO this is a bigger deal than it looks like as it looks like most openapi code generators do not parse it correctly yet, especially big ones like https://github.com/fabien0102/openapi-codegen or https://github.com/AndrejNemec/openapi-tanstack-query-solid/tree/master (currently the only tenstackquery codegen for solidjs)

they both generates Types that looks like this

export type FilteredUserDTOOrderBy = unknown | unknown;

// i also got this on other libs
export type FilteredUserDTOOrderBy = void | void;

instead of

export type FilteredUserDTOOrderBy = 'id' | 'email' ;

Idk if something can be done on your end. Maybe a setting toggle for the enum syntax instead of const?

[honguyenhaituan]

@loucass003 I use this lib https://github.com/hey-api/openapi-ts and it generate ts correctly

[loucass003]

Good to know, sadly for me i would like to use tenstask query with solijds. there is tenstack query generators for react but only one for solid and they use an openapi lib that is not parsing those unions correctly 😭

i can understand how this is none of netia business but this greadly reduce compatibility with other libs that havent implemented that syntax. If it is decided that nestia wont move from the const syntax i will forward this issue to the other openapi generator libs

[samchon]

https://github.com/samchon/openapi

@honguyenhaituan @loucass003 I think both of you want OpenAPI v3.0 document.

You can convert to it manually through above library.

Also, how do you think about providing OpenAPI version specification option in the nestia.config.ts file?

import { INestiaConfig } from "@nestia/sdk";
import { NestFactory } from "@nestjs/core";

import { AppModule } from "./src/AppModule";

export const NESTIA_CONFIG: INestiaConfig = {
  input: () => NestFactory.create(AppModule),
  swagger: {
    openapi: "3.0", // "2.0" | "3.0" | "3.1"
    output: "packages/api/swagger.json",
    beautify: true,
  },
};
export default NESTIA_CONFIG;

[loucass003]

oh wow ok. problem solved then. thank you very much @samchon again for this amazing tool that you provide <3

[samchon]

Upgrade to v3.7.0, then you can do it.