chore: update base host group name from "Baustellen-Devices" to "Roadwork" in code, tests, and documentation

This commit is contained in:
Andreas Hilbig 2026-01-27 15:55:09 +01:00
parent 19cddd1ffb
commit 6312c3a2f7
8 changed files with 66 additions and 49 deletions

99
.idea/workspace.xml generated
View file

@ -4,10 +4,8 @@
<option name="autoReloadType" value="SELECTIVE" /> <option name="autoReloadType" value="SELECTIVE" />
</component> </component>
<component name="ChangeListManager"> <component name="ChangeListManager">
<list default="true" id="d7a71994-2699-4ae4-9fd2-ee13b7f33d35" name="Changes" comment="docs: enhance GraphQL schema documentation&#10;&#10;- Added comprehensive descriptions to all types, interfaces, and fields in 'schema/api_commons.graphql'.&#10;&#10;- Improved documentation for mutations and input/response types in 'schema/mutations.graphql'.&#10;&#10;- Added detailed descriptions for all queries and their arguments in 'schema/queries.graphql'.&#10;&#10;- Enhanced documentation for core Zabbix types and enums in 'schema/zabbix.graphql'.&#10;&#10;- Updated extension schemas under 'schema/extensions/' with proper GraphQL descriptions.&#10;&#10;- Verified schema validity via 'graphql-codegen' and ran all tests to ensure consistency."> <list default="true" id="d7a71994-2699-4ae4-9fd2-ee13b7f33d35" name="Changes" comment="docs: add Virtual Control Room (VCR) sample application info to README.md&#10;&#10;- Added a new section describing the Virtual Control Room (VCR) as a sample application.&#10;&#10;- Explained how VCR utilizes key API features like hierarchical mapping, dynamic authorization, mass provisioning, and data visualization.&#10;&#10;- Included a link to the technical product information PDF in the docs folder.&#10;&#10;- Added VCR to the Key Features list.">
<change beforePath="$PROJECT_DIR$/.forgejo/workflows/deploy-docker.yaml" beforeDir="false" afterPath="$PROJECT_DIR$/.forgejo/workflows/deploy-docker.yaml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" /> <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
</list> </list>
<option name="SHOW_DIALOG" value="false" /> <option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" /> <option name="HIGHLIGHT_CONFLICTS" value="true" />
@ -56,43 +54,43 @@
<option name="openDirectoriesWithSingleClick" value="true" /> <option name="openDirectoriesWithSingleClick" value="true" />
<option name="showLibraryContents" value="true" /> <option name="showLibraryContents" value="true" />
</component> </component>
<component name="PropertiesComponent">{ <component name="PropertiesComponent"><![CDATA[{
&quot;keyToString&quot;: { "keyToString": {
&quot;NIXITCH_NIXPKGS_CONFIG&quot;: &quot;&quot;, "NIXITCH_NIXPKGS_CONFIG": "",
&quot;NIXITCH_NIX_CONF_DIR&quot;: &quot;&quot;, "NIXITCH_NIX_CONF_DIR": "",
&quot;NIXITCH_NIX_OTHER_STORES&quot;: &quot;&quot;, "NIXITCH_NIX_OTHER_STORES": "",
&quot;NIXITCH_NIX_PATH&quot;: &quot;&quot;, "NIXITCH_NIX_PATH": "",
&quot;NIXITCH_NIX_PROFILES&quot;: &quot;&quot;, "NIXITCH_NIX_PROFILES": "",
&quot;NIXITCH_NIX_REMOTE&quot;: &quot;&quot;, "NIXITCH_NIX_REMOTE": "",
&quot;NIXITCH_NIX_USER_PROFILE_DIR&quot;: &quot;&quot;, "NIXITCH_NIX_USER_PROFILE_DIR": "",
&quot;Node.js.index.ts.executor&quot;: &quot;Run&quot;, "Node.js.index.ts.executor": "Run",
&quot;RunOnceActivity.MCP Project settings loaded&quot;: &quot;true&quot;, "RunOnceActivity.MCP Project settings loaded": "true",
&quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;, "RunOnceActivity.ShowReadmeOnStart": "true",
&quot;RunOnceActivity.TerminalTabsStorage.copyFrom.TerminalArrangementManager.252&quot;: &quot;true&quot;, "RunOnceActivity.TerminalTabsStorage.copyFrom.TerminalArrangementManager.252": "true",
&quot;RunOnceActivity.git.unshallow&quot;: &quot;true&quot;, "RunOnceActivity.git.unshallow": "true",
&quot;RunOnceActivity.typescript.service.memoryLimit.init&quot;: &quot;true&quot;, "RunOnceActivity.typescript.service.memoryLimit.init": "true",
&quot;com.intellij.ml.llm.matterhorn.ej.ui.settings.DefaultModelSelectionForGA.v1&quot;: &quot;true&quot;, "com.intellij.ml.llm.matterhorn.ej.ui.settings.DefaultModelSelectionForGA.v1": "true",
&quot;git-widget-placeholder&quot;: &quot;main&quot;, "git-widget-placeholder": "main",
&quot;go.import.settings.migrated&quot;: &quot;true&quot;, "go.import.settings.migrated": "true",
&quot;javascript.preferred.runtime.type.id&quot;: &quot;node&quot;, "javascript.preferred.runtime.type.id": "node",
&quot;junie.onboarding.icon.badge.shown&quot;: &quot;true&quot;, "junie.onboarding.icon.badge.shown": "true",
&quot;last_opened_file_path&quot;: &quot;//wsl.localhost/Ubuntu/home/ahilbig/git/vcr/zabbix-graphql-api/src/testdata/templates&quot;, "last_opened_file_path": "//wsl.localhost/Ubuntu/home/ahilbig/git/vcr/zabbix-graphql-api/docs",
&quot;node.js.detected.package.eslint&quot;: &quot;true&quot;, "node.js.detected.package.eslint": "true",
&quot;node.js.detected.package.tslint&quot;: &quot;true&quot;, "node.js.detected.package.tslint": "true",
&quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;, "node.js.selected.package.eslint": "(autodetect)",
&quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;, "node.js.selected.package.tslint": "(autodetect)",
&quot;nodejs_interpreter_path&quot;: &quot;wsl://Ubuntu@/home/ahilbig/.nvm/versions/node/v24.12.0/bin/node&quot;, "nodejs_interpreter_path": "wsl://Ubuntu@/home/ahilbig/.nvm/versions/node/v24.12.0/bin/node",
&quot;nodejs_package_manager_path&quot;: &quot;npm&quot;, "nodejs_package_manager_path": "npm",
&quot;npm.codegen.executor&quot;: &quot;Run&quot;, "npm.codegen.executor": "Run",
&quot;npm.compile.executor&quot;: &quot;Run&quot;, "npm.compile.executor": "Run",
&quot;npm.copy-schema.executor&quot;: &quot;Run&quot;, "npm.copy-schema.executor": "Run",
&quot;npm.prod.executor&quot;: &quot;Run&quot;, "npm.prod.executor": "Run",
&quot;settings.editor.selected.configurable&quot;: &quot;settings.javascript.runtime&quot;, "settings.editor.selected.configurable": "settings.javascript.runtime",
&quot;to.speed.mode.migration.done&quot;: &quot;true&quot;, "to.speed.mode.migration.done": "true",
&quot;ts.external.directory.path&quot;: &quot;\\\\wsl.localhost\\Ubuntu\\home\\ahilbig\\git\\vcr\\zabbix-graphql-api\\node_modules\\typescript\\lib&quot;, "ts.external.directory.path": "\\\\wsl.localhost\\Ubuntu\\home\\ahilbig\\git\\vcr\\zabbix-graphql-api\\node_modules\\typescript\\lib",
&quot;vue.rearranger.settings.migration&quot;: &quot;true&quot; "vue.rearranger.settings.migration": "true"
} }
}</component> }]]></component>
<component name="RecapSpentCounter"> <component name="RecapSpentCounter">
<option name="endsOfQuotaMs" value="1768327208764" /> <option name="endsOfQuotaMs" value="1768327208764" />
<option name="spentUsd" value="0.04010335" /> <option name="spentUsd" value="0.04010335" />
@ -102,6 +100,7 @@
</component> </component>
<component name="RecentsManager"> <component name="RecentsManager">
<key name="CopyFile.RECENT_KEYS"> <key name="CopyFile.RECENT_KEYS">
<recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\docs" />
<recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\src\testdata\templates" /> <recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\src\testdata\templates" />
<recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\src\test" /> <recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\src\test" />
<recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\.forgejo\workflows" /> <recent name="\\wsl.localhost\Ubuntu\home\ahilbig\git\vcr\zabbix-graphql-api\.forgejo\workflows" />
@ -320,7 +319,23 @@
<option name="project" value="LOCAL" /> <option name="project" value="LOCAL" />
<updated>1769451540092</updated> <updated>1769451540092</updated>
</task> </task>
<option name="localTasksCounter" value="17" /> <task id="LOCAL-00017" summary="chore: update Docker image path in workflows and README">
<option name="closed" value="true" />
<created>1769511960691</created>
<option name="number" value="00017" />
<option name="presentableId" value="LOCAL-00017" />
<option name="project" value="LOCAL" />
<updated>1769511960691</updated>
</task>
<task id="LOCAL-00018" summary="docs: add Virtual Control Room (VCR) sample application info to README.md&#10;&#10;- Added a new section describing the Virtual Control Room (VCR) as a sample application.&#10;&#10;- Explained how VCR utilizes key API features like hierarchical mapping, dynamic authorization, mass provisioning, and data visualization.&#10;&#10;- Included a link to the technical product information PDF in the docs folder.&#10;&#10;- Added VCR to the Key Features list.">
<option name="closed" value="true" />
<created>1769514926656</created>
<option name="number" value="00018" />
<option name="presentableId" value="LOCAL-00018" />
<option name="project" value="LOCAL" />
<updated>1769514926656</updated>
</task>
<option name="localTasksCounter" value="19" />
<servers /> <servers />
</component> </component>
<component name="TypeScriptGeneratedFilesManager"> <component name="TypeScriptGeneratedFilesManager">
@ -357,7 +372,9 @@
<MESSAGE value="docs: add README.md and LICENSE file&#10;&#10;- Created README.md with project purpose, features, installation guide, and usage samples.&#10;&#10;- Added LICENSE file with GNU Affero General Public License v3.0 to match Zabbix license.&#10;&#10;- Added license field to package.json." /> <MESSAGE value="docs: add README.md and LICENSE file&#10;&#10;- Created README.md with project purpose, features, installation guide, and usage samples.&#10;&#10;- Added LICENSE file with GNU Affero General Public License v3.0 to match Zabbix license.&#10;&#10;- Added license field to package.json." />
<MESSAGE value="chore: Add `allDevices` query resolver, update Zabbix device query handling, and enhance schema with `DeviceConfig` and `WidgetPreview` types" /> <MESSAGE value="chore: Add `allDevices` query resolver, update Zabbix device query handling, and enhance schema with `DeviceConfig` and `WidgetPreview` types" />
<MESSAGE value="docs: enhance GraphQL schema documentation&#10;&#10;- Added comprehensive descriptions to all types, interfaces, and fields in 'schema/api_commons.graphql'.&#10;&#10;- Improved documentation for mutations and input/response types in 'schema/mutations.graphql'.&#10;&#10;- Added detailed descriptions for all queries and their arguments in 'schema/queries.graphql'.&#10;&#10;- Enhanced documentation for core Zabbix types and enums in 'schema/zabbix.graphql'.&#10;&#10;- Updated extension schemas under 'schema/extensions/' with proper GraphQL descriptions.&#10;&#10;- Verified schema validity via 'graphql-codegen' and ran all tests to ensure consistency." /> <MESSAGE value="docs: enhance GraphQL schema documentation&#10;&#10;- Added comprehensive descriptions to all types, interfaces, and fields in 'schema/api_commons.graphql'.&#10;&#10;- Improved documentation for mutations and input/response types in 'schema/mutations.graphql'.&#10;&#10;- Added detailed descriptions for all queries and their arguments in 'schema/queries.graphql'.&#10;&#10;- Enhanced documentation for core Zabbix types and enums in 'schema/zabbix.graphql'.&#10;&#10;- Updated extension schemas under 'schema/extensions/' with proper GraphQL descriptions.&#10;&#10;- Verified schema validity via 'graphql-codegen' and ran all tests to ensure consistency." />
<option name="LAST_COMMIT_MESSAGE" value="docs: enhance GraphQL schema documentation&#10;&#10;- Added comprehensive descriptions to all types, interfaces, and fields in 'schema/api_commons.graphql'.&#10;&#10;- Improved documentation for mutations and input/response types in 'schema/mutations.graphql'.&#10;&#10;- Added detailed descriptions for all queries and their arguments in 'schema/queries.graphql'.&#10;&#10;- Enhanced documentation for core Zabbix types and enums in 'schema/zabbix.graphql'.&#10;&#10;- Updated extension schemas under 'schema/extensions/' with proper GraphQL descriptions.&#10;&#10;- Verified schema validity via 'graphql-codegen' and ran all tests to ensure consistency." /> <MESSAGE value="chore: update Docker image path in workflows and README" />
<MESSAGE value="docs: add Virtual Control Room (VCR) sample application info to README.md&#10;&#10;- Added a new section describing the Virtual Control Room (VCR) as a sample application.&#10;&#10;- Explained how VCR utilizes key API features like hierarchical mapping, dynamic authorization, mass provisioning, and data visualization.&#10;&#10;- Included a link to the technical product information PDF in the docs folder.&#10;&#10;- Added VCR to the Key Features list." />
<option name="LAST_COMMIT_MESSAGE" value="docs: add Virtual Control Room (VCR) sample application info to README.md&#10;&#10;- Added a new section describing the Virtual Control Room (VCR) as a sample application.&#10;&#10;- Explained how VCR utilizes key API features like hierarchical mapping, dynamic authorization, mass provisioning, and data visualization.&#10;&#10;- Included a link to the technical product information PDF in the docs folder.&#10;&#10;- Added VCR to the Key Features list." />
</component> </component>
<component name="XDebuggerManager"> <component name="XDebuggerManager">
<breakpoint-manager> <breakpoint-manager>

View file

@ -55,7 +55,7 @@ The API is configured via environment variables. Create a `.env` file or set the
| :--- | :--- | :--- | | :--- | :--- | :--- |
| `ZABBIX_BASE_URL` | URL to your Zabbix API (e.g., `http://zabbix.example.com/zabbix`) | | | `ZABBIX_BASE_URL` | URL to your Zabbix API (e.g., `http://zabbix.example.com/zabbix`) | |
| `ZABBIX_AUTH_TOKEN` | Zabbix Super Admin API token for administrative tasks | | | `ZABBIX_AUTH_TOKEN` | Zabbix Super Admin API token for administrative tasks | |
| `ZABBIX_EDGE_DEVICE_BASE_GROUP` | Base host group for devices | `Baustellen-Devices` | | `ZABBIX_EDGE_DEVICE_BASE_GROUP` | Base host group for devices | `Roadwork` |
| `ZABBIX_PERMISSION_TEMPLATE_GROUP_NAME_PREFIX` | Prefix for template groups used as permissions | `Permissions` | | `ZABBIX_PERMISSION_TEMPLATE_GROUP_NAME_PREFIX` | Prefix for template groups used as permissions | `Permissions` |
| `SCHEMA_PATH` | Path to the directory containing `.graphql` schema files | `./schema/` | | `SCHEMA_PATH` | Path to the directory containing `.graphql` schema files | `./schema/` |
@ -211,7 +211,7 @@ ZABBIX_BASE_URL=http://your-zabbix-instance/zabbix
ZABBIX_AUTH_TOKEN=your-super-admin-token-here ZABBIX_AUTH_TOKEN=your-super-admin-token-here
# General Configuration # General Configuration
ZABBIX_EDGE_DEVICE_BASE_GROUP=Baustellen-Devices ZABBIX_EDGE_DEVICE_BASE_GROUP=Roadwork
API_VERSION=1.0.0 API_VERSION=1.0.0
SCHEMA_PATH=./schema/ SCHEMA_PATH=./schema/

View file

@ -13,6 +13,6 @@ query AllHostGroups($search_name: String) {
### Variables ### Variables
```json ```json
{ {
"search_name": "Baustellen-Devices/*" "search_name": "Roadwork/*"
} }
``` ```

View file

@ -10,7 +10,7 @@ import {ParsedArgs, ZabbixErrorResult, ZabbixRequest, ZabbixResult} from "./zabb
export const zabbixRequestAuthToken = process.env.ZABBIX_AUTH_TOKEN_FOR_REQUESTS export const zabbixRequestAuthToken = process.env.ZABBIX_AUTH_TOKEN_FOR_REQUESTS
export const zabbixSuperAuthToken = process.env.ZABBIX_AUTH_TOKEN export const zabbixSuperAuthToken = process.env.ZABBIX_AUTH_TOKEN
export const ZABBIX_EDGE_DEVICE_BASE_GROUP = process.env.ZABBIX_EDGE_DEVICE_BASE_GROUP || process.env.ZABBIX_ROADWORK_BASE_GROUP || "Baustellen-Devices" export const ZABBIX_EDGE_DEVICE_BASE_GROUP = process.env.ZABBIX_EDGE_DEVICE_BASE_GROUP || process.env.ZABBIX_ROADWORK_BASE_GROUP || "Roadwork"
export const FIND_ZABBIX_EDGE_DEVICE_BASE_GROUP_PREFIX = new RegExp(`^(${ZABBIX_EDGE_DEVICE_BASE_GROUP})\/`) export const FIND_ZABBIX_EDGE_DEVICE_BASE_GROUP_PREFIX = new RegExp(`^(${ZABBIX_EDGE_DEVICE_BASE_GROUP})\/`)
export class ZabbixAPI export class ZabbixAPI

View file

@ -10,7 +10,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
post: jest.fn(), post: jest.fn(),
requestByPath: jest.fn() requestByPath: jest.fn()
}, },
ZABBIX_EDGE_DEVICE_BASE_GROUP: "Baustellen-Devices" ZABBIX_EDGE_DEVICE_BASE_GROUP: "Roadwork"
})); }));
// Mock ZabbixRequestWithPermissions to skip permission checks // Mock ZabbixRequestWithPermissions to skip permission checks

View file

@ -13,7 +13,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
getLocations: jest.fn(), getLocations: jest.fn(),
requestByPath: jest.fn() requestByPath: jest.fn()
}, },
ZABBIX_EDGE_DEVICE_BASE_GROUP: "Baustellen-Devices" ZABBIX_EDGE_DEVICE_BASE_GROUP: "Roadwork"
})); }));
describe("Host Integration Tests", () => { describe("Host Integration Tests", () => {

View file

@ -11,7 +11,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
baseURL: "http://mock-zabbix", baseURL: "http://mock-zabbix",
getLocations: jest.fn() getLocations: jest.fn()
}, },
ZABBIX_EDGE_DEVICE_BASE_GROUP: "Baustellen-Devices" ZABBIX_EDGE_DEVICE_BASE_GROUP: "Roadwork"
})); }));
describe("Host and HostGroup Resolvers", () => { describe("Host and HostGroup Resolvers", () => {

View file

@ -10,7 +10,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
post: jest.fn(), post: jest.fn(),
baseURL: "http://mock-zabbix" baseURL: "http://mock-zabbix"
}, },
ZABBIX_EDGE_DEVICE_BASE_GROUP: "Baustellen-Devices" ZABBIX_EDGE_DEVICE_BASE_GROUP: "Roadwork"
})); }));
describe("Template Resolver", () => { describe("Template Resolver", () => {