zabbix/zabbix-graphql-api
1
0
Fork 0
Code Pull requests Activity

fix: subscriptions clarification

Browse source
This commit is contained in:
Vladimir Svacko 2026-01-28 15:54:45 +01:00
parent e864d43981
commit fa1844ca54
2 changed files with 1 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -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 - **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` - *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) - *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 - **Type Safety**: Full TypeScript support with generated types

7
readme.improvement.plan.md
View file

@ -2,16 +2,9 @@
## Priority 1: Critical Missing Information ## 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 ## 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 ### 2.2 Configuration Section
- Add a complete table of all environment variables with descriptions - Add a complete table of all environment variables with descriptions