SyncRestOpenApiManifestOptions
Defined in: wp-typia-block-runtime/src/metadata-core.ts:285
Manifest-first 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
manifest
Section titled “manifest”manifest:
EndpointManifestDefinition
Defined in: wp-typia-block-runtime/src/metadata-core.ts:287
Canonical endpoint manifest describing the REST surface.
contracts?
Section titled “contracts?”
optionalcontracts?:undefined
Defined in: wp-typia-block-runtime/src/metadata-core.ts:289
Not accepted when manifest is provided.
endpoints?
Section titled “endpoints?”
optionalendpoints?:undefined
Defined in: wp-typia-block-runtime/src/metadata-core.ts:291
Not accepted when manifest is provided.
openApiInfo?
Section titled “openApiInfo?”
optionalopenApiInfo?:undefined
Defined in: wp-typia-block-runtime/src/metadata-core.ts:293
Not accepted when manifest is provided.