OasBoolean
OasBoolean is an object representing an OpenAPI boolean schema.
Properties
| Property | Type | Description |
|---|---|---|
| oasType | 'schema' | Static value representing the OpenAPI schema type. |
| type | 'boolean' | Static value representing the OpenAPI boolean schema type. |
| title | string | undefined | Optional title of the boolean. |
| description | string | undefined | Optional description of the boolean. |
| nullable | boolean | undefined | Optional flag indicating whether the boolean can be null. |
| example | boolean | undefined | Optional example value for the boolean. |
| extensionFields | Record<string, unknown> | undefined | Optional map of custom fields defined by OpenAPI extensions. Keys are strings beginning with x- and values are of any valid JSON type. |
Methods
isRef
Returns false indicating that the boolean is not a reference.
boolean.isRef()
Return value
false
resolve
Returns the boolean itself.
boolean.resolve()
Return value
The boolean itself.
resolveOnce
Returns the boolean itself.
boolean.resolveOnce()
Return value
The boolean itself.