Skip to Content

exportRegistryOpenApi

function exportRegistryOpenApi(
	registry: Record<string, RegistryEntry>,
	opts?: { title?: string; version?: string },
): Record<string, unknown>

Output shape

  • openapi: '3.1.0'
  • info.title / info.version from opts or sensible defaults.
  • paths:
    • For each entry with route + httpMethod, emits a real REST path with a simple 200 response description.
    • Additionally, every fnKey receives a placeholder POST /qa/rpc/{fnKey} operation documenting the JSON RPC_CALL envelope — this route is not mounted by the SDK; it documents how QA tools could call RPC over HTTP.

Limitations

  • OpenAPI cannot express the full RegistryEntry (labels, pipelines, file hints, JSON Schemas) — only minimal operation summaries.

See also

CoverageAPI index