OpenAPI: Move to oneOf for the types#4899
Merged
rdblue merged 1 commit intoapache:masterfrom May 30, 2022
Merged
Conversation
All the types match exactly one of the schemas:
```json
"string"
{"type": "struct", ...}
{"type": "list", ...}
{"type": "map", ...}
```
For more information:
https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/
We could also add a discriminator if we bump the primitive type
to an object as well. My suggestion would be to break down:
```json
"fixed[22]"
```
into
```json
{"type": "fixed", "length": 22}
```
This would allow us to set:
```yaml
Type:
oneOf:
- $ref: '#/components/schemas/PrimitiveType'
- $ref: '#/components/schemas/StructType'
- $ref: '#/components/schemas/ListType'
- $ref: '#/components/schemas/MapType'
discriminator:
propertyName: type
```
This way the OpenAPI spec also defines how to
distinguish the different types.
rdblue
approved these changes
May 30, 2022
Contributor
|
Thanks, @Fokko! I agree it is more clear this way. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
All the types match exactly one of the schemas:
For more information:
https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/
The types are mutually exclusive (in the schema, technically an int can also be promoted to a long). The aforementioned types should map to exactly one type.
We could also add a discriminator if we bump the primitive type to an object as well. My suggestion would be to break down:
into
{"type": "fixed", "size": 22} # and {"type": "string"}This would allow us to set:
This way the OpenAPI spec also defines how to distinguish the different types.