Add default type for enum #302
Conversation
zorox112-practicum
force-pushed
the
openapi-add-initial-type-for-enum
branch
from
cda8b00 to
e7e0207
Compare
src/services/includers/batteries/openapi/generators/traverse.ts
Outdated
Show resolved
Hide resolved
| if (value.type) { | ||
| return value.type; | ||
| } | ||
| if (value.enum && Array.isArray(value.enum)) { |
There was a problem hiding this comment.
factor it out into separate function
isEnumOfImplementedType/isEnumOfSupportedType checking if value is one of the supported types
if so return that enum type, otherwise throwing
| @@ -234,3 +234,18 @@ function merge(value: OpenJSONSchemaDefinition): OpenJSONSchema { | |||
| function isRequired(key: string, value: JSONSchema6): boolean { | |||
| return value.required?.includes(key) ?? false; | |||
| } | |||
|
|
|||
| function inferType(value: OpenJSONSchema): JSONSchema6['type'] { | |||
There was a problem hiding this comment.
as far as i understand inferType might return undefined yet i can't find you handling that scenario
There was a problem hiding this comment.
This PR is about adding a type calculation for enum, this function does not handle undefined.
There was a problem hiding this comment.
This PR is about adding a type calculation for enum
-
you are adding function to infer type from value.
-
this function has undefined as one of its return values
-
either handle function returning undefined when you call it or throw error instead of returning undefined inside of the function.
zorox112-practicum
force-pushed
the
openapi-add-initial-type-for-enum
branch
from
e7e0207 to
0a4a64a
Compare
| @@ -20,6 +20,8 @@ const SPEC_RENDER_MODE_HIDDEN = 'hidden'; | |||
| const SPEC_SECTION_NAME = 'Specification'; | |||
| const SPEC_SECTION_TYPE = 'Open API'; | |||
|
|
|||
| const SUPPORTED_ENUM_TYPES = ['string', 'number'] as const; | |||
There was a problem hiding this comment.
Please keep an array here for convenient type generation.
| } | ||
|
|
||
| function isSupportedEnumType(enumType: JsType): enumType is SupportedEnumType { | ||
| return SUPPORTED_ENUM_TYPES.some((type) => enumType === type); |
There was a problem hiding this comment.
The includes method does not allow using TS
zorox112-practicum
force-pushed
the
openapi-add-initial-type-for-enum
branch
from
0a4a64a to
b989c29
Compare
I made a function for calculating the enum type: