interface SdkOpenApiDocument
Since 0.1.0

Top-level OpenAPI 3.1 document consumed by {@code generateOpenApiClient}.

Properties

readonly
openapi: string

OpenAPI spec version string (expected {@code '3.1.0'}).

readonly
paths: Record<string, SdkOpenApiPathItem>

API paths keyed by path template.

readonly
optional
components: { readonly schemas?: Record<string, SdkOpenApiSchema>; }

Optional component definitions (schemas, parameters, etc.).

Usage

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