zabbix-graphql-api/docs/howtos
Andreas Hilbig 5da4a17e36 feat: implement weather sensor extension and enhance device interfaces
This change introduces the Weather Sensor device type which retrieves data from public APIs, and enhances the core Host/Device interfaces to provide consistent access to inventory and items across all specialized device types. It also improves search logic and fixes several bugs identified during implementation.

- Weather Sensor Extension: Added schema and recipe for a device retrieving weather data via Zabbix HTTP agent items.

- Interface Enhancements: Added inventory and items fields to Host and Device interfaces to ensure all device specialized types have consistent access to monitoring and inventory data.

- Search Logic Improvements: Enhanced ParsedArgs to support searchByAny and technical name (host) searches when a name pattern is provided.

- Bug Fixes:

  - Fixed getLocations argument order in the Zabbix API datasource.

  - Implemented deduplication for groupids and templateids in HostImporter to prevent Zabbix duplicate value errors.

  - Added missing url field to CreateTemplateItem for HTTP Agent item support.

- Testing:

  - Extended the regression test suite with 4 new automated checks covering the fixed bugs.

  - Updated Jest tests to accommodate the improved search parameters.

- Documentation: Updated cookbook and test specifications to reflect new features and regression testing obligations.
2026-02-01 06:56:23 +01:00
..
cookbook.md feat: implement weather sensor extension and enhance device interfaces 2026-02-01 06:56:23 +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
maintenance.md feat: implement comprehensive testing framework and regression suite 2026-02-01 05:05:55 +01:00
mcp.md feat: implement comprehensive testing framework and regression suite 2026-02-01 05:05:55 +01:00
permissions.md docs: refactor documentation and upgrade to Node.js 24 2026-01-30 14:35:31 +01:00
README.md feat: implement comprehensive testing framework and regression suite 2026-02-01 05:05:55 +01:00
schema.md docs: complete documentation refactoring and structure optimization 2026-01-30 15:08:19 +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.

📊 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.

🧪 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.