Skip to main content

SdkManifest

@webda/sdk

Interface: SdkManifest

Defined in: sdk/src/manifest.ts:75

The contract between the application and the generator: every operation with every way the server exposes it, the models, their schemas and what the application serves

Properties​

models​

models: Record<string, SdkManifestModel>

Defined in: sdk/src/manifest.ts:80

namespace​

namespace: string

Defined in: sdk/src/manifest.ts:78

Application namespace, e.g. WebdaDemo

offline?​

optional offline?: object

Defined in: sdk/src/manifest.ts:90

Present when a Webda/SyncService is configured

models​

models: string[]

operations​

operations: object

operations.pull​

pull: string

operations.push​

push: string

operations.snapshot​

snapshot: string

operations.watch?​

optional watch?: string

operations​

operations: Record<string, SdkManifestOperation>

Defined in: sdk/src/manifest.ts:79

schemas​

schemas: Record<string, JSONSchema7>

Defined in: sdk/src/manifest.ts:82

Every referenced schema, local definitions hoisted

transports​

transports: object

Defined in: sdk/src/manifest.ts:84

What the application serves, so createClient() can pick defaults

graphql?​

optional graphql?: object

graphql.subscriptions?​

optional subscriptions?: boolean

graphql.url​

url: string

grpc?​

optional grpc?: object

grpc.package​

package: string

grpc.protoFile​

protoFile: string

rest?​

optional rest?: object

rest.url​

url: string

version​

version: 1

Defined in: sdk/src/manifest.ts:76