Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add feature for encoding and decoding forbidden chars #135

Merged
merged 1 commit into from May 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
@@ -1,5 +1,6 @@
## node-red-contrib-letsfiware-NGSI v0.14.0-next

- Add feature for encoding and decoding forbidden chars (#135)
- ADD encode / decode node (#133)

## node-red-contrib-letsfiware-NGSI v0.14.0 - 02 May, 2023
Expand Down
2 changes: 2 additions & 0 deletions docs/en/custom_nodes/historical_context.md
Expand Up @@ -64,6 +64,7 @@ For example, if you want to get historical context from 3 days ago to 2 days ago
- `Unit for data to`: unit for the final date
- `Output type`: `raw`, `value` or `dashboard`
- `Count`: the total count of elements
- `Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -123,6 +124,7 @@ A `msg.statusCode` contains a status code.
- `Date to`: the final date and time until which the raw context information is desired. It is an optional parameter.
- `Unit for data to`: unit for the final date
- `Output type`: `raw`, `value` or `dashboard`
- `Decode forbidden chars`: `off` or `on`

### Input

Expand Down
6 changes: 5 additions & 1 deletion docs/en/custom_nodes/ngsi_attribute.md
Expand Up @@ -33,6 +33,7 @@ It allows to read an attribute in NGSIv2 entity.
- `Attribute name`: Attribute name of an attribute to be read
- `Metadata`: List of metadata names
- `Skip forwarding`: If true, Context Broker skips forwarding to Context Providers
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -98,6 +99,7 @@ It allows to update an attribute in NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -137,6 +139,7 @@ It allows to delete an attribute in NGSIv2 entity.
- `Entity id`: Id of an entity containing an attribute to be deleted
- `Entity type`: Type of an entity containing an attribute to be delete
- `Attribute name`: Attribute name of an attribute to be deleted
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -192,6 +195,7 @@ It allows to read, update or delete an attribute in NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode / Decode forbidden chars`: `off` or `on`

### Input 1

Expand Down Expand Up @@ -269,4 +273,4 @@ A `msg.payload` contains a status code.

```text
204
```
```
5 changes: 4 additions & 1 deletion docs/en/custom_nodes/ngsi_attribute_value.md
Expand Up @@ -31,6 +31,7 @@ It allows to read an attribute value of NGSIv2 entity.
- `Entity type`: Type of an entity containing an attribute to be read a value
- `Attribute name`: Attribute name of an attribute to be read a value
- `Skip forwarding`: If true, Context Broker skips forwarding to Context Providers
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -86,6 +87,7 @@ It allows to update an attribute value of NGSIv2 entity.
- `Attribute name`: Attribute name of an attribute to be updated a value
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -147,6 +149,7 @@ It allows to read or update an attribute value of NGSIv2 entity.
- `Skip forwarding`: If true, Context Broker skips forwarding to Context Providers
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode / Decode forbidden chars`: `off` or `on`

### Input 1

Expand Down Expand Up @@ -255,4 +258,4 @@ A `msg.statusCode` contains a status code.

```
204
```
```
7 changes: 6 additions & 1 deletion docs/en/custom_nodes/ngsi_attributes.md
Expand Up @@ -35,6 +35,7 @@ It allows to append attributes of NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -80,6 +81,7 @@ It allows to update attributes of NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -125,6 +127,7 @@ It allows to upsert attributes of NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -175,6 +178,7 @@ It allows to replace attributes of NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -230,6 +234,7 @@ It allows to append, update, upsert or replace attributes of NGSIv2 entity.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -316,4 +321,4 @@ A `msg.statusCode` contains a status code.

```text
204
```
```
9 changes: 7 additions & 2 deletions docs/en/custom_nodes/ngsi_batch_update.md
Expand Up @@ -35,6 +35,7 @@ It allows to append several entities.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -91,6 +92,7 @@ It allows to append several entities strictly.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -147,6 +149,7 @@ It allows to update several entities.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -203,6 +206,7 @@ It allows to replace several entities.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -259,6 +263,7 @@ It allows to delete several entities.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism
- `Encode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -315,7 +320,7 @@ It allows to append, appendStrict, update, replace or delete several entities.
- `Override metadata`: If true, it replaces the existing metadata
- `Forced update`: If true, it triggers matching subscriptions
- `Flow control`: If true, it enables flow control mechanism

- `Encode forbidden chars`: `off` or `on`

### Input (append)

Expand Down Expand Up @@ -530,4 +535,4 @@ A `msg.statusCode` contains a status code.

```text
204
```
```
7 changes: 6 additions & 1 deletion docs/en/custom_nodes/ngsi_entity.md
Expand Up @@ -30,6 +30,7 @@ It allows to create a NGSIv2 entity.
- `ServicePath`: FIWARE Service Path
- `Action type`: `create`
- `Representation`: normalized or keyValues
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -91,6 +92,7 @@ It allows to read a NGSIv2 entity.
- `attributes`: list of attributes of an entity to be read
- `Representation`: normalized or keyValues
- `Date Modified`: retrieve attribute and metadata of dateModified
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -158,6 +160,7 @@ It allows to upsert a NGSIv2 entity.
- `ServicePath`: FIWARE Service Path
- `Action type`: `upsert`
- `Representation`: normalized or keyValues
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -216,6 +219,7 @@ It allows to delete a NGSIv2 entity.
- `Action type`: `delete`
- `Entity id`: id of an entity to be deleted
- `Entity type`: type of an entity to be deleted
- `Encode / Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -262,6 +266,7 @@ It allows to create, read, upsert or delete a NGSIv2 entity.
- `Entity type`: Type of an entity to be created, read, upserted or deleted
- `Representation`: normalized or keyValues
- `Date Modified`: retrieve attribute and metadata of dateModified
- `Encode / Decode forbidden chars`: `off` or `on`

### Input (create)

Expand Down Expand Up @@ -413,4 +418,4 @@ A `msg.statusCode` contains a status code.

```text
204
```
```
1 change: 1 addition & 0 deletions docs/en/custom_nodes/ngsi_source.md
Expand Up @@ -29,6 +29,7 @@ This custom node is a simple node that allows to obtain NGSIv2 entities.
- `Attrs`: list of attributes to retrieve
- `Query`: query conditions using Simple Query Language
- `Buffering`: whether to output all retrieved entities at once
- `Decode forbidden chars`: `off` or `on`

## Input

Expand Down
4 changes: 4 additions & 0 deletions docs/en/custom_nodes/ngsi_timeseries.md
Expand Up @@ -36,6 +36,7 @@ It allows to list of all the entity id available.
- `Unit for date`: Unit for to date
- `Limit`: Maximum number of results to retrieve in a single response
- `Offset`: Offset to apply to the response results
- `Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -95,6 +96,7 @@ It allows to query history of attribute(s) (values only) of a given entity.
- `Coords`: Specifies the reference shape (geometry) in terms of WGS 84 coordinates
- `Limit`: Maximum number of results to retrieve in a single response
- `Offset`: Offset to apply to the response results
- `Decode forbidden chars`: `off` or `on`

### Entity attributes

Expand Down Expand Up @@ -343,6 +345,7 @@ It allows to query history of attribute(s) (values only) of N entities of the sa
- `Coords`: Specifies the reference shape (geometry) in terms of WGS 84 coordinates
- `Limit`: Maximum number of results to retrieve in a single response
- `Offset`: Offset to apply to the response results
- `Decode forbidden chars`: `off` or `on`

### Type entity

Expand Down Expand Up @@ -601,6 +604,7 @@ It allows to query history of N attribute(s) (values only) of N entities of N ty
- `Coords`: Specifies the reference shape (geometry) in terms of WGS 84 coordinates
- `Limit`: Maximum number of results to retrieve in a single response
- `Offset`: Offset to apply to the response results
- `Decode forbidden chars`: `off` or `on`

### Attributes

Expand Down
6 changes: 4 additions & 2 deletions docs/en/custom_nodes/ngsi_types.md
Expand Up @@ -29,6 +29,7 @@ It allows to retrieve a list of entity types.
- `Action Type`: `List Entity Types`
- `Values`: If true, the response payload is a JSON array with a list of entity types
- `NoAttrDetail`: If true, the request does not provide attribute type details
- `Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -109,6 +110,7 @@ It allows to retrieve entity information for a given type.
- `Action Type`: `Entity information for a given type`
- `Entity type`: Type of Entity to retrieve an entity information
- `NoAttrDetail`: If true, the request does not provide attribute type details
- `Decode forbidden chars`: `off` or `on`

### Input

Expand Down Expand Up @@ -187,7 +189,7 @@ It allows to retrieve a list of entity types or entity information for a given t
- `Entity type`: Type of Entity to retrieve an entity information
- `Values`: If true, the response payload is a JSON array with a list of entity types
- `NoAttrDetail`: If true, the request does not provide attribute type details

- `Decode forbidden chars`: `off` or `on`

### Input (types)

Expand Down Expand Up @@ -323,4 +325,4 @@ A `msg.statusCode` contains a status code.

```
200
```
```
2 changes: 2 additions & 0 deletions docs/ja/custom_nodes/historical_context.md
Expand Up @@ -68,6 +68,7 @@
- `Unit for data to`: 最終日時の単位
- `Output type`: `raw`, `value` または `dashboard`
- `Count`: 要素の総数
- `Decode forbidden chars`: `off` または `on`

### 入力

Expand Down Expand Up @@ -129,6 +130,7 @@ statusCode *Number*
- `Date to`: 未加工のコンテキスト情報が必要な最終日時。これはオプションのパラメーターです
- `Unit for data to`: 最終日時の単位
- `Output type`: `raw`, `value` または `dashboard`
- `Decode forbidden chars`: `off` または `on`

### 入力

Expand Down
6 changes: 5 additions & 1 deletion docs/ja/custom_nodes/ngsi_attribute.md
Expand Up @@ -35,6 +35,7 @@ NGSIv2 エンティティの属性を読み取ることができます。
- `Attribute name`: 読み取る属性の名前
- `Metadata`: 属性を読み取る属性名
- `Skip forwarding`: Context Broker は Context Provider への転送をスキップします
- `Encode / Decode forbidden chars`: `off` または `on`

### 入力

Expand Down Expand Up @@ -102,6 +103,7 @@ NGSIv2 エンティティの属性を更新できます。
- `Override metadata`: true の場合、既存のメタデータを置き換えます
- `Forced update`: true の場合、一致するサブスクリプションをトリガーします
- `Flow control`: true の場合、フロー制御メカニズムが有効になります
- `Encode / Decode forbidden chars`: `off` または `on`

### 入力

Expand Down Expand Up @@ -143,6 +145,7 @@ NGSIv2 エンティティの属性を削除できます。
- `Entity id`: 削除する属性のエンティティ id
- `Entity type`: 削除する属性のエンティティ・タイプ
- `Attribute name`: 削除する属性の名前
- `Encode / Decode forbidden chars`: `off` または `on`

### 入力

Expand Down Expand Up @@ -200,6 +203,7 @@ NGSIv2 エンティティの属性の読み取り、更新、または削除が
- `Override metadata`: true の場合、既存のメタデータを置き換えます
- `Forced update`: true の場合、一致するサブスクリプションをトリガーします
- `Flow control`: true の場合、フロー制御メカニズムが有効になります
- `Encode / Decode forbidden chars`: `off` または `on`

### 入力 1

Expand Down Expand Up @@ -282,4 +286,4 @@ statusCode *Number*

```
204
```
```