Andreas Hilbig
e61b5f4f11
- Added comprehensive descriptions to all types, interfaces, and fields in 'schema/api_commons.graphql'. - Improved documentation for mutations and input/response types in 'schema/mutations.graphql'. - Added detailed descriptions for all queries and their arguments in 'schema/queries.graphql'. - Enhanced documentation for core Zabbix types and enums in 'schema/zabbix.graphql'. - Updated extension schemas under 'schema/extensions/' with proper GraphQL descriptions. - Verified schema validity via 'graphql-codegen' and ran all tests to ensure consistency.
74 lines
1.8 KiB
GraphQL
74 lines
1.8 KiB
GraphQL
|
|
|
|
"""
|
|
Represents the payload for a sensor distance measurement.
|
|
"""
|
|
type SensorDistanceValue implements DeviceValue {
|
|
"""
|
|
Represents the name of the device that reports or provides distance sensor data.
|
|
Uniquely identifies the device within the context of the SensorDistanceValue.
|
|
"""
|
|
deviceName: String
|
|
|
|
"""
|
|
Represents the MAC address of the device. Typically formatted as a 12-character
|
|
hexadecimal string (e.g., "00:1A:2B:3C:4D:5E").
|
|
"""
|
|
mac: String
|
|
|
|
"""
|
|
Represents the measured or calculated distance value, typically in meters.
|
|
Should be non-negative.
|
|
"""
|
|
distance: Float
|
|
|
|
"""
|
|
Represents the time at which the sensor measurement was recorded.
|
|
"""
|
|
time: String
|
|
|
|
"""
|
|
Dummy field to allow for empty interfaces.
|
|
"""
|
|
_empty: String
|
|
}
|
|
|
|
"""
|
|
Represents a coordinate in 3D space with x, y, and z components.
|
|
"""
|
|
type Position {
|
|
"""X coordinate."""
|
|
x: Float
|
|
"""Y coordinate."""
|
|
y: Float
|
|
"""Z coordinate."""
|
|
z: Float
|
|
}
|
|
|
|
"""
|
|
Represents the result of a position calculation, including the calculated position and accuracy.
|
|
"""
|
|
type PositionCalculatorResult {
|
|
"""The calculated 3D position."""
|
|
position: Position
|
|
"""The estimated accuracy of the calculation."""
|
|
accuracy: Float
|
|
}
|
|
|
|
"""
|
|
Concrete implementation of a DeviceValueMessage for sensor distance data.
|
|
"""
|
|
type SensorDistanceMessage implements DeviceValueMessage {
|
|
"""The unique identifier of the device."""
|
|
deviceKey: String
|
|
"""Timestamp of the message."""
|
|
timestamp: String
|
|
"""Name of the attribute."""
|
|
attributeName: String
|
|
"""Name of the topic."""
|
|
topicName: String
|
|
"""Type of the device."""
|
|
deviceType: String
|
|
"""The sensor distance value payload."""
|
|
value: SensorDistanceValue
|
|
}
|