API Request Schemas
API Request Schemas
Section titled “API Request Schemas”Workflow Creation
Section titled “Workflow Creation”CreateWorkflowSchema
Section titled “CreateWorkflowSchema”Validates chainId, address, Solidity compiler input, version, contract path/name, optional constructor args via Zod schema.
CreateWorkflowInput
Section titled “CreateWorkflowInput”Inferred TypeScript interface from CreateWorkflowSchema Zod validator including all required and optional fields.
Metadata Management
Section titled “Metadata Management”SaveMetadataSchema
Section titled “SaveMetadataSchema”Validates name (1-64 chars), category enum, description (10-500), publisher object, optional tags/links via Zod.
SaveMetadataInput
Section titled “SaveMetadataInput”Inferred TypeScript interface from SaveMetadataSchema including name, category, description, publisher, tags, links.
UI Schema Management
Section titled “UI Schema Management”SaveUISchemaSchema
Section titled “SaveUISchemaSchema”Validates method configs with selectors, visibility, labels, param types, groups, theme colors via nested Zod schemas.
SaveUISchemaInput
Section titled “SaveUISchemaInput”Inferred TypeScript interface from SaveUISchemaSchema including methods, groups, theme configuration objects.
Publication
Section titled “Publication”PublishSchema
Section titled “PublishSchema”Validates optional confirmed boolean field via Zod schema for POST /api/workflows/:id/publish endpoint.
PublishInput
Section titled “PublishInput”Inferred TypeScript interface from PublishSchema containing optional confirmed boolean field.
Query Parameters
Section titled “Query Parameters”WorkflowIdParamSchema
Section titled “WorkflowIdParamSchema”Validates workflowId field as valid UUID format via Zod string schema with uuid validation.
GetWorkflowByContractQuerySchema
Section titled “GetWorkflowByContractQuerySchema”Validates and transforms chainId string to positive integer, validates address as hex format via Zod.