Interface IArray

Common attributes for array types.

interface IArray {
    additionalItems?: boolean | OpenApiV3_1.IJsonSchema;
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    items?: OpenApiV3_1.IJsonSchema | OpenApiV3_1.IJsonSchema[];
    maxItems?: number;
    minItems?: number;
    nullable?: boolean;
    prefixItems?: OpenApiV3_1.IJsonSchema[];
    title?: string;
    type: "array";
    uniqueItems?: boolean;
}

Hierarchy (View Summary)

IJsonSchemaAttribute.IArray
- IArray

Index

Properties

additionalItems? deprecated? description? example? examples? items? maxItems? minItems? nullable? prefixItems? title? type uniqueItems?

Properties

`Optional`additionalItems

additionalItems?: boolean | OpenApiV3_1.IJsonSchema

`Optional`deprecated

deprecated?: boolean

Whether the type is deprecated or not.

`Optional`description

description?: string

Detailed description of the schema.

`Optional`example

example?: any

Example value.

`Optional`examples

examples?: Record<string, any>

List of example values as key-value pairs.

`Optional`items

items?: OpenApiV3_1.IJsonSchema | OpenApiV3_1.IJsonSchema[]

`Optional`maxItems

maxItems?: number

`Optional`minItems

minItems?: number

`Optional`nullable

nullable?: boolean

`Optional`prefixItems

prefixItems?: OpenApiV3_1.IJsonSchema[]

`Optional`title

title?: string

Title of the schema.

type

type: "array"

Discriminator value of the type.

`Optional`uniqueItems

uniqueItems?: boolean