Skip to main content

Type Alias: OpenApiSchema

OpenApiSchema = object

Defined in: core/types.ts:6

Indexable​

[extension: `x-${string}`]: unknown

Properties​

$ref?​

optional $ref?: string

Defined in: core/types.ts:16


allOf?​

optional allOf?: OpenApiSchema[]

Defined in: core/types.ts:17


default?​

optional default?: JsonValue

Defined in: core/types.ts:15


description?​

optional description?: string

Defined in: core/types.ts:14


enum?​

optional enum?: (string | number)[]

Defined in: core/types.ts:10


example?​

optional example?: JsonValue

Defined in: core/types.ts:29


format?​

optional format?: string

Defined in: core/types.ts:8


items?​

optional items?: OpenApiSchema

Defined in: core/types.ts:11


maximum?​

optional maximum?: number

Defined in: core/types.ts:25


maxLength?​

optional maxLength?: number

Defined in: core/types.ts:27


minimum?​

optional minimum?: number

Defined in: core/types.ts:24


minLength?​

optional minLength?: number

Defined in: core/types.ts:26


nullable?​

optional nullable?: boolean

Defined in: core/types.ts:23

OpenAPI 3.0 nullability.


pattern?​

optional pattern?: string

Defined in: core/types.ts:28


properties?​

optional properties?: Record<string, OpenApiSchema>

Defined in: core/types.ts:12


readOnly?​

optional readOnly?: boolean

Defined in: core/types.ts:19

Set by the server; never sent in a request body.


required?​

optional required?: string[]

Defined in: core/types.ts:13


title?​

optional title?: string

Defined in: core/types.ts:9


type?​

optional type?: string

Defined in: core/types.ts:7


writeOnly?​

optional writeOnly?: boolean

Defined in: core/types.ts:21

Sent in requests but never returned (e.g. a password).


x-ref?​

optional x-ref?: string

Defined in: core/types.ts:40

Marks a field holding the id of a record of another resource, named by its path segment, key or tag (e.g. 'x-ref': 'clients'). Forms pick the value from that resource's list; tables and detail views link to it.


x-sensitive?​

optional x-sensitive?: boolean

Defined in: core/types.ts:34

Marks a field the UI should never display in clear text (tokens, secrets). Complements the name-based heuristic in isSensitiveKey.


x-soat-ref?​

optional x-soat-ref?: string

Defined in: core/types.ts:42

Same as x-ref, under the name the SOAT API uses.