Skip to content

[WIP]: Added documentation section for REST connector multipart/form-data functionality. #2465

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.

Sign up for GitHub

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

Open
Andry925 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[WIP]: Added documentation section for REST connector multipart/form-data functionality. #2465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ade9ab7
add documentation section for multipart/form-data functionality
Andry925 Dec 26, 2025
04a9666
update configs for rest connector section
Andry925 Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions _includes/templates/iot-gateway/rest-connector-anonymous-security-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ Anonymous auth is the most simple option. It is useful for testing.
Security subsection in configuration file will look like this:

```json
"security": {
"type": "anonymous"
}
{
"security": {
"type": "anonymous"
}
}
```
{: .copy-code}
12 changes: 7 additions & 5 deletions _includes/templates/iot-gateway/rest-connector-basic-security-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ The REST Connector waits for HTTP requests with the Authorization header that co
Security section in configuration file will look like this:

```json
"security": {
"type": "basic",
"username": "username",
"password": "password"
}
{
"security": {
"type": "basic",
"username": "username",
"password": "password"
}
}
```

Also, make sure that your request have `Authorization` header with provided credentials.
Expand Down
13 changes: 10 additions & 3 deletions _includes/templates/iot-gateway/rest-connector-no-ssl-security-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,15 @@
Configuration section will look like:
```json
{
"host": "127.0.0.1",
"port": "5000",
"SSL": false
"server": {
"host": "127.0.0.1",
"port": "5000",
"SSL": false,
"security": {
"cert": "~/ssl/cert.pem",
"key": "~/ssl/key.pem"
}
}
}
```
{: .copy-code}
16 changes: 10 additions & 6 deletions _includes/templates/iot-gateway/rest-connector-ssl-security-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,18 @@
|---

Configuration section will look like:

```json
{
"host": "127.0.0.1",
"port": "5000",
"SSL": true,
"security": {
"cert": "~/ssl/cert.pem",
"key": "~/ssl/key.pem"
"server": {
"host": "127.0.0.1",
"port": 5000,
"SSLVerify": true,
"security": {
"cert": "~/ssl/cert.pem",
"key": "~/ssl/key.pem"
}
}
}
```
{: .copy-code}
68 changes: 37 additions & 31 deletions _includes/templates/iot-gateway/rest-converter-custom-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@ A custom converter is converter written for some device:



|**Parameter**|**Default value**|**Description**|
|:-|:-|-
| type | **custom** | Provides information to connector that custom converter will be uses for converting data from request. |
| deviceNameExpression | **SuperAnonDevice** | Device name. |
| deviceTypeExpression | **default** | Devcie type. |
| extension | **CustomRESTUplinkConverter** | Name of custom converter class. |
| extension-config | | Configuration, for custom converter (You can put anything, there. It will be passed to the converter object on initialization). |
| key | **Totaliser** | |
| datatype | **float** | |
| fromByte | **0** | |
| toByte | **4** | |
| byteorder | **big** | |
| signed | **true** | |
| multiplier | **1** | |
|---
| **Parameter** | **Default value** | **Description** |
|:------------------------------|:------------------------------|---------------------------------------------------------------------------------------------------------------------------------
| type | **custom** | Provides information to connector that custom converter will be uses for converting data from request. |
| deviceNameExpression | **SuperAnonDevice** | Device name. |
| deviceNameExpressionSource | **constant** | Device name source. |
| deviceProfileExpressionSource | **constant** | Device profile source. |
| deviceProfileExpression | **default** | Device profile name. |
| extension | **CustomRESTUplinkConverter** | Name of custom converter class. |
| extension-config | | Configuration, for custom converter (You can put anything, there. It will be passed to the converter object on initialization). |
| key | **Totaliser** | |
| datatype | **float** | |
| fromByte | **0** | |
| toByte | **4** | |
| byteorder | **big** | |
| signed | **true** | |
| multiplier | **1** | |
| ---

{% capture difference %}

Expand All @@ -29,20 +31,24 @@ A custom converter is converter written for some device:
Mapping subsection in the configuration looks like:

```json
"converter": {
"type": "custom",
"deviceNameExpression": "SuperAnonDevice",
"deviceTypeExpression": "default",
"extension": "CustomRestUplinkConverter",
"extension-config": [
{
"key": "Totaliser",
"datatype": "float",
"fromByte": 0,
"toByte": 4,
"byteorder": "big",
"signed": true,
"multiplier": 1
}]
}
"converter": {
"type": "custom",
"deviceInfo": {
"deviceNameExpression": "SuperAnonDevice",
"deviceNameExpressionSource": "constant",
"deviceProfileExpressionSource": "constant",
"deviceProfileExpression": "default"
},
"extension": "CustomRestUplinkConverter",
"extensionConfig": {
"key": "Totaliser",
"datatype": "float",
"fromByte": 0,
"toByte": 4,
"byteorder": "big",
"signed": true,
"multiplier": 1
}
}
```
{: .copy-code}
Loading