OasArray
OasArray is an object representing an OpenAPI array schema.
Properties
| Property | Type | Description |
|---|---|---|
| oasType | 'schema' | Static value representing the OpenAPI schema type. |
| type | 'array' | Static value representing the OpenAPI array schema type. |
| items | OasSchema | OasRef<'schema'> | OasSchema or reference to it, representing the items in the array. |
| title | string | undefined | Optional title of the array. |
| description | string | undefined | Optional description of the array. |
| nullable | boolean | undefined | Optional flag indicating whether the array can be null. |
| uniqueItems | boolean | undefined | Optional flag indicating whether the array items must be unique. |
| 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. |
| example | unknown | undefined | Optional example value for the array. |
Methods
isRef
Returns false indicating that the array is not a reference.
array.isRef()
Return value
false
resolve
Returns the array itself.
array.resolve()
Return value
The array itself.
resolveOnce
Returns the array itself.
array.resolveOnce()
Return value