Skip to content

Commit 4ee4807

Browse files
AMasyuninAMasyunin
committed
Updated specification and examples after testing: /iot/logic/flow/read changed to POST due to incorrect processing of GET method:
1 parent bebd8cd commit 4ee4807

File tree

6 files changed

+32
-32
lines changed

6 files changed

+32
-32
lines changed

‎IoT_Logic.json

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
}
7878
},
7979
"/iot/logic/flow/read": {
80-
"get": {
80+
"post": {
8181
"summary": "flowRead",
8282
"description": "Read a flowchart",
8383
"operationId": "flowRead",
@@ -98,9 +98,11 @@
9898
"required": [
9999
"flow_id"
100100
]
101-
}
101+
},
102+
"examples": {}
102103
}
103-
}
104+
},
105+
"description": ""
104106
},
105107
"responses": {
106108
"200": {
@@ -147,7 +149,8 @@
147149
],
148150
"x-stoplight": {
149151
"id": "k1ho66hqjjvoy"
150-
}
152+
},
153+
"parameters": []
151154
}
152155
},
153156
"/iot/logic/flow/update": {
@@ -779,19 +782,18 @@
779782
"data_source"
780783
]
781784
},
782-
783785
"enabled": {
784786
"$ref": "#/components/schemas/Enabled"
785787
},
786788
"data": {
787789
"type": "object",
788790
"properties": {
789791
"title": {
790-
"type": "string",
791-
"examples": [
792-
"Standard Input Endpoint"
793-
]
794-
},
792+
"type": "string",
793+
"examples": [
794+
"Standard Input Endpoint"
795+
]
796+
},
795797
"sources": {
796798
"type": "array",
797799
"items": {
@@ -881,7 +883,7 @@
881883
"data": {
882884
"type": "object",
883885
"properties": {
884-
"title": {
886+
"title": {
885887
"type": "string",
886888
"examples": [
887889
"Add/modify attributes"

‎docs/Guides/Advanced-configurations.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ Request body:
5959
{
6060
"id": 1,
6161
"type": "data_source",
62-
"title": "Temperature Sensors",
6362
"enabled": true,
6463
"data": {
64+
"title": "Temperature Sensors",
6565
"sources": [123458]
6666
},
6767
"view": {
@@ -71,8 +71,8 @@ Request body:
7171
{
7272
"id": 2,
7373
"type": "initiate_attributes",
74-
"title": "Basic Calculations",
7574
"data": {
75+
"title": "Basic Calculations",
7676
"items": [
7777
{
7878
"name": "temp_celsius",
@@ -89,8 +89,8 @@ Request body:
8989
{
9090
"id": 3,
9191
"type": "initiate_attributes",
92-
"title": "Advanced Calculations",
9392
"data": {
93+
"title": "Advanced Calculations",
9494
"items": [
9595
{
9696
"name": "temp_status",
@@ -107,9 +107,9 @@ Request body:
107107
{
108108
"id": 4,
109109
"type": "output_endpoint",
110-
"title": "Send to Navixy",
111110
"enabled": true,
112111
"data": {
112+
"title": "Send to Navixy",
113113
"output_endpoint_type": "output_navixy"
114114
},
115115
"view": {
@@ -119,9 +119,9 @@ Request body:
119119
{
120120
"id": 5,
121121
"type": "output_endpoint",
122-
"title": "Send to MQTT",
123122
"enabled": true,
124123
"data": {
124+
"title": "Send to MQTT",
125125
"output_endpoint_type": "output_mqtt_client",
126126
"output_endpoint_id": 44551
127127
},
@@ -149,7 +149,7 @@ Response:
149149

150150
### Verifying the flow configuration
151151

152-
#### [GET /iot/logic/flow/read](../../IoT_Logic.json/paths/~1iot~1logic~1flow~1read/get)
152+
#### [POST /iot/logic/flow/read](../../IoT_Logic.json/paths/~1iot~1logic~1flow~1read/post)
153153

154154
Request body:
155155
```json
@@ -209,9 +209,9 @@ Request body:
209209
{
210210
"id": 1,
211211
"type": "data_source",
212-
"title": "Environmental Sensors",
213212
"enabled": true,
214213
"data": {
214+
"title": "Environmental Sensors",
215215
"sources": [98765]
216216
},
217217
"view": {
@@ -221,8 +221,8 @@ Request body:
221221
{
222222
"id": 2,
223223
"type": "initiate_attributes",
224-
"title": "Temperature Processing",
225224
"data": {
225+
"title": "Temperature Processing",
226226
"items": [
227227
{
228228
"name": "temp_celsius",
@@ -239,8 +239,8 @@ Request body:
239239
{
240240
"id": 3,
241241
"type": "initiate_attributes",
242-
"title": "Humidity Processing",
243242
"data": {
243+
"title": "Humidity Processing",
244244
"items": [
245245
{
246246
"name": "humidity_adjusted",
@@ -257,8 +257,8 @@ Request body:
257257
{
258258
"id": 4,
259259
"type": "initiate_attributes",
260-
"title": "Combined Analysis",
261260
"data": {
261+
"title": "Combined Analysis",
262262
"items": [
263263
{
264264
"name": "heat_index",
@@ -281,9 +281,9 @@ Request body:
281281
{
282282
"id": 5,
283283
"type": "output_endpoint",
284-
"title": "Send to Navixy",
285284
"enabled": true,
286285
"data": {
286+
"title": "Send to Navixy",
287287
"output_endpoint_type": "output_navixy"
288288
},
289289
"view": {
@@ -311,7 +311,7 @@ Response:
311311

312312
### Verifying the flow configuration
313313

314-
#### [GET /iot/logic/flow/read](../../IoT_Logic.json/paths/~1iot~1logic~1flow~1read/get)
314+
#### [POST /iot/logic/flow/read](../../IoT_Logic.json/paths/~1iot~1logic~1flow~1read/post)
315315

316316
Request body:
317317
```json

‎docs/Guides/scenario1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ Request body:
8686
{
8787
"id": 1,
8888
"type": "data_source",
89-
"title": "Fleet vehicles",
9089
"enabled": true,
9190
"data": {
91+
"title": "Fleet vehicles",
9292
"sources": [56789]
9393
},
9494
"view": {
@@ -98,9 +98,9 @@ Request body:
9898
{
9999
"id": 2,
100100
"type": "output_endpoint",
101-
"title": "Send to external system",
102101
"enabled": true,
103102
"data": {
103+
"title": "Send to external system",
104104
"output_endpoint_type": "output_mqtt_client",
105105
"output_endpoint_id": 45678
106106
},

‎docs/Guides/scenario2.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Response:
3333

3434
To see the details of a specific flow, send the request:
3535

36-
### [GET /iot/logic/flow/read](../../IoT_Logic.json/paths/~1iot~1logic~1flow~1read/get)
36+
### [POST /iot/logic/flow/read](../../IoT_Logic.json/paths/~1iot~1logic~1flow~1read/post)
3737

3838
Request body:
3939
```json
@@ -138,9 +138,9 @@ Request body:
138138
{
139139
"id": 1,
140140
"type": "data_source",
141-
"title": "Fleet Vehicles",
142141
"enabled": true,
143142
"data": {
143+
"title": "Fleet Vehicles",
144144
"sources": [12345, 12346, 12347]
145145
},
146146
"view": {
@@ -150,8 +150,8 @@ Request body:
150150
{
151151
"id": 2,
152152
"type": "initiate_attributes",
153-
"title": "Calculate Business Metrics",
154153
"data": {
154+
"title": "Calculate Business Metrics",
155155
"items": [
156156
{
157157
"name": "fuel_efficiency",
@@ -186,9 +186,9 @@ Request body:
186186
{
187187
"id": 3,
188188
"type": "output_endpoint",
189-
"title": "Send to External System",
190189
"enabled": true,
191190
"data": {
191+
"title": "Send to External System",
192192
"output_endpoint_type": "output_mqtt_client",
193193
"output_endpoint_id": 45678
194194
},

‎docs/Overview.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ stoplight-id: ie3rt9xv91kie
44

55
# Navixy IoT Logic API
66

7-
*BETA Version*
8-
97
<!-- theme: warning -->
108
> *BETA Version!* <br>
119
>Now the easrly access of IoT Logic's API is implemented, which means possible changes in the near future. Feel free to try the functionality, however, you may need to introduce changes in your applications reflecting the API functionality updates. Stay tuned!

‎toc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
{
2323
"type": "item",
2424
"title": "JSON-schema template",
25-
"uri": "IoT Logic.json/components/schemas/Flow",
25+
"uri": "IoT_Logic.json/components/schemas/Flow",
2626
"slug": "flow-schemas/json-schema-template"
2727
},
2828
{

0 commit comments

Comments
 (0)