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?
optionalallOf?:OpenApiSchema[]
Defined in: core/types.ts:17
default?
optionaldefault?:JsonValue
Defined in: core/types.ts:15
description?
optionaldescription?:string
Defined in: core/types.ts:14
enum?
optionalenum?: (string|number)[]
Defined in: core/types.ts:10
example?
optionalexample?:JsonValue
Defined in: core/types.ts:29
format?
optionalformat?:string
Defined in: core/types.ts:8
items?
optionalitems?:OpenApiSchema
Defined in: core/types.ts:11
maximum?
optionalmaximum?:number
Defined in: core/types.ts:25
maxLength?
optionalmaxLength?:number
Defined in: core/types.ts:27
minimum?
optionalminimum?:number
Defined in: core/types.ts:24
minLength?
optionalminLength?:number
Defined in: core/types.ts:26
nullable?
optionalnullable?:boolean
Defined in: core/types.ts:23
OpenAPI 3.0 nullability.
pattern?
optionalpattern?:string
Defined in: core/types.ts:28
properties?
optionalproperties?:Record<string,OpenApiSchema>
Defined in: core/types.ts:12
readOnly?
optionalreadOnly?:boolean
Defined in: core/types.ts:19
Set by the server; never sent in a request body.
required?
optionalrequired?:string[]
Defined in: core/types.ts:13
title?
optionaltitle?:string
Defined in: core/types.ts:9
type?
optionaltype?:string
Defined in: core/types.ts:7
writeOnly?
optionalwriteOnly?:boolean
Defined in: core/types.ts:21
Sent in requests but never returned (e.g. a password).
x-ref?
optionalx-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?
optionalx-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?
optionalx-soat-ref?:string
Defined in: core/types.ts:42
Same as x-ref, under the name the SOAT API uses.