interface SdkOpenApiSchema
Since 0.1.0

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}

Properties

readonly
optional
type: string | string[]
readonly
optional
$ref: string
readonly
optional
properties: Record<string, SdkOpenApiSchema>
readonly
optional
required: string[]
readonly
optional
additionalProperties: boolean | SdkOpenApiSchema
readonly
optional
items: SdkOpenApiSchema
readonly
optional
enum: unknown[]
readonly
optional
const: unknown
readonly
optional
anyOf: SdkOpenApiSchema[]
readonly
optional
allOf: SdkOpenApiSchema[]
readonly
optional
oneOf: SdkOpenApiSchema[]
readonly
optional
description: string
readonly
optional
format: string

Usage

import { type SdkOpenApiSchema } from "sdk/src/index.ts";