Skip to main content

Module spec_version

Module spec_version 

Source
Expand description

Specification versions implemented by this crate.

Each constant identifies the OpenAPI / AsyncAPI document version that the corresponding module implements. All four EDI-Energy API-Webdienste are currently at version 1.0.0.

Use these constants in server implementations to populate ApiRecord::major_version when self-registering at the Verzeichnisdienst (the directory expects an i32 majorVersion field whose value is 1 for all current specs).

use energy_api::spec_version;

assert_eq!(spec_version::DIRECTORY_SERVICE, "1.0.0");
assert_eq!(spec_version::DIRECTORY_WEBSOCKET, "1.0.0");
assert_eq!(spec_version::CONTROL_MEASURES, "1.0.0");
assert_eq!(spec_version::MALO_IDENT, "1.0.0");

Constants§

CONTROL_MEASURES
controlMeasuresV1.yaml — EDI-Energy Control Measures API.
DIRECTORY_SERVICE
directoryServiceV1.yaml — EDI-Energy Verzeichnisdienst REST API.
DIRECTORY_WEBSOCKET
webSocketV1.yaml — EDI-Energy Verzeichnisdienst WebSocket subscription API.
MAJOR
The majorVersion field value for all current specs as expected by the Verzeichnisdienst (ApiRecord::major_version: i32).
MALO_IDENT
maloIdentV1.yaml — EDI-Energy MaLo Identification API.