Skip to content

Commit 25fa294

Browse files
Copilothotlong
andcommitted
Add generated JSON schemas and docs for view storage operations
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 92ea882 commit 25fa294

4 files changed

Lines changed: 35 additions & 2 deletions

File tree

content/docs/references/api/protocol.mdx

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Protocol protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
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';
16-
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';
15+
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';
16+
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';
1717

1818
// Validate data
1919
const result = BatchDataRequestSchema.parse(data);
@@ -61,6 +61,14 @@ const result = BatchDataRequestSchema.parse(data);
6161

6262
---
6363

64+
## DeleteViewRequest
65+
66+
---
67+
68+
## DeleteViewResponse
69+
70+
---
71+
6472
## FindDataRequest
6573

6674
---
@@ -125,6 +133,10 @@ const result = BatchDataRequestSchema.parse(data);
125133

126134
---
127135

136+
## GetViewRequest
137+
138+
---
139+
128140
## ObjectStackProtocol
129141

130142
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/DeleteViewRequest",
3+
"definitions": {
4+
"DeleteViewRequest": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/DeleteViewResponse",
3+
"definitions": {
4+
"DeleteViewResponse": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/GetViewRequest",
3+
"definitions": {
4+
"GetViewRequest": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}

0 commit comments

Comments
 (0)