Skip to content

Commit dbb4803

Browse files
os-zhuangclaude
andauthored
docs: retire the /graphql endpoint contract and its protocol-page residue (#10845)
* docs: retire the /graphql endpoint contract and protocol residue (#10832) /graphql is not mounted. `packages/runtime/src/http-dispatcher.ts:2026` records its removal, there is no `createGraphQLDomain` among the domains registered at `http-dispatcher.ts:556-574`, and no `handleGraphQL` survives outside CHANGELOGs. Remove-vs-rewrite follows the 404/501 distinction in `packages/runtime/src/domains/unavailable.ts`: 404 = the route is not there; 501 = the route is there, the implementation is not. /graphql is in neither state, so it belongs in neither row of a catalog of servable routes. Deleted (the construct asserts a surface that does not exist): - `api/plugin-endpoints.mdx` — the whole `### GraphQL (/graphql)` section and its POST method/path table, plus GraphQL from the frontmatter enumeration. - `api/declarative-endpoints.mdx` — /graphql from the exemplar list pointing at that catalog; the two remaining examples are real mounted routes. - `protocol/diagram.mdx` — the `GQL[GraphQL]` node AND both its edges (`CLIENT --> GQL`, `GQL --> KERNEL`); mermaid materialises an undeclared node from a dangling edge, so deleting the declaration alone still renders a box. - `protocol/diagram.mdx` — GraphQL from the `src/api/` layer-table cell; that directory contains zero graphql files (re-measured). Rewritten (the surrounding claim is true; only the enumeration was wrong): - `protocol/diagram.mdx` sequence label → `HTTP Request (REST)`. - `protocol/kernel/lifecycle.mdx` → `Start HTTP server`, box width preserved. - `protocol/kernel/error-handling.mdx` → `(HTTP, WebSocket)`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DdCnBGcHeufjrq7drTD3wt * docs(api): reflow the plugin-endpoints callout after the /graphql removal Keeps the em dash attached to the clause it belongs to instead of orphaning it at the start of a line, and refills the paragraph. No claim changes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DdCnBGcHeufjrq7drTD3wt --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent baed0f7 commit dbb4803

5 files changed

Lines changed: 8 additions & 17 deletions

File tree

content/docs/api/declarative-endpoints.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ publish gates serves real traffic as soon as the package is published.
1212

1313
<Callout type="warn">
1414
**This is not [Plugin Endpoints](/docs/api/plugin-endpoints).** That page is a *catalog of
15-
built-in routes* the platform serves when a plugin is installed (`/auth`, `/automation`,
16-
`/graphql`, …) — you call those, you do not write them. This page is about the endpoints
17-
**you declare**, which live under your own namespace and never overlap with that catalog.
15+
built-in routes* the platform serves when a plugin is installed (`/auth`, `/automation`, …) —
16+
you call those, you do not write them. This page is about the endpoints **you declare**,
17+
which live under your own namespace and never overlap with that catalog.
1818
</Callout>
1919

2020
## Which channel: `actions` or `apis`?

content/docs/api/plugin-endpoints.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Plugin Endpoints
3-
description: REST endpoints that become available when the corresponding plugin is installed — auth, workflow, automation, views, realtime, notifications, AI, i18n, GraphQL, and file storage.
3+
description: REST endpoints that become available when the corresponding plugin is installed — auth, workflow, automation, views, realtime, notifications, AI, i18n, and file storage.
44
---
55

66
# Plugin Endpoints
@@ -142,12 +142,6 @@ protocol `ai.chatStream` parses and owns message state for you.
142142
| GET | `/i18n/translations/:locale` | Get translation bundle |
143143
| GET | `/i18n/labels/:object/:locale` | Get field labels |
144144

145-
### GraphQL (`/graphql`) — Plugin Required
146-
147-
| Method | Endpoint | Description |
148-
|:-------|:---------|:------------|
149-
| POST | `/graphql` | Execute GraphQL query/mutation |
150-
151145
### File Storage (`/storage`) — Plugin Required
152146

153147
Provided by `@objectstack/service-storage`, which registers these routes on the

content/docs/protocol/diagram.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ObjectStack is composed of seven protocol layers that work together to form a co
2222
| **System (Kernel)** | `src/kernel/` | Manifest, Datasources, Plugins, Kernel |
2323
| **Automation** | `src/automation/` | Flows, Workflows, Triggers, Approvals |
2424
| **AI** | `src/ai/` | Agents, RAG Pipelines, Model Registry |
25-
| **API** | `src/api/` | REST, GraphQL, WebSocket, Realtime |
25+
| **API** | `src/api/` | REST, WebSocket, Realtime |
2626
| **Security** | `src/security/` | Permissions, Roles, Sharing, RLS |
2727

2828
---
@@ -39,7 +39,6 @@ graph TB
3939
4040
subgraph "API Layer"
4141
REST[REST Endpoints]
42-
GQL[GraphQL]
4342
WS[WebSocket / Realtime]
4443
end
4544
@@ -92,12 +91,10 @@ graph TB
9291
9392
%% Client to API
9493
CLIENT --> REST
95-
CLIENT --> GQL
9694
CLIENT --> WS
9795
9896
%% API references Data
9997
REST --> KERNEL
100-
GQL --> KERNEL
10198
WS --> KERNEL
10299
103100
%% Security enforced at Kernel
@@ -160,7 +157,7 @@ sequenceDiagram
160157
participant D as Driver
161158
participant DB as Database
162159
163-
C->>API: HTTP Request (REST / GraphQL)
160+
C->>API: HTTP Request (REST)
164161
API->>K: Parsed Operation
165162
166163
K->>SEC: Check Permissions

content/docs/protocol/kernel/error-handling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { AlertCircle, Bug, Shield, Info, AlertTriangle, XCircle, Radio, Zap } fr
77

88
# Error Handling
99

10-
The **Error Handling Protocol** defines standardized error codes, response formats, and debugging strategies across all ObjectStack APIs (HTTP, WebSocket, GraphQL).
10+
The **Error Handling Protocol** defines standardized error codes, response formats, and debugging strategies across all ObjectStack APIs (HTTP, WebSocket).
1111

1212
## Why Standardized Errors Matter
1313

content/docs/protocol/kernel/lifecycle.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The ObjectStack boot process follows a **strict order** to ensure dependencies a
6767
│ └─ Start event bus │
6868
│ └─ Start job scheduler │
6969
│ └─ Start audit logger │
70-
│ └─ Start HTTP/GraphQL servers
70+
│ └─ Start HTTP server
7171
└─────────────────────────────────────────────────────────────────┘
7272
7373
┌─────────────────────────────────────────────────────────────────┐

0 commit comments

Comments
 (0)