You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As mentioned in #410 (comment), when using this plugin with an OpenAPI 3.1 schema that uses [string, null] as a list of valid types for a property, instead of showing the enum of types, it joins the array together with no spaces.
Expected behavior
Show a "nullable" tag for the property or just list the valid property types.
Hi @jasikpark, not sure this is a bug given that 3.1 support is, officially, currently limited. That said, I think we can add support for this new syntax, i.e. type arrays.
I guess my thought is presuming that the desire is to move towards better 3.1 support incrementally, therefore any issues with 3.1 support are bugs? Therefore this is a bug.
Another way to think is that "3.1 support is limited, so therefore any issues with the code are acceptable issues that aren't being prioritized right now", which I get but would be disappointed to hear about. And therefore this would be acceptable behavior and not a bug.
Describe the bug
As mentioned in #410 (comment), when using this plugin with an OpenAPI 3.1 schema that uses
[string, null]
as a list of valid types for a property, instead of showing the enum of types, it joins the array together with no spaces.Expected behavior
Show a "nullable" tag for the property or just list the valid property types.
For example of the usage, see https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0 and "Swap nullable for type arrays"
Another example of this valid usage in OpenAPI 3.1: OAI/OpenAPI-Specification#3148
Current behavior
The list of valid property types are joined into a string with no spaces.
Possible solution
Steps to reproduce
[string, null]
Screenshots
Context
Trying to keep up-to-date with the current OpenAPI schema while providing clear, useful, and accurate api docs to our users.
Your Environment
The text was updated successfully, but these errors were encountered: