Skip to content

applyConfiguredServer

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/apps/api/src/technical-docs/spec-server-overlay.ts

Serve the owner's configured base URL as the spec's server.

The generator injects a placeholder (https://api.example.com) whenever the parse finds no server, and every regeneration re-injects it — so editing the stored spec would not survive. Meanwhile settings.apiExec.baseUrl already drives try-it host pinning but never reached the served spec, leaving the playground unable to build a real URL even for projects that HAD configured one. Overlaying here fixes both: the playground gets a usable base URL, and it keeps working across regenerations.

Shared by BOTH surfaces deliberately. It lived on the public controller, so the reader got a working base URL while the owner's own playground still pointed at api.example.com — the person who configured the base URL was the one person who could not see it.

Signature

ts
function applyConfiguredServer(spec: Record<string, unknown>, settings: Record<string, unknown> | null): Record<string, unknown>

Parameters

NameType
specRecord<string, unknown>
settings`Record<string, unknown>

Returns: Record<string, unknown>

Was this page helpful?

Download as PDF