UnpackedConfiguration

@webda/core

---

Type Alias: UnpackedConfiguration

UnpackedConfiguration = object

Defined in: packages/core/src/application/iconfiguration.ts:90

Unpacked configuration type definition

Properties

$import?

optional $import?: string[] | string

Defined in: packages/core/src/application/iconfiguration.ts:192

Include other configuration.json

This allow you to share Store definition or parameters between different components The configuration is merged with deepmerge(...imports, local)

---

application?

optional application?: object

Defined in: packages/core/src/application/iconfiguration.ts:95

Configuration of core

configurationService?

optional configurationService?: string

Read from the configuration service before init

Default

"ConfigurationService"

defaultStore?

optional defaultStore?: string

Define the default store

Default

"Registry"

ignoreBeans?

optional ignoreBeans?: boolean | string[]

Ignore beans

If set to true, all beans are ignored If set to an array, only the beans in the array are ignored

Default

false

---

models?

optional models?: Record<string, ModelConfiguration>

Defined in: packages/core/src/application/iconfiguration.ts:123

Model configuration keyed by fully qualified model identifier.

---

openapi?

optional openapi?: Partial<OpenAPIV3.Document>

Defined in: packages/core/src/application/iconfiguration.ts:185

OpenAPI override

Should move to Router

---

parameters?

optional parameters?: object

Defined in: packages/core/src/application/iconfiguration.ts:129

Global parameters

Shared between all services if it matches the service parameters

Index Signature

[key: string]: any

Allow any other type of parameters

apiUrl?

optional apiUrl?: string

Define the api url

configurationEncryption?

optional configurationEncryption?: ConfigurationEncryption

Configuration secrets encryption: default encrypter and encrypters options

It cannot hold encrypted values.

dryRun?

optional dryRun?: object

Dry run configuration for operations

dryRun.allowRequest?

optional allowRequest?: boolean

Accept the per-request X-Webda-Dry-Run header

dryRun.enabled?

optional enabled?: boolean

Run every operation in dry mode

dryRun.enforce?

optional enforce?: string[]

Operation id patterns that always run dry (glob, e.g. "Billing.*", "User.Delete")

dryRun.exclude?

optional exclude?: string[]

Operation id patterns never put in dry mode by enabled/request flags

metrics?

optional metrics?: false | { config?: {[key: string]: any; }; labels?: {[key: string]: string; }; prefix?: string; }

Define metrics

static?

optional static?: StaticWebsite

Serve statically a website

website?

optional website?: string | string[]

Origins allowed to call the API from a browser (CORS), matched on the request Origin header

Exact origins, https://*.example.com for the subdomains, or "*" for any origin

CorsOriginFilter

---

services?

optional services?: Record<string, any>

Defined in: packages/core/src/application/iconfiguration.ts:121

Services configuration

---

version

version: 4

Defined in: packages/core/src/application/iconfiguration.ts:91