Skip to content

Variable: AdapterFileSchema

Makaio Framework


Makaio Framework / contracts/config / AdapterFileSchema

const AdapterFileSchema: ZodObject<{ $schema: ZodLiteral<"makaio/adapter-config/v1">; bindings: ZodOptional<ZodArray<ZodObject<{ isDefault: ZodOptional<ZodBoolean>; providerConfigId: ZodString; }, $strict>>>; clientId: ZodOptional<ZodString>; description: ZodOptional<ZodString>; displayName: ZodOptional<ZodString>; enabled: ZodOptional<ZodBoolean>; helpLinks: ZodOptional<ZodArray<ZodObject<{ label: ZodString; url: ZodString; }, $strict>>>; instructions: ZodOptional<ZodString>; protocol: ZodOptional<ZodString>; providerDefinitionIds: ZodOptional<ZodArray<ZodString>>; settings: ZodOptional<ZodCustom<Record<string, unknown>, Record<string, unknown>>>; }, $strict>

Defined in: ../../../packages/contracts/src/config/adapter-file.ts:67

Schema for .makaio/adapters/<adapterName>.json.

The file stem is the canonical adapterName; the payload stores only the adapter’s own settings and bindings.

Metadata such as description, helpLinks, instructions, clientId, protocol, and providerDefinitionIds intentionally remain here because the plan freezes them into the public EffectiveAdapter view. Keeping them on the canonical adapter file lets framework-only and host consumers read the same adapter catalog without a second boot-owned projection layer.