Repository navigation
Adding support for named integer enums - #1214
dbanty merged 9 commits into
Conversation
Sorry, something went wrong.
|
I've resisted adding custom OpenAPI attributes just for this generator... ideally, we could adopt conventions used by more popular projects, like OpenAPITools. Is x-enum-varnames used elsewhere already? |
Sorry, something went wrong.
Yes, OpenAPITools adopted it in this PR -> OpenAPITools/openapi-generator#917 I did also search around for any other official or even adopted standard for this but came up empty. |
Sorry, something went wrong.
…the values length
|
Just fixed the possible null reference that failed tests. Also added a sanity check to ensure the lengths of the var_names matches the length of the actual values, inspired by the OpenAPITools implementation. |
Sorry, something went wrong.
# Conflicts: # tests/test_parser/test_properties/test_init.py
dbanty
left a comment
There was a problem hiding this comment.
Looking good! In addition to the one thought below, could you add something to the README about this feature? It's kinda the only docs we have right now 😓
Sorry, something went wrong.
dbanty
left a comment
There was a problem hiding this comment.
I think this is good to go. We should come up with a way to emit warnings effectively that don't stop code from being generated, but that needs some broader thinking outside this change.
Sorry, something went wrong.
> [!IMPORTANT] > Merging this pull request will create this release ## Features ### Adding support for named integer enums #1214 by @barrybarrette Adding support for named integer enums via an optional extension, `x-enum-varnames`. This extension is added to the schema inline with the `enum` definition: ``` "MyEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 99 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Deinstalled", "Installed", "Upcoming_Site", "Lab_Site", "Pending_Deinstall", "Suspended", "Install_In_Progress", "Unknown" ] } ``` The result:  Co-authored-by: knope-bot[bot] <152252888+knope-bot[bot]@users.noreply.github.com>
Adding support for named enums via an optional extension,
`x-enum-varnames`.
This extension is added to the schema inline with the `enum` definition:
```
"Siva.e_Install_State": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
99
],
"type": "integer",
"format": "int32",
"x-enum-varnames": [
"Deinstalled",
"Installed",
"Upcoming_Site",
"Lab_Site",
"Pending_Deinstall",
"Suspended",
"Install_In_Progress",
"Unknown"
]
},
```
The result:
---------
Co-authored-by: Barry Barrette <bbarrette@sonifi.com>
> [!IMPORTANT] > Merging this pull request will create this release ## Features ### Adding support for named integer enums openapi-generators#1214 by @barrybarrette Adding support for named integer enums via an optional extension, `x-enum-varnames`. This extension is added to the schema inline with the `enum` definition: ``` "MyEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 99 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Deinstalled", "Installed", "Upcoming_Site", "Lab_Site", "Pending_Deinstall", "Suspended", "Install_In_Progress", "Unknown" ] } ``` The result:  Co-authored-by: knope-bot[bot] <152252888+knope-bot[bot]@users.noreply.github.com>
Building on #1214, this allows customization of string enumerations in exactly the same way as integer enumerations.
Adding support for named enums via an optional extension, x-enum-varnames.
This extension is added to the schema inline with the enum definition:
"Siva.e_Install_State": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 99 ], "type": "integer", "format": "int32", "x-enum-varnames": [ "Deinstalled", "Installed", "Upcoming_Site", "Lab_Site", "Pending_Deinstall", "Suspended", "Install_In_Progress", "Unknown" ] },The result:
