docs(api-sdk): enums specific properties use-case #3013
+43
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
View your CI Pipeline Execution ↗ for commit a453146.
☁️ Nx Cloud last updated this comment at |
github-actions
bot
added
the
documentation
cpaulve-1A
reviewed
Mar 17, 2025
vscaiceanu-1a
force-pushed
the
docs/swagger-enum-inheritance
branch
from
e613d8e to
e0b7c14
Compare
| @@ -147,6 +147,43 @@ export function revivePet<T extends Pet = Pet>(data: any): undefined | T | Cat | | |||
| > The discriminator needs to be of enum type as the string format would be too generic to map the accepted | |||
| > value to the supported models. | |||
|
|
|||
| ### Enum specific properties | |||
|
|
|||
| If the a specific property is of type enum, make sure to explicitly declare the type object. | |||
There was a problem hiding this comment.
I would expect to always have the type object for allOf elements that are not ref
We discovered the issue concerning enum but maybe there are others
https://swagger.io/docs/specification/v3_0/data-models/oneof-anyof-allof-not/#allof
looking at there documentation they always specify the type object
There was a problem hiding this comment.
If you check on https://editor.swagger.io/ it seems that
Dog:
allOf:
- $ref: '#/components/schemas/Pet'
properties:
bark:
type: boolean
breed:
type: string
enum: [Dingo, Husky, Retriever, Shepherd]is not even valid
There was a problem hiding this comment.
Sorry, I missed the indent in the docs.
Dog:
allOf:
- $ref: '#/components/schemas/Pet'
properties:
bark:
type: boolean
breed:
type: string
enum: [Dingo, Husky, Retriever, Shepherd]is valid.
mrednic-1A
reviewed
Mar 17, 2025
kpanot
reviewed
Mar 18, 2025
| @@ -147,6 +147,43 @@ export function revivePet<T extends Pet = Pet>(data: any): undefined | T | Cat | | |||
| > The discriminator needs to be of enum type as the string format would be too generic to map the accepted | |||
| > value to the supported models. | |||
|
|
|||
| ### Enum specific properties | |||
There was a problem hiding this comment.
I would not reduce the case to enums.
I wonder if it would not make more sense to have a file dedicated to cases that we do not support but have a workaround.
Here it is mainly the properties to a allOf instruction.
vscaiceanu-1a
force-pushed
the
docs/swagger-enum-inheritance
branch
from
e0b7c14 to
d3d8fb9
Compare
vscaiceanu-1a
force-pushed
the
docs/swagger-enum-inheritance
branch
2 times, most recently
from
5d62964 to
b9000cb
Compare
vscaiceanu-1a
force-pushed
the
docs/swagger-enum-inheritance
branch
from
b9000cb to
a453146
Compare
kpanot
approved these changes
Mar 25, 2025
| export type BreedEnum = 'Dingo' | 'Husky' | 'Retriever' | 'Shepherd'; | ||
| ``` | ||
|
|
||
| The issue is tracked via https://github.com/AmadeusITGroup/otter/issues/3017. |
There was a problem hiding this comment.
Suggested change
| The issue is tracked via https://github.com/AmadeusITGroup/otter/issues/3017. | |
| > [!INFO] | |
| > The issue is tracked via https://github.com/AmadeusITGroup/otter/issues/3017. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Related issues
allOf#2832