ADD Service and ServicePath custom node

lets-fiware · Feb 18, 2023 · ecca543 · ecca543
1 parent 8b8e526
commit ecca543
Show file tree

Hide file tree

Showing 16 changed files with 890 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## node-red-contrib-letsfiware-NGSI v0.8.0-next
 
+-  ADD Service and ServicePath custom node (#91)
 -  Improve NGSI source custom node (#90)
 -  Fix hyper links (#89)
 -  Improve NGSI Batch update custom node (#88)

diff --git a/README.ja.md b/README.ja.md
@@ -31,6 +31,7 @@ FIWARE Open APIs の Node-RED 実装
 -   [NGSI to Dashboard](docs/ja/custom_nodes/ngsi_to_dashboard.md)
 -   [GTFS realtime to NGSI](docs/ja/custom_nodes/ngsi_gtfs_realtime.md)
 -   [FIWARE version](docs/ja/custom_nodes/fiware_version.md)
+-   [FIWARE Service and ServicePath](docs/ja/custom_nodes/service-and-servicepath.md)
 
 ## ドキュメント
 

diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ Node-RED implementation for FIWARE Open APIs
 -   [NGSI to Dashboard](docs/en/custom_nodes/ngsi_to_dashboard.md)
 -   [GTFS realtime to NGSI](docs/en/custom_nodes/ngsi_gtfs_realtime.md)
 -   [FIWARE version](docs/en/custom_nodes/fiware_version.md)
+-   [FIWARE Service and ServicePath](docs/en/custom_nodes/service-and-servicepath.md)
 
 ## Documentation
 

diff --git a/docs/en/custom_nodes/service-and-servicepath.md b/docs/en/custom_nodes/service-and-servicepath.md
@@ -0,0 +1,134 @@
+# FIWARE Service and ServicePath
+
+This custom node is a simple node that allows to manage FIWARE Service and ServicePath.
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/service-and-servicepath/service-and-servicepath-01.png)
+
+## Contents
+
+<details>
+<summary><strong>Details</strong></summary>
+
+-   [Passthrough](#passthrough)
+-   [Add FIWARE Service and/or ServicePath](#add-fiware-service-andor-servicepath)
+-   [Delete FIWARE Service and/or ServicePath](#delete-fiware-service-andor-servicepath)
+
+</details>
+
+## Passthrough
+
+It allows to pass FIWARE Service value and/or ServicePath value to output without manipulation.
+
+### Properties
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images//service-and-servicepath/service-and-servicepath-02.png)
+
+-   `name`: A name for a node instance
+-   `FIWARE Service`: `Passthrough`
+-   `FIWARE ServicePath`: `Passthrough`
+
+### Example
+
+#### Input
+
+Payload *JSON Object*
+
+A `msg.context` should contain JSON Object.
+
+```
+{
+  "fiwareService": "openiot",
+  "fiwareServicePath": "/iot"
+}
+```
+
+#### Output
+
+Payload *JSON Object*
+
+A `msg.context` contains JSON Object.
+
+```
+{
+  "fiwareService": "openiot",
+  "fiwareServicePath": "/iot"
+}
+```
+
+## Add FIWARE Service and/or ServicePath
+
+It allows to add FIWARE Service and/or FIWARE ServicePath to `msg.context`.
+
+### Properties
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/service-and-servicepath/service-and-servicepath-03.png)
+
+-   `name`: A name for a node instance
+-   `FIWARE Service`: `Add`
+-   `Service value`: A value of FIWARE Service
+-   `FIWARE ServicePath`: `Add`
+-   `Service valuePath`: A value of FIWARE ServicePath
+
+### Examples
+
+Set `Service value` to `OpenIoT` and `Service valuePath` to `/iot`.
+
+#### Input
+
+Payload *JSON Object*
+
+A `msg.context` should contain JSON Object.
+
+```
+{}
+```
+
+#### Output
+
+Payload *JSON Object*
+
+A `msg.context` contains JSON Object.
+
+```
+{
+  "fiwareService":"openiot",
+  "fiwareServicePath":"/iot"
+}
+```
+
+## Delete FIWARE Service and/or ServicePath
+
+It allows to delete FIWARE Service and/or FIWARE ServicePath from `msg.context`.
+
+### Properties
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images//service-and-servicepath/service-and-servicepath-04.png)
+
+-   `name`: A name for a node instance
+-   `FIWARE Service`: `Delete`
+-   `FIWARE ServicePath`: `Delete`
+
+### Example
+
+#### Input
+
+Payload *JSON Object*
+
+A `msg.context` should contain JSON Object.
+
+```
+{
+  "fiwareService":"openiot",
+  "fiwareServicePath":"/iot"
+}
+```
+
+#### Output
+
+Payload *JSON Object*
+
+A `msg.context` contains JSON Object.
+
+```
+{}
+```
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -22,6 +22,7 @@ Node-RED NGSI integration
 -   [NGSI to Worldmap](custom_nodes/ngsi_to_worldmap.md)
 -   [GTFS realtime to NGSI](custom_nodes/ngsi_gtfs_realtime.md)
 -   [FIWARE version](custom_nodes/fiware_version.md)
+-   [FIWARE Service and ServicePath](custom_nodes/service-and-servicepath.md)
 
 ## Documentation
 

diff --git a/docs/ja/custom_nodes/service-and-servicepath.md b/docs/ja/custom_nodes/service-and-servicepath.md
@@ -0,0 +1,140 @@
+# FIWARE Service and ServicePath
+
+このカスタム・ノードは、FIWARE Service と ServicePath を管理できるノードです。
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/service-and-servicepath/service-and-servicepath-01.png)
+
+## コンテンツ
+
+<details>
+<summary><strong>詳細</strong></summary>
+
+-   [パススルー](#passthrough)
+-   [FIWARE Service および/または ServicePath の追加](#add-fiware-service-and-or-servicepath)
+-   [FIWARE Service および/または ServicePath の削除](#delete-fiware-service-and-or-servicepath)
+
+</details>
+
+<a name="passthrough"></a>
+
+## パススルー
+
+FIWARE Service の値、および/または ServicePath の値を操作なしで出力に渡すことができます。
+
+### プロパティ
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images//service-and-servicepath/service-and-servicepath-02.png)
+
+-   `name`: ノード・インスタンスの名前
+-   `FIWARE Service`: `Passthrough`
+-   `FIWARE ServicePath`: `Passthrough`
+
+### 例
+
+#### 入力
+
+Payload *JSON Object*
+
+`msg.context` には、JSON オブジェクトが含まれている必要があります。
+
+```
+{
+  "fiwareService": "openiot",
+  "fiwareServicePath": "/iot"
+}
+```
+
+#### 出力
+
+Payload *JSON Object*
+
+`msg.context` には、JSON オブジェクトが含まれます。
+
+```
+{
+  "fiwareService": "openiot",
+  "fiwareServicePath": "/iot"
+}
+```
+
+<a name="add-fiware-service-and-or-servicepath"></a>
+
+## FIWARE Service および/または ServicePath の追加
+
+`msg.context` に FIWARE Service および/または FIWARE ServicePath を追加できます。
+
+### プロパティ
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/service-and-servicepath/service-and-servicepath-03.png)
+
+-   `name`: ノード・インスタンスの名前
+-   `FIWARE Service`: `Add`
+-   `Service value`: FIWARE Service の値
+-   `FIWARE ServicePath`: `Add`
+-   `Service valuePath`: FIWARE ServicePath の値
+
+### 例
+
+Set `Service value` to `OpenIoT` and `Service valuePath` to `/iot`.
+
+#### 入力
+
+Payload *JSON Object*
+
+`msg.context` には、JSON オブジェクトが含まれている必要があります。
+
+```
+{}
+```
+
+#### 出力
+
+Payload *JSON Object*
+
+`msg.context` には、JSON オブジェクトが含まれます。
+
+```
+{
+  "fiwareService":"openiot",
+  "fiwareServicePath":"/iot"
+}
+```
+
+<a name="delete-fiware-service-and-or-servicepath"></a>
+
+## FIWARE Service および/または ServicePath の削除
+
+`msg.context` から FIWARE Service および/または FIWARE ServicePath を削除できます。
+
+### プロパティ
+
+![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images//service-and-servicepath/service-and-servicepath-04.png)
+
+-   `name`: ノード・インスタンスの名前
+-   `FIWARE Service`: `Delete`
+-   `FIWARE ServicePath`: `Delete`
+
+### 例
+
+#### 入力
+
+Payload *JSON Object*
+
+`msg.context` には、JSON オブジェクトが含まれている必要があります。
+
+```
+{
+  "fiwareService":"openiot",
+  "fiwareServicePath":"/iot"
+}
+```
+
+#### 出力
+
+Payload *JSON Object*
+
+`msg.context` には、JSON オブジェクトが含まれます。
+
+```
+{}
+```
diff --git a/docs/ja/index.md b/docs/ja/index.md
@@ -22,6 +22,7 @@ FIWARE Open APIs の Node-RED 実装
 -   [NGSI to Worldmap](custom_nodes/ngsi_to_worldmap.md)
 -   [GTFS realtime to NGSI](custom_nodes/ngsi_gtfs_realtime.md)
 -   [FIWARE version](custom_nodes/fiware_version.md)
+-   [FIWARE Service and ServicePath](custom_nodes/service-and-servicepath.md)
 
 ## ドキュメント
 

diff --git a/examples/batch-update.json b/examples/batch-update.json
diff --git a/examples/registration.json b/examples/registration.json