From c697ff218e00db7fdb15496efb16b70ba658c1cd Mon Sep 17 00:00:00 2001 From: Ulf Bjorkengren Date: Fri, 8 Mar 2024 11:54:12 +0100 Subject: [PATCH] Renaming taxonomy node type to direct. Signed-off-by: Ulf Bjorkengren --- docs-gen/.hugo_build.lock | 0 .../content/configuration_rule_set/basics.md | 16 ++++++++-------- .../node_types/{taxonomy.md => direct.md} | 12 ++++++------ .../configuration_rule_set/node_types/proxy.md | 4 ++-- examples/HIM_config_example.v1.0.0.him | 14 +++++++------- 5 files changed, 23 insertions(+), 23 deletions(-) delete mode 100644 docs-gen/.hugo_build.lock rename docs-gen/content/configuration_rule_set/node_types/{taxonomy.md => direct.md} (87%) diff --git a/docs-gen/.hugo_build.lock b/docs-gen/.hugo_build.lock deleted file mode 100644 index e69de29..0000000 diff --git a/docs-gen/content/configuration_rule_set/basics.md b/docs-gen/content/configuration_rule_set/basics.md index f1cd20b..00fcce0 100644 --- a/docs-gen/content/configuration_rule_set/basics.md +++ b/docs-gen/content/configuration_rule_set/basics.md @@ -35,7 +35,7 @@ The creation of a HIM configuration file is the responsibility of the HIM server The following node types can be used in a configuration tree: 1. [Branch](/hierarchical_information_model/common_rule_set/node_types/branch/) -2. [Taxonomy](/hierarchical_information_model/configuration_rule_set/node_types/taxonomy/) +2. [Direct](/hierarchical_information_model/configuration_rule_set/node_types/diect/) 3. [Proxy](/hierarchical_information_model/configuration_rule_set/node_types/proxy/) ## Configuration Tree Example @@ -53,27 +53,27 @@ HIM: VehicleData: - type: taxonomy + type: direct domain: Vehicle.Car.ResourceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ResourceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ResourceData.X.Y.Z description: …. VehicleServices: - type: taxonomy + type: direct domain: Vehicle.Car.ServiceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ServiceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ServiceData.X.Y.Z description: …. Types: - type: taxonomy + type: direct domain: Vehicle.Car.TypeDefinition version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.DataType.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.DataType.X.Y.Z description: …. @@ -81,6 +81,6 @@ ChargingStationData: type: proxy domain:ChargingStation.Vehicle.ResourceData version: X.Y.Z - public: https://himrepo.energyco.com?taxonomy=ChargingStation.Vehicle.ResourceData.X.Y.Z + public: https://himrepo.energyco.com?instance=ChargingStation.Vehicle.ResourceData.X.Y.Z description: …. ``` diff --git a/docs-gen/content/configuration_rule_set/node_types/taxonomy.md b/docs-gen/content/configuration_rule_set/node_types/direct.md similarity index 87% rename from docs-gen/content/configuration_rule_set/node_types/taxonomy.md rename to docs-gen/content/configuration_rule_set/node_types/direct.md index 6166efe..792175e 100644 --- a/docs-gen/content/configuration_rule_set/node_types/taxonomy.md +++ b/docs-gen/content/configuration_rule_set/node_types/direct.md @@ -1,12 +1,12 @@ --- -title: "Taxonomy node" +title: "Direct node" weight: 30 --- -A `taxonomy` node in a HIM configuration file defines a tree that the server managing this forest have a local and complete copy of. +A `direct` node in a HIM configuration file defines a tree that the server managing this forest have a local and complete copy of. This means that the server can efficiently parse the tree to e. g. verify that a client request for information points to an existing node in the tree. -Nodes of the type `taxonomy` must have the following mandatory metadata: +Nodes of the type `direct` must have the following mandatory metadata: - Name - Type - Domain @@ -61,14 +61,14 @@ The public metadata shall, if available, be a URL to a public copy of the tree. It may be used to provision a server with a copy of the tree, but also by a client to obtin a copy instead of e. g. requesting the server to provision a copy. -An example of the specification of a `taxonomy` node is given below. +An example of the specification of a `direct` node is given below. ```YAML VehicleData: - type: taxonomy + type: direct domain: Vehicle.Car.ResourceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ResourceData.X.Y.Z + public: https://himrepo.oem.com?intance=Vehicle.Car.ResourceData.X.Y.Z description: …. ``` diff --git a/docs-gen/content/configuration_rule_set/node_types/proxy.md b/docs-gen/content/configuration_rule_set/node_types/proxy.md index d659bbb..4962781 100644 --- a/docs-gen/content/configuration_rule_set/node_types/proxy.md +++ b/docs-gen/content/configuration_rule_set/node_types/proxy.md @@ -58,13 +58,13 @@ The public metadata shall, if available, be a URL to a public copy of the tree. It may be used to provision a server with a copy of the tree, but also by a client to obtain a copy instead of e. g. requesting the proxy server to provision a copy from the server managing it. -An example of the specification of a `taxonomy` node is given below. +An example of the specification of a `proxy` node is given below. ```YAML VehicleData: type: proxy domain: HomeAutomation.Zigbee.ResourceData version: X.Y.Z - public: https://himrepo.oem.com?taxonomy=HomeAutomation.Zigbee.ResourceData.X.Y.Z + public: https://himrepo.oem.com?instance=HomeAutomation.Zigbee.ResourceData.X.Y.Z description: …. ``` diff --git a/examples/HIM_config_example.v1.0.0.him b/examples/HIM_config_example.v1.0.0.him index 64dfe2d..68dede0 100644 --- a/examples/HIM_config_example.v1.0.0.him +++ b/examples/HIM_config_example.v1.0.0.him @@ -4,27 +4,27 @@ HIM: VehicleData: - type: taxonomy + type: direct domain: Vehicle.Car.ResourceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ResourceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ResourceData.X.Y.Z description: …. VehicleServices: - type: taxonomy + type: direct domain: Vehicle.Car.ServiceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ServiceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ServiceData.X.Y.Z description: …. Types: - type: taxonomy + type: direct domain: Vehicle.Car.TypeDefinition version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.DataType.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.DataType.X.Y.Z description: …. @@ -32,7 +32,7 @@ ChargingStationData: type: proxy domain:ChargingStation.Vehicle.ResourceData version: X.Y.Z - public: https://himrepo.energyco.com?taxonomy=ChargingStation.Vehicle.ResourceData.X.Y.Z + public: https://himrepo.energyco.com?instance=ChargingStation.Vehicle.ResourceData.X.Y.Z description: …. HIM.Version: