zabbix-graphql-api/docs/howtos
Andreas Hilbig ce340ccf2e feat: implement storeGroupValue and getGroupValue with unified locator
- API Refactoring: Extracted GroupValueLocator input type to unify parameters for storeGroupValue (mutation) and getGroupValue (query).

- Data Retrieval: Implemented getGroupValue query to allow direct retrieval of JSON values stored in host groups via Zabbix Trapper items.

- Enhanced Logic: Added ZabbixGetGroupValueRequest to fetch latest history values for group-associated items.

- Improved Verification: Updated the regression suite (REG-STORE) to include a full 'Store-Update-Retrieve' verification cycle.

- Documentation:

    - Updated docs/howtos/cookbook.md recipes to use the new locator structure and getGroupValue for verification.

    - Updated sample query files (docs/queries/) with corrected variables and verification queries.

- Tests:

    - Added unit and integration tests for getGroupValue.

    - Updated existing tests to match the refactored storeGroupValue schema.

- Verification: Verified 100% pass rate for all 16 regression steps and all unit/integration tests.
2026-02-20 12:26:39 +01:00
..
cookbook.md feat: implement storeGroupValue and getGroupValue with unified locator 2026-02-20 12:26:39 +01:00
hierarchical_data_mapping.md chore: add MCP integration and refactor documentation into modular how-to guides 2026-01-30 00:47:02 +01:00
local_development.md refactor: rename postgres-server to zabbix-db in Docker Compose and documentation 2026-02-13 09:09:43 +01:00
maintenance.md feat: implement storeGroupValue and getGroupValue with unified locator 2026-02-20 12:26:39 +01:00
mcp.md chore: pin apollo-mcp-server version and improve API logging configuration 2026-02-14 13:38:24 +01:00
permissions.md docs: refactor documentation and upgrade to Node.js 24 2026-01-30 14:35:31 +01:00
query_optimization.md feat: optimize Zabbix queries and enhance specialized device support 2026-02-02 13:20:06 +01:00
README.md feat: implement storeGroupValue and getGroupValue with unified locator 2026-02-20 12:26:39 +01:00
schema.md feat: optimize Zabbix queries and enhance specialized device support 2026-02-02 13:20:06 +01:00
tags.md docs: refactor documentation and upgrade to Node.js 24 2026-01-30 14:35:31 +01:00

How-To Guides

This directory contains detailed guides on how to use and extend the Zabbix GraphQL API.

Available Guides

🍳 Cookbook

Practical, step-by-step recipes for common tasks, designed for both humans and AI-based test generation.

Query Optimization

Learn how the API optimizes Zabbix requests by reducing output fields and skipping unnecessary parameters based on the GraphQL query.

📊 Schema and Schema Extension

Learn about the GraphQL schema structure, how Zabbix entities map to GraphQL types, and how to use the dynamic schema extension system.

🗂️ Hierarchical Data Mapping

Understand how the API automatically maps flat Zabbix item keys into nested GraphQL objects using hierarchical resolvers and type hinting.

🔐 Roles and Permissions Extension

Discover how the permission system works, how to define permission levels using Zabbix template groups, and how to query user permissions.

🛠️ Technical Maintenance

Guide on code generation (GraphQL Codegen), running Jest tests, and local Docker builds.

💻 Local Development Environment

Detailed instructions for setting up a fully isolated local development environment with Zabbix using Docker Compose.

🧪 Test Specification

Detailed list of test cases, categories (Unit, Integration, E2E), and coverage checklist.

🤖 MCP & Agent Integration

Discover how to integrate with the Model Context Protocol (MCP) to enable LLMs and autonomous agents to interact with Zabbix efficiently.


🔍 Additional Resources

  • Sample Queries: Categorized list of practical GraphQL operation examples.
  • Main README: Technical reference, configuration, and environment setup.