Skip to content

Commit

Permalink
Renaming taxonomy node type to direct.
Browse files Browse the repository at this point in the history
Signed-off-by: Ulf Bjorkengren <[email protected]>
  • Loading branch information
UlfBj committed Mar 8, 2024
1 parent a9b6d37 commit c697ff2
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 23 deletions.
Empty file removed docs-gen/.hugo_build.lock
Empty file.
16 changes: 8 additions & 8 deletions docs-gen/content/configuration_rule_set/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -53,34 +53,34 @@ HIM:


VehicleData:
type: taxonomy
type: direct
domain: Vehicle.Car.ResourceData
version: X.Y.Z
local: file://<full-path-name>
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://<full-path-name>
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://<full-path-name>
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: ….


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: ….
```
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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://<full-path-name>
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: ….
```
4 changes: 2 additions & 2 deletions docs-gen/content/configuration_rule_set/node_types/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: ….
```
14 changes: 7 additions & 7 deletions examples/HIM_config_example.v1.0.0.him
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,35 @@ HIM:


VehicleData:
type: taxonomy
type: direct
domain: Vehicle.Car.ResourceData
version: X.Y.Z
local: file://<full-path-name>
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://<full-path-name>
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://<full-path-name>
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: ….


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:
Expand Down

0 comments on commit c697ff2

Please sign in to comment.