Skip to content

schema-client.md

Latest commit

 

History

History
19 lines (15 loc) · 820 Bytes

schema-client.md

File metadata and controls

19 lines (15 loc) · 820 Bytes
Raw

Schema client

SchemaClient (OrkesClients.getSchemaClient()) manages versioned schema definitions through the Conductor schema API — registerSchema, getSchema, getAllSchemas, deleteSchema.

const schemas = clients.getSchemaClient();
await schemas.registerSchema([{ name: "order", type: "JSON", version: 1, data: {} }]);

OSS/Orkes: availability depends on the server deployment and permissions. Validate schemas in a non-production environment before making them required by workers or tasks.

There is no dedicated schema-client.md API reference page yet (tracked in documentation-parity.md); see the schemas API journey example for a runnable walkthrough of every method in the meantime.