interface OpenApiSchemaObject
Since 0.1.0

OpenAPI 3.1 schema object.

Properties

optional
type:
"string"
| "number"
| "integer"
| "boolean"
| "array"
| "object"
| "null"

Type of the value (string, number, integer, boolean, array, object, null).

optional
format: string

Format (e.g., 'email', 'uri', 'uuid', 'date-time').

For arrays: schema of items.

optional
properties: Record<string, OpenApiSchemaObject>

For objects: properties map.

optional
required: readonly string[]

For objects: required property names.

For objects: additional properties schema.

optional
minLength: number

For strings: minimum length.

optional
maxLength: number

For strings: maximum length.

optional
minimum: number

For numbers: minimum value.

optional
maximum: number

For numbers: maximum value.

optional
exclusiveMinimum: number

For numbers: exclusive minimum.

optional
exclusiveMaximum: number

For numbers: exclusive maximum.

optional
minItems: number

For arrays: minimum items.

optional
maxItems: number

For arrays: maximum items.

optional
enum: readonly (string | number | boolean)[]

Enum values.

optional
const: string | number | boolean

Const value.

optional
anyOf: readonly OpenApiSchemaObject[]

AnyOf for unions.

optional
allOf: readonly OpenApiSchemaObject[]

AllOf for intersections.

optional
default: unknown

Default value.

optional
$ref: string

Reference to a component schema.

Usage

import { type OpenApiSchemaObject } from "openapi-plugin/src/index.ts";