Skip to content

docs: retire the /graphql endpoint contract and its protocol-page residue#10845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 2 commits into from
Aug 21, 2026
Merged

docs: retire the /graphql endpoint contract and its protocol-page residue #10845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f37353e
docs: retire the /graphql endpoint contract and protocol residue (#10…
claude Aug 21, 2026
451fe92
docs(api): reflow the plugin-endpoints callout after the /graphql rem…
claude Aug 21, 2026
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
6 changes: 3 additions & 3 deletions content/docs/api/declarative-endpoints.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,9 +12,9 @@ publish gates serves real traffic as soon as the package is published.

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

## Which channel: `actions` or `apis`?
Expand Down
8 changes: 1 addition & 7 deletions content/docs/api/plugin-endpoints.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
---
title: Plugin Endpoints
description: REST endpoints that become available when the corresponding plugin is installed — auth, workflow, automation, views, realtime, notifications, AI, i18n, GraphQL, and file storage.
description: REST endpoints that become available when the corresponding plugin is installed — auth, workflow, automation, views, realtime, notifications, AI, i18n, and file storage.
---

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

### GraphQL (`/graphql`) — Plugin Required

| Method | Endpoint | Description |
|:-------|:---------|:------------|
| POST | `/graphql` | Execute GraphQL query/mutation |

### File Storage (`/storage`) — Plugin Required

Provided by `@objectstack/service-storage`, which registers these routes on the
Expand Down
7 changes: 2 additions & 5 deletions content/docs/protocol/diagram.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ ObjectStack is composed of seven protocol layers that work together to form a co
| **System (Kernel)** | `src/kernel/` | Manifest, Datasources, Plugins, Kernel |
| **Automation** | `src/automation/` | Flows, Workflows, Triggers, Approvals |
| **AI** | `src/ai/` | Agents, RAG Pipelines, Model Registry |
| **API** | `src/api/` | REST, GraphQL, WebSocket, Realtime |
| **API** | `src/api/` | REST, WebSocket, Realtime |
| **Security** | `src/security/` | Permissions, Roles, Sharing, RLS |

---
Expand All@@ -39,7 +39,6 @@ graph TB

subgraph "API Layer"
REST[REST Endpoints]
GQL[GraphQL]
WS[WebSocket / Realtime]
end

Expand DownExpand Up@@ -92,12 +91,10 @@ graph TB

%% Client to API
CLIENT --> REST
CLIENT --> GQL
CLIENT --> WS

%% API references Data
REST --> KERNEL
GQL --> KERNEL
WS --> KERNEL

%% Security enforced at Kernel
Expand DownExpand Up@@ -160,7 +157,7 @@ sequenceDiagram
participant D as Driver
participant DB as Database

C->>API: HTTP Request (REST / GraphQL)
C->>API: HTTP Request (REST)
API->>K: Parsed Operation

K->>SEC: Check Permissions
Expand Down
2 changes: 1 addition & 1 deletion content/docs/protocol/kernel/error-handling.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ import { AlertCircle, Bug, Shield, Info, AlertTriangle, XCircle, Radio, Zap } fr

# Error Handling

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

## Why Standardized Errors Matter

Expand Down
2 changes: 1 addition & 1 deletion content/docs/protocol/kernel/lifecycle.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ The ObjectStack boot process follows a **strict order** to ensure dependencies a
│ └─ Start event bus │
│ └─ Start job scheduler │
│ └─ Start audit logger │
│ └─ Start HTTP/GraphQL servers │
│ └─ Start HTTP server │
└─────────────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────────────┐
Expand Down
Loading