Skip to content

Latest commit

 

History

History
157 lines (83 loc) · 2.86 KB

File metadata and controls

157 lines (83 loc) · 2.86 KB
title Protocol
description Protocol protocol schemas

Protocol

**Source:** `packages/spec/src/api/protocol.zod.ts`

TypeScript Usage

import { BatchDataRequestSchema, BatchDataResponseSchema, CreateDataRequestSchema, CreateDataResponseSchema, CreateManyDataRequestSchema, CreateManyDataResponseSchema, DeleteDataRequestSchema, DeleteDataResponseSchema, DeleteManyDataRequestSchema, DeleteManyDataResponseSchema, DeleteViewRequestSchema, DeleteViewResponseSchema, FindDataRequestSchema, FindDataResponseSchema, GetDataRequestSchema, GetDataResponseSchema, GetDiscoveryRequestSchema, GetDiscoveryResponseSchema, GetMetaItemCachedRequestSchema, GetMetaItemCachedResponseSchema, GetMetaItemRequestSchema, GetMetaItemResponseSchema, GetMetaItemsRequestSchema, GetMetaItemsResponseSchema, GetMetaTypesRequestSchema, GetMetaTypesResponseSchema, GetUiViewRequestSchema, GetUiViewResponseSchema, GetViewRequestSchema, ObjectStackProtocolSchema, UpdateDataRequestSchema, UpdateDataResponseSchema, UpdateManyDataRequestSchema, UpdateManyDataResponseSchema } from '@objectstack/spec/api';
import type { BatchDataRequest, BatchDataResponse, CreateDataRequest, CreateDataResponse, CreateManyDataRequest, CreateManyDataResponse, DeleteDataRequest, DeleteDataResponse, DeleteManyDataRequest, DeleteManyDataResponse, DeleteViewRequest, DeleteViewResponse, FindDataRequest, FindDataResponse, GetDataRequest, GetDataResponse, GetDiscoveryRequest, GetDiscoveryResponse, GetMetaItemCachedRequest, GetMetaItemCachedResponse, GetMetaItemRequest, GetMetaItemResponse, GetMetaItemsRequest, GetMetaItemsResponse, GetMetaTypesRequest, GetMetaTypesResponse, GetUiViewRequest, GetUiViewResponse, GetViewRequest, ObjectStackProtocol, UpdateDataRequest, UpdateDataResponse, UpdateManyDataRequest, UpdateManyDataResponse } from '@objectstack/spec/api';

// Validate data
const result = BatchDataRequestSchema.parse(data);

BatchDataRequest


BatchDataResponse


CreateDataRequest


CreateDataResponse


CreateManyDataRequest


CreateManyDataResponse


DeleteDataRequest


DeleteDataResponse


DeleteManyDataRequest


DeleteManyDataResponse


DeleteViewRequest


DeleteViewResponse


FindDataRequest


FindDataResponse


GetDataRequest


GetDataResponse


GetDiscoveryRequest


GetDiscoveryResponse


GetMetaItemCachedRequest


GetMetaItemCachedResponse


GetMetaItemRequest


GetMetaItemResponse


GetMetaItemsRequest


GetMetaItemsResponse


GetMetaTypesRequest


GetMetaTypesResponse


GetUiViewRequest


GetUiViewResponse


GetViewRequest


ObjectStackProtocol


UpdateDataRequest


UpdateDataResponse


UpdateManyDataRequest


UpdateManyDataResponse