Enums are parsed to invalid Typescript #884
Assignees
Labels
Milestone
Comments
|
A workaround would be to use the You might want to use the transformer feature to add this to your generated spec. example: {
"ChainingOperator": {
"description": "The operator used to chain condition",
"enum": ["&&", "||"],
"type": "string",
"x-enumNames": ["AND", "OR"]
}
}generates: export const ChainingOperator = {
AND: '&&',
OR: '||',
} as const@anymaniax This should probably added to the docs |
vonkanehoffen
pushed a commit
to vonkanehoffen/orval-enum-bug-repro
that referenced
this issue
Jun 28, 2023
|
Ah thanks so much @NimmLor ! That works great. I had no idea that For anyone else needing this, here's the fix with the regenerated code applied to my demo repo: |
melloware
added
documentation
|
this is also happening to me |
|
@dsthode does your latest fix help with this issue? |
|
@melloware I'm not sure which fix you are talking about, has it been released? |
|
@melloware @dsthode incredible, thank you lots |
|
@zernie maybe you can verify if its fixed or not when 6.21.0 is released and report back? |
|
@melloware sure, ping me when it's ready |
|
6.21.0 is out if you want to try the new setting for enums. |
|
@melloware unfortunately, I have a similar problem with a /**
* Generated by orval v6.21.0 🍺
* Do not edit manually.
* Amtta Admin
* OpenAPI spec version: api
*/
export type GetApiAdminAccountsAccountIdPlacesParams = {
/**
* Количество возвращаемых сущностей
*/
limit: number;
/**
* Количество пропущенных сущностей
*/
offset: number;
/**
* Поле по которому сортировать. Доступные поля для сортировки - accountId, juridicalPersonId, title, phone, rating, workStatus, takeawayDiscountPercent, promoteStatus, promotedTo, createdAt, updatedAt, id
*/
orderField?: typeof GetApiAdminAccountsAccountIdPlacesOrderField[keyof typeof GetApiAdminAccountsAccountIdPlacesOrderField] ;
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetApiAdminAccountsAccountIdPlacesOrderField = { id: 'id',
accountId: 'accountId',
juridicalPersonId: 'juridicalPersonId',
title: 'title',
phone: 'phone',
rating: 'rating',
workStatus: 'workStatus',
promoteStatus: 'promoteStatus',
promotedTo: 'promotedTo',
takeawayDiscountPercent: 'takeawayDiscountPercent',
updatedAt: 'updatedAt',
createdAt: 'createdAt',
} as const;
/**
* Тип сортировки ASC или DESC
*/
orderType?: typeof GetApiAdminAccountsAccountIdPlacesOrderType[keyof typeof GetApiAdminAccountsAccountIdPlacesOrderType] ;
// eslint-disable-next-line @typescript-eslint/no-redeclare
export const GetApiAdminAccountsAccountIdPlacesOrderType = { ASC: 'ASC',
DESC: 'DESC',
} as const;
};Relevant swagger: "get": {
"tags": [
"Places"
],
"description": "Получить список Places у аккаунта",
"parameters": [
{
"schema": {
"minimum": 1,
"maximum": 100,
"type": "integer"
},
"in": "query",
"name": "limit",
"required": true,
"description": "Количество возвращаемых сущностей"
},
{
"schema": {
"minimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"in": "query",
"name": "offset",
"required": true,
"description": "Количество пропущенных сущностей"
},
{
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"id"
]
},
{
"type": "string",
"enum": [
"accountId"
]
},
{
"type": "string",
"enum": [
"juridicalPersonId"
]
},
{
"type": "string",
"enum": [
"title"
]
},
{
"type": "string",
"enum": [
"phone"
]
},
{
"type": "string",
"enum": [
"rating"
]
},
{
"type": "string",
"enum": [
"workStatus"
]
},
{
"type": "string",
"enum": [
"promoteStatus"
]
},
{
"type": "string",
"enum": [
"promotedTo"
]
},
{
"type": "string",
"enum": [
"takeawayDiscountPercent"
]
},
{
"type": "string",
"enum": [
"updatedAt"
]
},
{
"type": "string",
"enum": [
"createdAt"
]
}
]
},
"in": "query",
"name": "orderField",
"required": false,
"description": "Поле по которому сортировать. Доступные поля для сортировки - accountId, juridicalPersonId, title, phone, rating, workStatus, takeawayDiscountPercent, promoteStatus, promotedTo, createdAt, updatedAt, id"
},
{
"schema": {
"anyOf": [
{
"type": "string",
"enum": [
"ASC"
]
},
{
"type": "string",
"enum": [
"DESC"
]
}
]
},
"in": "query",
"name": "orderType",
"required": false,
"description": "Тип сортировки ASC или DESC"
},
{
"schema": {
"type": "integer"
},
"in": "path",
"name": "accountId",
"required": true
}
],
"security": [
{
"access_token": []
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"minimum": 0,
"type": "integer"
},
"limit": {
"minimum": 1,
"maximum": 100,
"description": "Количество возвращаемых сущностей",
"type": "integer"
},
"offset": {
"minimum": 0,
"maximum": 9007199254740991,
"description": "Количество пропущенных сущностей",
"type": "integer"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"accountId": {
"type": "integer"
},
"juridicalPersonId": {
"type": "integer"
},
"title": {
"minLength": 1,
"maxLength": 100,
"description": "Название",
"type": "string"
},
"phone": {
"pattern": "^7[0-9]{10}$",
"type": "string"
},
"cardImageUrl": {
"minLength": 1,
"maxLength": 1024,
"description": "Url карточки",
"type": "string"
},
"backgroundImageUrl": {
"description": "Url бэкграунда",
"anyOf": [
{
"minLength": 1,
"maxLength": 1024,
"type": "string"
},
{
"type": "null"
}
]
},
"rating": {
"description": "Рейтинг",
"anyOf": [
{
"pattern": "^[0-5]{1}.[0-9]{2}$",
"type": "string"
},
{
"type": "null"
}
]
},
"workStatus": {
"description": "Статус работы",
"anyOf": [
{
"type": "string",
"enum": [
"closed"
]
},
{
"type": "string",
"enum": [
"temp-closed"
]
},
{
"type": "string",
"enum": [
"open"
]
}
]
},
"promoteStatus": {
"description": "Статус продвижения",
"anyOf": [
{
"type": "string",
"enum": [
"new"
]
},
{
"type": "string",
"enum": [
"none"
]
}
]
},
"promotedTo": {
"description": "До какого числа действует продвижение. Формат - ISO 8601 date string",
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"availableDeliveryTypes": {
"minItems": 1,
"type": "array",
"items": {
"description": "Тип доставки",
"anyOf": [
{
"type": "string",
"enum": [
"takeaway"
]
},
{
"type": "string",
"enum": [
"inhouse"
]
}
]
}
},
"availablePaymentTypes": {
"minItems": 1,
"type": "array",
"items": {
"description": "Тип оплаты",
"anyOf": [
{
"type": "string",
"enum": [
"card-online"
]
},
{
"type": "string",
"enum": [
"card-courier"
]
},
{
"type": "string",
"enum": [
"mobile-transfer"
]
},
{
"type": "string",
"enum": [
"cash-courier"
]
}
]
}
},
"takeawayDiscountPercent": {
"minimum": 0,
"maximum": 50,
"description": "Скидка при самовывозе, в процентах",
"type": "integer"
},
"tags": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"minLength": 1,
"maxLength": 20,
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"telegramChatId": {
"description": "ИД телеграм чата для нотификаций",
"anyOf": [
{
"minLength": 1,
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
]
},
"address": {
"minLength": 1,
"maxLength": 1024,
"description": "Адрес в виде строки",
"type": "string"
},
"addressPoint": {
"type": "object",
"properties": {
"longitude": {
"minimum": -180,
"maximum": 180,
"description": "Долгота",
"type": "number"
},
"latitude": {
"minimum": -90,
"maximum": 90,
"description": "Широта",
"type": "number"
}
},
"required": [
"longitude",
"latitude"
]
},
"addressFlat": {
"description": "Квартира/офис",
"anyOf": [
{
"minLength": 1,
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
]
},
"addressDoorcode": {
"description": "Домофон",
"anyOf": [
{
"minLength": 1,
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
]
},
"addressEntrance": {
"description": "Подъезд",
"anyOf": [
{
"minLength": 1,
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
]
},
"addressFloor": {
"description": "Этаж",
"anyOf": [
{
"minLength": 1,
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
]
},
"addressAdditionalInformation": {
"description": "Доп. информация",
"anyOf": [
{
"minLength": 1,
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"accountId",
"juridicalPersonId",
"title",
"phone",
"cardImageUrl",
"backgroundImageUrl",
"rating",
"workStatus",
"promoteStatus",
"promotedTo",
"availableDeliveryTypes",
"availablePaymentTypes",
"takeawayDiscountPercent",
"tags",
"telegramChatId",
"address",
"addressPoint",
"addressFlat",
"addressDoorcode",
"addressEntrance",
"addressFloor",
"addressAdditionalInformation",
"updatedAt",
"createdAt"
]
}
}
},
"required": [
"count",
"limit",
"offset",
"data"
]
},
"example": {
"count": 123,
"limit": 1,
"offset": 0,
"data": [
{
"id": 3456,
"accountId": 213,
"workStatus": "closed",
"promoteStatus": "none",
"promotedTo": null,
"rating": null,
"juridicalPersonId": 434,
"title": "Amtta",
"phone": "79997775544",
"cardImageUrl": " /static/images/d0af2028-62e2-4abb-bfca-c021e83bda47",
"backgroundImageUrl": null,
"availableDeliveryTypes": [
"takeaway",
"inhouse"
],
"availablePaymentTypes": [
"cash-courier",
"mobile-transfer",
"card-online",
"card-courier"
],
"takeawayDiscountPercent": 10,
"address": "Респ. Калмыкия, г. Элиста, проезд 11-й, д. 8",
"addressPoint": {
"longitude": 44.255008,
"latitude": 46.291193
},
"addressFlat": "33",
"addressDoorcode": "33",
"addressEntrance": null,
"addressFloor": null,
"addressAdditionalInformation": "Вход с торца",
"tags": [
{
"id": 1,
"name": "Калмыцкая кухня"
},
{
"id": 2,
"name": "Суши"
}
],
"updatedAt": "2023-05-04T13:21:59.771Z",
"createdAt": "2023-05-04T13:21:59.771Z",
"telegramChatId": "-4051259643"
}
]
}
}
}
},
"400": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"BAD_REQUEST_ERROR"
]
},
"statusCode": {
"type": "number",
"enum": [
400
]
},
"details": {
"type": "array",
"items": {
"type": "array",
"items": [
{
"description": "Указатель JSON на местоположение в экземпляре данных (например, `\"body/1/subProp\"`)",
"type": "string"
},
{
"description": "Сообщение об ошибке",
"type": "string"
}
],
"additionalItems": false,
"minItems": 2,
"maxItems": 2
}
},
"requestId": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"errorCode",
"statusCode",
"details",
"requestId",
"message"
]
},
"example": {
"errorCode": "BAD_REQUEST_ERROR",
"statusCode": 400,
"details": [
[
"body",
"must have have required property id"
],
[
"querystring",
"property limit must be greater than 0"
]
],
"requestId": "d0af2028-62e2-4abb-bfca-c021e83bda47",
"message": "Человекочитаемое сообщение об ошибке"
}
}
}
},
"401": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"UNAUTHORIZED_ERROR"
]
},
"statusCode": {
"type": "number",
"enum": [
401
]
},
"details": {
"type": "null"
},
"requestId": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"errorCode",
"statusCode",
"details",
"requestId",
"message"
]
},
"example": {
"errorCode": "UNAUTHORIZED_ERROR",
"statusCode": 401,
"details": null,
"requestId": "d0af2028-62e2-4abb-bfca-c021e83bda47",
"message": "Человекочитаемое сообщение об ошибке"
}
}
}
},
"403": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"FORBIDDEN_ERROR"
]
},
"statusCode": {
"type": "number",
"enum": [
403
]
},
"details": {
"type": "null"
},
"requestId": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"errorCode",
"statusCode",
"details",
"requestId",
"message"
]
},
"example": {
"errorCode": "FORBIDDEN_ERROR",
"statusCode": 403,
"details": null,
"requestId": "d0af2028-62e2-4abb-bfca-c021e83bda47",
"message": "Человекочитаемое сообщение об ошибке"
}
}
}
},
"500": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"INTERNAL_SERVER_ERROR"
]
},
"statusCode": {
"type": "number",
"enum": [
500
]
},
"details": {
"type": "null"
},
"requestId": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"errorCode",
"statusCode",
"details",
"requestId",
"message"
]
},
"example": {
"errorCode": "INTERNAL_SERVER_ERROR",
"statusCode": 500,
"details": null,
"requestId": "d0af2028-62e2-4abb-bfca-c021e83bda47",
"message": "Человекочитаемое сообщение об ошибке"
}
}
}
}
}
}, |
|
OK thanks for verifying will leave this bug open. |
|
@melloware hey, any updates?:) |
|
I have not looked into this further. PR's are welcome though! |
|
@melloware I've no idea where to begin even. any tips? |
|
well what I do usually grep the source code for what I am looking for like "enum" and work my way backwards to the code that is generating the enums. Then maybe you can figure out what is wrong? |
|
@melloware, the problem seems to happen here: Json schemas similar to |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What are the steps to reproduce this issue?
npm ithis minimal example repo: https://github.com/vonkanehoffen/orval-enum-bug-repronpm run codegenWhat happens?
If you look in
generated/model/loginStatus.tsyou'll notice Orval has generated invalid syntax:This is from a valid schema:
(this is part of a schema originally generated by Swashbockle in .Net)
What were you expecting to happen?
I'd expect the generation to be something like:
Any logs, error output, etc?
…
Any other comments?
The OpenAPI spec is a bit vague around enum from what I could find. The example passes validation but is there some other way it should look to fix this?
What versions are you using?
Operating System: Masc OS Ventura
Package Version: 6.16.0
Browser Version: N/A
The text was updated successfully, but these errors were encountered: