From fa1844ca54cb0a3989a97ccf972ec36c926ff5d2 Mon Sep 17 00:00:00 2001 From: Vladimir Svacko Date: Wed, 28 Jan 2026 15:54:45 +0100 Subject: [PATCH] fix: subscriptions clarification --- README.md | 2 +- readme.improvement.plan.md | 7 ------- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/README.md b/README.md index e7c00ec..14e8a3e 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ A GraphQL wrapper for the Zabbix API that provides enhanced mass import/export o - **Permission System**: Role-based access control using Zabbix template groups - *Reference*: `schema/api_commons.graphql` (Permission enum, PermissionRequest), `src/api/resolvers.ts` (hasPermissions, userPermissions), `docs/sample_import_permissions_template_groups_mutation.graphql` -- **Real-time Subscriptions**: WebSocket support for GraphQL subscriptions (infrastructure implemented) +- **Real-time Subscriptions**: WebSocket support for GraphQL subscriptions (infrastructure implemented, but no actual subscriptions defined in schema) - *Reference*: `src/api/start.ts` (WebSocketServer integration with `graphql-ws`), `AGENTS.md` (mentions WebSocket support), `package.json` (graphql-ws, subscriptions dependencies) - **Type Safety**: Full TypeScript support with generated types diff --git a/readme.improvement.plan.md b/readme.improvement.plan.md index 0549bd3..dea7054 100644 --- a/readme.improvement.plan.md +++ b/readme.improvement.plan.md @@ -2,16 +2,9 @@ ## Priority 1: Critical Missing Information -### 1.3 Subscription Clarification -- Either implement actual subscription operations in the schema or clarify that only infrastructure is provided -- If only infrastructure is provided, update the feature description to be more accurate ## Priority 2: Enhance Existing Sections -### 2.1 Architecture Section -- Add an architecture diagram or detailed explanation based on AGENTS.md -- Include information about the data flow between components -- Explain the role of each DataSource file in the datasources directory ### 2.2 Configuration Section - Add a complete table of all environment variables with descriptions