Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Change nullable & type for OpenApi v3.1.0 #1502

Merged
merged 7 commits into from
Nov 30, 2023
Merged

Feat: Change nullable & type for OpenApi v3.1.0 #1502

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ebb0c87
Change nullable & type for OpenApi v3.1
DjordyKoert Nov 17, 2023
b5022e2
Add validate schema tests
DjordyKoert Nov 17, 2023
2b61fdb
Revert "Add validate schema tests"
DjordyKoert Nov 23, 2023
e3edbbe
Remove validation
DjordyKoert Nov 23, 2023
a3e0067
Add Nullable test for multiple types
DjordyKoert Nov 24, 2023
d4aab3d
Fix TypeError when type is array
DjordyKoert Nov 24, 2023
f712c8a
Add Types31 test
DjordyKoert Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions docs/reference/annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -956,10 +956,12 @@ An object instance is valid against this property if its number of properties is
<dt><strong>required</strong> : <span style="font-family: monospace;">string[]</span></dt>
<dd><p>An object instance is valid against this property if its property set contains all elements in this property's<br />
array value.</p></dd>
<dt><strong>type</strong> : <span style="font-family: monospace;">string</span></dt>
<dt><strong>type</strong> : <span style="font-family: monospace;">string|non-empty-array&lt;string&gt;</span></dt>
<dd><p>The type of the schema/property.<br />
<br />
The value MUST be one of "string", "number", "integer", "boolean", "array" or "object".</p></dd>
OpenApi v3.0: The value MUST be one of "string", "number", "integer", "boolean", "array" or "object".<br />
<br />
Since OpenApi v3.1 an array of types may be used.</p></dd>
<dt><strong>format</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd>
<dt><strong>collectionFormat</strong> : <span style="font-family: monospace;">string</span></dt>
Expand Down Expand Up @@ -1009,7 +1011,7 @@ An array instance is valid against this property if its number of items is great
<dd><p>A boolean value indicating whether all items in an array property must be unique.<br />
<br />
If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd>
<dt><strong>enum</strong> : <span style="font-family: monospace;">string[]|int[]|float[]|\UnitEnum[]|class-string</span></dt>
<dt><strong>enum</strong> : <span style="font-family: monospace;">string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string</span></dt>
<dd><p>A collection of allowable values for a property.<br />
<br />
A property instance is valid against this attribute if its value is one of the values specified in this collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd>
Expand Down Expand Up @@ -1040,7 +1042,10 @@ To represent examples that cannot naturally be represented in JSON or YAML, a st
contain the example with escaping where necessary.</p></dd>
<dt><strong>nullable</strong> : <span style="font-family: monospace;">bool</span></dt>
<dd><p>Allows sending a null value for the defined schema.<br />
Default value is false.</p></dd>
Default value is false.<br />
<br />
This must not be used when using OpenApi version 3.1,<br />
instead make the "type" property an array and add "null" as a possible type.</p></dd>
<dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool</span></dt>
<dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
Default value is false.</p></dd>
Expand Down Expand Up @@ -1093,7 +1098,7 @@ defined by this property's value.</p></dd>
<dd><p>The relative or absolute path to a security scheme.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd>
<dt><strong>securityScheme</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into OpenApi->security array.</p></dd>
<dt><strong>type</strong> : <span style="font-family: monospace;">string</span></dt>
<dt><strong>type</strong> : <span style="font-family: monospace;">string|non-empty-array&lt;string&gt;</span></dt>
<dd><p>The type of the security scheme.</p></dd>
<dt><strong>description</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>A short description for security scheme.</p></dd>
Expand Down Expand Up @@ -1163,7 +1168,7 @@ An object representing a server variable for server URL template substitution.
<dl>
<dt><strong>serverVariable</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The key into Server->variables array.</p></dd>
<dt><strong>enum</strong> : <span style="font-family: monospace;">string[]|int[]|float[]|\UnitEnum[]|class-string</span></dt>
<dt><strong>enum</strong> : <span style="font-family: monospace;">string[]|int[]|float[]|bool[]|\UnitEnum[]|class-string</span></dt>
<dd><p>An enumeration of values to be used if the substitution options are from a limited set.</p></dd>
<dt><strong>default</strong> : <span style="font-family: monospace;">string</span></dt>
<dd><p>The default value to use for substitution, and to send, if an alternate value is not supplied.<br />
Expand Down
Loading
Loading