Skip to content

Commit b5b20b8

Browse files
Copilothotlong
andcommitted
Initial plan
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 80d1c77 commit b5b20b8

48 files changed

Lines changed: 2485 additions & 152 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/docs/references/api/discovery.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Reports per-service availability so clients can adapt their UI accordingly.
1616
## TypeScript Usage
1717

1818
```typescript
19-
import { ApiRoutes, Discovery, ServiceInfo } from '@objectstack/spec/api';
20-
import type { ApiRoutes, Discovery, ServiceInfo } from '@objectstack/spec/api';
19+
import { ApiRoutes, Discovery, ServiceInfo, WellKnownCapabilities } from '@objectstack/spec/api';
20+
import type { ApiRoutes, Discovery, ServiceInfo, WellKnownCapabilities } from '@objectstack/spec/api';
2121

2222
// Validate data
2323
const result = ApiRoutes.parse(data);
@@ -85,3 +85,22 @@ const result = ApiRoutes.parse(data);
8585

8686
---
8787

88+
## WellKnownCapabilities
89+
90+
Well-known capability flags for frontend intelligent adaptation
91+
92+
### Properties
93+
94+
| Property | Type | Required | Description |
95+
| :--- | :--- | :--- | :--- |
96+
| **feed** | `boolean` || Whether the backend supports Feed / Chatter API |
97+
| **comments** | `boolean` || Whether the backend supports comments (a subset of Feed) |
98+
| **automation** | `boolean` || Whether the backend supports Automation CRUD (flows, triggers) |
99+
| **cron** | `boolean` || Whether the backend supports cron scheduling |
100+
| **search** | `boolean` || Whether the backend supports full-text search |
101+
| **export** | `boolean` || Whether the backend supports async export |
102+
| **chunkedUpload** | `boolean` || Whether the backend supports chunked (multipart) uploads |
103+
104+
105+
---
106+
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: View
3-
description: View protocol schemas
2+
title: Http
3+
description: Http protocol schemas
44
---
55

66
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}
77

88
<Callout type="info">
9-
**Source:** `packages/spec/src/api/view.zod.ts`
9+
**Source:** `packages/spec/src/api/http.zod.ts`
1010
</Callout>
1111

1212
## TypeScript Usage

content/docs/references/api/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ This section contains all protocol schemas for the api layer of ObjectStack.
2323
<Card href="/docs/references/api/http-cache" title="Http Cache" description="Source: packages/spec/src/api/http-cache.zod.ts" />
2424
<Card href="/docs/references/api/metadata" title="Metadata" description="Source: packages/spec/src/api/metadata.zod.ts" />
2525
<Card href="/docs/references/api/odata" title="Odata" description="Source: packages/spec/src/api/odata.zod.ts" />
26+
<Card href="/docs/references/api/package-api" title="Package Api" description="Source: packages/spec/src/api/package-api.zod.ts" />
2627
<Card href="/docs/references/api/plugin-rest-api" title="Plugin Rest Api" description="Source: packages/spec/src/api/plugin-rest-api.zod.ts" />
2728
<Card href="/docs/references/api/protocol" title="Protocol" description="Source: packages/spec/src/api/protocol.zod.ts" />
2829
<Card href="/docs/references/api/query-adapter" title="Query Adapter" description="Source: packages/spec/src/api/query-adapter.zod.ts" />

content/docs/references/api/meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@
1616
"export",
1717
"feed-api",
1818
"graphql",
19+
"http",
1920
"http-cache",
2021
"identity",
2122
"metadata",
2223
"metadata-plugin",
2324
"notification",
2425
"object",
2526
"odata",
27+
"package-api",
2628
"package-registry",
2729
"plugin-rest-api",
2830
"protocol",
@@ -34,7 +36,6 @@
3436
"router",
3537
"storage",
3638
"versioning",
37-
"view",
3839
"websocket"
3940
]
4041
}

0 commit comments

Comments
 (0)