cot-lib - npm Package Compare versions

Comparing version 5.0.8 to 5.0.9

package.json

 {
   "name": "cot-lib",
-  "version": "5.0.8",
+  "version": "5.0.9",
   "description": "Easily consume the City of Things platform data",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -103,3 +103,3 @@ # City of Things Client Library
 ### Source
-A Source represents a sensor, actuator or data producer of some sort. It has an *id* to uniquely identify it. It has a *name* which is a human readable label for this Source. At last it has a *typeRefs* field which contains a set of typeId strings that define the Types this Source belongs to OR it has a *metrics* field immediatly referring to the metrics available for this source.
+A Source represents a sensor, actuator or data producer of some sort. It has an *id* to uniquely identify it. It has an optional *name* which is a human readable label for this Source. At last it can have a *typeRefs* field which contains a set of typeId strings that define the Types this Source belongs to OR/AND (more commonly) it has a *metrics* field immediatly referring to the metrics available for this source. _(A Type simply bundles some metrics together, but is more of a 'managing feauture', since there are no API entrypoints for typeIds)_
 
@@ -114,3 +114,3 @@ ```json
     "metrics": [
-        "dyamand.state.temperature"
+        "airquality.pm10"
     ]
@@ -121,3 +121,3 @@ }
 ### Metric
-A Metric represents a metric measurement type. For example **dyamand.state.temperature**. It is a simple string to identify a single type of measurement. It also has a *granularity* field that determines the default size of returned TemperalPage brackets for data of this Metric. There is also a *description* field that explains the measurement. Finally there is a *type* field that refers contains the runtime type of the value (eg. FloatNumber, IntNumber).
+A Metric represents a metric measurement type. For example **airquality.pm10**. It is a simple string to identify a single type of measurement. It also has a *granularity* field that determines the default size of returned TemperalPage brackets for data of this Metric. There is also an optional *description* field that explains the measurement. Finally there is an optional *type* field that contains the runtime type of the value (eg. FloatNumber, IntNumber).
 
@@ -124,0 +124,0 @@ ```json

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

494155

increased by0.03%

No dependency changes