Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions content/docs/references/api/protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ description: Protocol protocol schemas
## TypeScript Usage

```typescript
import { BatchDataRequestSchema, BatchDataResponseSchema, CreateDataRequestSchema, CreateDataResponseSchema, CreateManyDataRequestSchema, CreateManyDataResponseSchema, DeleteDataRequestSchema, DeleteDataResponseSchema, DeleteManyDataRequestSchema, DeleteManyDataResponseSchema, FindDataRequestSchema, FindDataResponseSchema, GetDataRequestSchema, GetDataResponseSchema, GetDiscoveryRequestSchema, GetDiscoveryResponseSchema, GetMetaItemCachedRequestSchema, GetMetaItemCachedResponseSchema, GetMetaItemRequestSchema, GetMetaItemResponseSchema, GetMetaItemsRequestSchema, GetMetaItemsResponseSchema, GetMetaTypesRequestSchema, GetMetaTypesResponseSchema, GetUiViewRequestSchema, GetUiViewResponseSchema, ObjectStackProtocolSchema, UpdateDataRequestSchema, UpdateDataResponseSchema, UpdateManyDataRequestSchema, UpdateManyDataResponseSchema } from '@objectstack/spec/api';
import type { BatchDataRequest, BatchDataResponse, CreateDataRequest, CreateDataResponse, CreateManyDataRequest, CreateManyDataResponse, DeleteDataRequest, DeleteDataResponse, DeleteManyDataRequest, DeleteManyDataResponse, FindDataRequest, FindDataResponse, GetDataRequest, GetDataResponse, GetDiscoveryRequest, GetDiscoveryResponse, GetMetaItemCachedRequest, GetMetaItemCachedResponse, GetMetaItemRequest, GetMetaItemResponse, GetMetaItemsRequest, GetMetaItemsResponse, GetMetaTypesRequest, GetMetaTypesResponse, GetUiViewRequest, GetUiViewResponse, ObjectStackProtocol, UpdateDataRequest, UpdateDataResponse, UpdateManyDataRequest, UpdateManyDataResponse } from '@objectstack/spec/api';
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);
Expand Down Expand Up @@ -61,6 +61,14 @@ const result = BatchDataRequestSchema.parse(data);

---

## DeleteViewRequest

---

## DeleteViewResponse

---

## FindDataRequest

---
Expand Down Expand Up @@ -125,6 +133,10 @@ const result = BatchDataRequestSchema.parse(data);

---

## GetViewRequest

---

## ObjectStackProtocol

---
Expand Down
7 changes: 7 additions & 0 deletions packages/spec/json-schema/api/DeleteViewRequest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$ref": "#/definitions/DeleteViewRequest",
"definitions": {
"DeleteViewRequest": {}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
7 changes: 7 additions & 0 deletions packages/spec/json-schema/api/DeleteViewResponse.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$ref": "#/definitions/DeleteViewResponse",
"definitions": {
"DeleteViewResponse": {}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
7 changes: 7 additions & 0 deletions packages/spec/json-schema/api/GetViewRequest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$ref": "#/definitions/GetViewRequest",
"definitions": {
"GetViewRequest": {}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
31 changes: 31 additions & 0 deletions packages/spec/src/api/protocol.zod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,33 @@ export const DeleteManyDataRequestSchema = z.object({
*/
export const DeleteManyDataResponseSchema = BatchUpdateResponseSchema;

// ==========================================
// View Storage Operations
// ==========================================

/**
* Get View Request
* Get a stored view configuration by ID
*/
export const GetViewRequestSchema = z.object({
id: z.string().describe('View ID'),
});

/**
* Delete View Request
* Delete a stored view configuration
*/
export const DeleteViewRequestSchema = z.object({
id: z.string().describe('View ID to delete'),
});

/**
* Delete View Response
*/
export const DeleteViewResponseSchema = z.object({
success: z.boolean().describe('Whether deletion succeeded'),
});

// ==========================================
// Protocol Interface Schema
// ==========================================
Expand Down Expand Up @@ -412,6 +439,10 @@ export type UpdateManyDataResponse = z.infer<typeof UpdateManyDataResponseSchema
export type DeleteManyDataRequest = z.input<typeof DeleteManyDataRequestSchema>;
export type DeleteManyDataResponse = z.infer<typeof DeleteManyDataResponseSchema>;

export type GetViewRequest = z.infer<typeof GetViewRequestSchema>;
export type DeleteViewRequest = z.infer<typeof DeleteViewRequestSchema>;
export type DeleteViewResponse = z.infer<typeof DeleteViewResponseSchema>;

export type ObjectStackProtocol = z.infer<typeof ObjectStackProtocolSchema>;

/**
Expand Down
Loading