From 2d7bc02c25c333411151f71f8a0cdaa3670d05bd Mon Sep 17 00:00:00 2001 From: Kazuhito Suda Date: Sun, 29 Jan 2023 10:44:04 +0900 Subject: [PATCH] UPDATE documentation about open-apis node --- CHANGELOG.md | 1 + docs/custom_nodes/ngsi_open-apis.md | 25 ++++++++++++++++++++----- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3f35948..836f557 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ ## node-red-contrib-letsfiware-NGSI v0.6.0-next +- UPDATE documentation about open-apis node (#44) - ADD Historical context custom node (#42) - ADD FIWARE GE type option (#40) - UPDATE Node.js dependencies (#39) diff --git a/docs/custom_nodes/ngsi_open-apis.md b/docs/custom_nodes/ngsi_open-apis.md index 57b2b9c..95dd3bc 100644 --- a/docs/custom_nodes/ngsi_open-apis.md +++ b/docs/custom_nodes/ngsi_open-apis.md @@ -2,12 +2,27 @@ This custom node is a configuration node that allows to configure Context Broker and IdM. +![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/open-apis-06.png) + +- `name`: a name for a node instance +- `Generic Enabler`: Generic enable type: `Orion Context Broker` or `STH-Comet` +- `API Endpoint`: URL of API Endpoint of FIWARE GE +- `Service`: FIWARE Service +- `IdM Type`: Identity manager type, either `None`, `Tokenproxy`, `Keyrock`, or `Generic` + +## FIWARE GE + +### Orion Context Broker + +To use Orion Context Broker, set `Orion Context Broker` to the `Generic Enabler` property. + ![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/open-apis-01.png) -- `name`: a name for a node instance -- `Broker Endpoint`: URL of a context broker -- `Service`: FIWARE Service -- `IdM Type`: Identity manager type, either `None`, `Tokenproxy`, `Keyrock`, or `Generic` +### STH-Comet + +To use STH-Comet, set `STH-Comet` to the `Generic Enabler` property. + +![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/open-apis-07.png) ## Identity manager type @@ -35,4 +50,4 @@ Secret. Set `Generic` to `IdM Type` when using an generic identity manager. Then, set IdM Endpoint, Username, Password, Client ID and Client Secret. -![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/open-apis-05.png) +![](https://raw.githubusercontent.com/lets-fiware/node-red-contrib-letsfiware-NGSI/gh-pages/images/open-apis-05.png) \ No newline at end of file