Andreas Hilbig
b84e4c0734
- Established a centralized test specification in docs/tests.md that defines test categories, cases, and a coverage checklist to ensure consistent quality and maintainability across the project. - Implemented RegressionTestExecutor for managing automated regression tests on a live Zabbix system. - Updated GraphQL schema and resolvers with a generic runAllRegressionTests mutation. - Enhanced MCP integration with new operation files and detailed documentation for AI-driven automation. - Updated README.md and How-To guides (Cookbook, Maintenance, MCP) to reflect the new testing framework and MCP capabilities. - Verified all changes with a full Jest suite (74 tests) and live end-to-end smoketests.
32 lines
1.5 KiB
Markdown
32 lines
1.5 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.
|
|
|
|
### 📊 [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.
|
|
|
|
### 🧪 [Test Specification](../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.
|