Interface SdkOpenApiDocument

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

Since

0.1.0

interface SdkOpenApiDocument {
    components?: { schemas?: Record<string, SdkOpenApiSchema> };
    openapi: string;
    paths: Record<string, SdkOpenApiPathItem>;
}

Index

Properties

components? openapi paths

Properties

`Optional` `Readonly`components

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

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

`Readonly`openapi

openapi: string

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

`Readonly`paths

paths: Record<string, SdkOpenApiPathItem>

API paths keyed by path template.