SyncRestOpenApiContractsOptions
Defined in: wp-typia-block-runtime/src/metadata-core.ts:299
Backward-compatible options for writing a canonical endpoint-aware REST OpenAPI document.
Extends
Section titled “Extends”SyncRestOpenApiBaseOptions
Properties
Section titled “Properties”openApiFile
Section titled “openApiFile”openApiFile:
string
Defined in: wp-typia-block-runtime/src/metadata-core.ts:275
Output path for the aggregate OpenAPI document.
Inherited from
Section titled “Inherited from”SyncRestOpenApiBaseOptions.openApiFile
projectRoot?
Section titled “projectRoot?”
optionalprojectRoot?:string
Defined in: wp-typia-block-runtime/src/metadata-core.ts:277
Optional project root used to resolve file paths.
Inherited from
Section titled “Inherited from”SyncRestOpenApiBaseOptions.projectRoot
typesFile
Section titled “typesFile”typesFile:
string
Defined in: wp-typia-block-runtime/src/metadata-core.ts:279
Source file that exports the REST contract types.
Inherited from
Section titled “Inherited from”SyncRestOpenApiBaseOptions.typesFile
contracts
Section titled “contracts”contracts:
Readonly<Record<string,RestOpenApiContractDefinition>>
Defined in: wp-typia-block-runtime/src/metadata-core.ts:301
Contract registry keyed by logical route contract ids.
endpoints
Section titled “endpoints”endpoints: readonly
EndpointOpenApiEndpointDefinition[]
Defined in: wp-typia-block-runtime/src/metadata-core.ts:303
Endpoint registry describing the REST paths, methods, and auth policies to document.
openApiInfo?
Section titled “openApiInfo?”
optionalopenApiInfo?:OpenApiInfo
Defined in: wp-typia-block-runtime/src/metadata-core.ts:305
Optional OpenAPI document metadata.
manifest?
Section titled “manifest?”
optionalmanifest?:undefined
Defined in: wp-typia-block-runtime/src/metadata-core.ts:307
Not accepted when contracts and endpoints are provided directly.