Skip to content

Commit

Permalink
Merge pull request #44 from fisuda/update/documentation
Browse files Browse the repository at this point in the history
UPDATE documentation about open-apis node
  • Loading branch information
fisuda authored Jan 29, 2023
2 parents ea4a6be + 2d7bc02 commit be62481
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
25 changes: 20 additions & 5 deletions docs/custom_nodes/ngsi_open-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)

0 comments on commit be62481

Please sign in to comment.