Skip to main content

FdmApiConfig

@nmi-agro/fdm-source


@nmi-agro/fdm-source / fdm-api/src / FdmApiConfig

Interface: FdmApiConfig

Defined in: fdm-api/src/index.ts:86

Describes the public configuration used to mount the FDM API application.

Properties

allowedOrigins?

optional allowedOrigins?: string[]

Defined in: fdm-api/src/index.ts:101

Allowed origins for CORS. When provided, CORS headers are added to all responses. Omit when the API is served from the same origin as the app.


appName

appName: string

Defined in: fdm-api/src/index.ts:88

Human-readable application name exposed in the generated OpenAPI document.


appUrl

appUrl: string

Defined in: fdm-api/src/index.ts:90

Canonical application URL used to build absolute problem type links.


basePath?

optional basePath?: string

Defined in: fdm-api/src/index.ts:96

Base path under which the API, OpenAPI document, and docs UI are served. Defaults to "/" for standalone deployments (e.g. api.yourdomain.com/docs). Set to "/api" when embedding in another app (e.g. app.yourdomain.com/api/docs).