Interface INumber

Number type schema info.

interface INumber {
    default?: null | number;
    deprecated?: boolean;
    description?: string;
    enum?: (null | number)[];
    example?: any;
    examples?: Record<string, any>;
    exclusiveMaximum?: boolean;
    exclusiveMinimum?: boolean;
    maximum?: number;
    minimum?: number;
    multipleOf?: number;
    nullable?: boolean;
    title?: string;
    type: "number";
}

Hierarchy (View Summary)

Properties

default? deprecated? description? enum? example? examples? exclusiveMaximum? exclusiveMinimum? maximum? minimum? multipleOf? nullable? title? type

Properties

Optionaldefault

default?: null | number

Default value.

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalenum

enum?: (null | number)[]

Enumeration values.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

OptionalexclusiveMaximum

exclusiveMaximum?: boolean

Exclusive maximum value restriction.

For reference, even though your Swagger (or OpenAPI) document has defined the exclusiveMaximum value as number, OpenAiComposer forcibly converts it to boolean type, and assign the numeric value to the maximum property.

OptionalexclusiveMinimum

exclusiveMinimum?: boolean

Exclusive minimum value restriction.

For reference, even though your Swagger (or OpenAPI) document has defined the exclusiveMinimum value as number, OpenAiComposer forcibly converts it to boolean type, and assign the numeric value to the minimum property.

Optionalmaximum

maximum?: number

Maximum value restriction.

Optionalminimum

minimum?: number

Minimum value restriction.

OptionalmultipleOf

multipleOf?: number

Multiple of value restriction.

Exclusive Minimum

0

Optionalnullable

nullable?: boolean

Whether to allow null value or not.

Optionaltitle

title?: string

Title of the schema.

type

type: "number"

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties