Andreas Hilbig
a9940063e9
This commit refines the project documentation by adding result verification steps to all recipes in the cookbook and formalizing documentation standards in the project guidelines.
Changes:
- docs/howtos/cookbook.md:
- Added 'Verify' steps to all recipes using GraphQL queries or agent checks.
- Enhanced 'Extending Schema with a New Device Type' recipe:
- Updated Step 1 with a realistic schema using 'DistanceTrackerDevice' implementing 'Host' and 'Device' interfaces.
- Added mandatory advice for new device types to implement 'Host' and 'Device'.
- Referenced the existing 'location_tracker_devices.graphql' as a prepared real-world sample.
- Split Step 3 into Method A (Manual Creation) and Method B (Automated Import).
- Expanded Step 4 with a host creation step (using importHosts) and a filtered allDevices query using tag_deviceType.
- Standardized icons for preparation (🛠️), configuration (⚙️), execution (🚀), and verification (✅).
- .junie/guidelines.md:
- Added 'Documentation Templates' section defining a formal Recipe Template.
- Standardized icons and step naming to maintain visual consistency across all guides.
- Added 'Review & Approval' rule to prevent automatic commits without user review.
- readme.improvement.plan.md:
- Added and completed 'Priority 7: Standardization & Verification' tasks.
- Updated implementation order to reflect the new standardization phase.
|
||
|---|---|---|
| .. | ||
| cookbook.md | ||
| hierarchical_data_mapping.md | ||
| maintenance.md | ||
| mcp.md | ||
| permissions.md | ||
| README.md | ||
| schema.md | ||
| tags.md | ||
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.
📊 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.
🤖 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.