Skip to main content

ServiceSchemaOptions

@webda/content-mapper

Interface: ServiceSchemaOptions

Defined in: packages/content-mapper/src/schema/service.ts:23

What is needed to find and convert a service's parameters.

Properties​

addOpenApi?​

optional addOpenApi?: boolean

Defined in: packages/content-mapper/src/schema/service.ts:38

Add the free-form openapi property. True for moddas and beans, false for deployers — WebdaSchemaResults.generateSchemas gates it the same way.

checker​

checker: Checker

Defined in: packages/content-mapper/src/schema/service.ts:27

The resident checker.

parametersBase?​

optional parametersBase?: string

Defined in: packages/content-mapper/src/schema/service.ts:32

Base type the parameters must derive from. ServiceParameters for moddas and beans, DeployerResources for deployers.

project​

project: Project

Defined in: packages/content-mapper/src/schema/service.ts:25

Project the checker belongs to.

title?​

optional title?: string

Defined in: packages/content-mapper/src/schema/service.ts:40

title for the document; the service class name, not the parameters class.