Andreas Hilbig
ce340ccf2e
- 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.
38 lines
1.9 KiB
Markdown
38 lines
1.9 KiB
Markdown
# How-To Guides
|
|
|
|
This directory contains detailed guides on how to use and extend the Zabbix GraphQL API.
|
|
|
|
## Available Guides
|
|
|
|
### 🍳 [Cookbook](./cookbook.md)
|
|
Practical, step-by-step recipes for common tasks, designed for both humans and AI-based test generation.
|
|
|
|
### ⚡ [Query Optimization](./query_optimization.md)
|
|
Learn how the API optimizes Zabbix requests by reducing output fields and skipping unnecessary parameters based on the GraphQL query.
|
|
|
|
### 📊 [Schema and Schema Extension](./schema.md)
|
|
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](./hierarchical_data_mapping.md)
|
|
Understand how the API automatically maps flat Zabbix item keys into nested GraphQL objects using hierarchical resolvers and type hinting.
|
|
|
|
### 🔐 [Roles and Permissions Extension](./permissions.md)
|
|
Discover how the permission system works, how to define permission levels using Zabbix template groups, and how to query user permissions.
|
|
|
|
### 🛠️ [Technical Maintenance](./maintenance.md)
|
|
Guide on code generation (GraphQL Codegen), running Jest tests, and local Docker builds.
|
|
|
|
### 💻 [Local Development Environment](./local_development.md)
|
|
Detailed instructions for setting up a fully isolated local development environment with Zabbix using Docker Compose.
|
|
|
|
### 🧪 [Test Specification](../testcases/tests.md)
|
|
Detailed list of test cases, categories (Unit, Integration, E2E), and coverage checklist.
|
|
|
|
### 🤖 [MCP & Agent Integration](./mcp.md)
|
|
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](../queries/README.md)**: Categorized list of practical GraphQL operation examples.
|
|
- **[Main README](../../README.md)**: Technical reference, configuration, and environment setup.
|