Interface SdkOpenApiSchema

OpenAPI schema supporting the M21 emitted vocabulary:

Primitive types: {@code string}, {@code number}, {@code integer}, {@code boolean}, {@code null}
Arrays: {@code type: 'array'} with {@code items}
Objects: {@code type: 'object'} with {@code properties}/{@code required}/{@code additionalProperties}
Enums: {@code enum} array of literals
Const: {@code const} single literal
References: {@code $ref}
Unions: {@code anyOf} (used for nullable schemas)
Intersections: {@code allOf}
{@code oneOf} (union, mapped like {@code anyOf})
Empty schema → {@code unknown}

Since

0.1.0

interface SdkOpenApiSchema {
    $ref?: string;
    additionalProperties?: boolean | SdkOpenApiSchema;
    allOf?: SdkOpenApiSchema[];
    anyOf?: SdkOpenApiSchema[];
    const?: unknown;
    description?: string;
    enum?: unknown[];
    format?: string;
    items?: SdkOpenApiSchema;
    oneOf?: SdkOpenApiSchema[];
    properties?: Record<string, SdkOpenApiSchema>;
    required?: string[];
    type?: string | string[];
}

Index

Properties

$ref? additionalProperties? allOf? anyOf? const? description? enum? format? items? oneOf? properties? required? type?

Properties

`Optional` `Readonly`$ref

$ref?: string

`Optional` `Readonly`additionalProperties

additionalProperties?: boolean | SdkOpenApiSchema

`Optional` `Readonly`allOf

allOf?: SdkOpenApiSchema[]

`Optional` `Readonly`anyOf

anyOf?: SdkOpenApiSchema[]

`Optional` `Readonly`const

const?: unknown

`Optional` `Readonly`description

description?: string

`Optional` `Readonly`enum

enum?: unknown[]

`Optional` `Readonly`format

format?: string

`Optional` `Readonly`items

items?: SdkOpenApiSchema

`Optional` `Readonly`oneOf

oneOf?: SdkOpenApiSchema[]

`Optional` `Readonly`properties

properties?: Record<string, SdkOpenApiSchema>

`Optional` `Readonly`required

required?: string[]

`Optional` `Readonly`type

type?: string | string[]