Skip to content

Commit 2ac8d2a

Browse files
AMasyuninAMasyunin
authored
Merge pull request #4 from SquareGPS/Stoplight-testing
Updated version of docs to publish
2 parents 6d99444 + 259cf40 commit 2ac8d2a

10 files changed

+888
-232
lines changed

‎IoT_Logic.json

+41-38
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@
2020
},
2121
"servers": [
2222
{
23-
"url": "https://api.eu.navixy.com",
23+
"url": "https://api.eu.navixy.com/v2",
2424
"description": "Navixy production server on European platform"
2525
},
2626
{
27-
"url": "https://api.us.navixy.com",
27+
"url": "https://api.us.navixy.com/v2",
2828
"description": "Navixy production server on American platform"
2929
}
3030
],
@@ -63,11 +63,11 @@
6363
],
6464
"servers": [
6565
{
66-
"url": "https://api.eu.navixy.com",
66+
"url": "https://api.eu.navixy.com/v2",
6767
"description": "Navixy production server on European platform"
6868
},
6969
{
70-
"url": "https://api.us.navixy.com",
70+
"url": "https://api.us.navixy.com/v2",
7171
"description": "Navixy production server on American platform"
7272
}
7373
],
@@ -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": {
@@ -137,17 +139,18 @@
137139
],
138140
"servers": [
139141
{
140-
"url": "https://api.eu.navixy.com",
142+
"url": "https://api.eu.navixy.com/v2",
141143
"description": "Navixy production server on European platform"
142144
},
143145
{
144-
"url": "https://api.us.navixy.com",
146+
"url": "https://api.us.navixy.com/v2",
145147
"description": "Navixy production server on American platform"
146148
}
147149
],
148150
"x-stoplight": {
149151
"id": "k1ho66hqjjvoy"
150-
}
152+
},
153+
"parameters": []
151154
}
152155
},
153156
"/iot/logic/flow/update": {
@@ -187,11 +190,11 @@
187190
],
188191
"servers": [
189192
{
190-
"url": "https://api.eu.navixy.com",
193+
"url": "https://api.eu.navixy.com/v2",
191194
"description": "Navixy production server on European platform"
192195
},
193196
{
194-
"url": "https://api.us.navixy.com",
197+
"url": "https://api.us.navixy.com/v2",
195198
"description": "Navixy production server on American platform"
196199
}
197200
],
@@ -248,11 +251,11 @@
248251
],
249252
"servers": [
250253
{
251-
"url": "https://api.eu.navixy.com",
254+
"url": "https://api.eu.navixy.com/v2",
252255
"description": "Navixy production server on European platform"
253256
},
254257
{
255-
"url": "https://api.us.navixy.com",
258+
"url": "https://api.us.navixy.com/v2",
256259
"description": "Navixy production server on American platform"
257260
}
258261
],
@@ -325,11 +328,11 @@
325328
],
326329
"servers": [
327330
{
328-
"url": "https://api.eu.navixy.com",
331+
"url": "https://api.eu.navixy.com/v2",
329332
"description": "Navixy production server on European platform"
330333
},
331334
{
332-
"url": "https://api.us.navixy.com",
335+
"url": "https://api.us.navixy.com/v2",
333336
"description": "Navixy production server on American platform"
334337
}
335338
],
@@ -375,11 +378,11 @@
375378
],
376379
"servers": [
377380
{
378-
"url": "https://api.eu.navixy.com",
381+
"url": "https://api.eu.navixy.com/v2",
379382
"description": "Navixy production server on European platform"
380383
},
381384
{
382-
"url": "https://api.us.navixy.com",
385+
"url": "https://api.us.navixy.com/v2",
383386
"description": "Navixy production server on American platform"
384387
}
385388
],
@@ -449,11 +452,11 @@
449452
],
450453
"servers": [
451454
{
452-
"url": "https://api.eu.navixy.com",
455+
"url": "https://api.eu.navixy.com/v2",
453456
"description": "Navixy production server on European platform"
454457
},
455458
{
456-
"url": "https://api.us.navixy.com",
459+
"url": "https://api.us.navixy.com/v2",
457460
"description": "Navixy production server on American platform"
458461
}
459462
],
@@ -499,11 +502,11 @@
499502
],
500503
"servers": [
501504
{
502-
"url": "https://api.eu.navixy.com",
505+
"url": "https://api.eu.navixy.com/v2",
503506
"description": "Navixy production server on European platform"
504507
},
505508
{
506-
"url": "https://api.us.navixy.com",
509+
"url": "https://api.us.navixy.com/v2",
507510
"description": "Navixy production server on American platform"
508511
}
509512
],
@@ -553,11 +556,11 @@
553556
],
554557
"servers": [
555558
{
556-
"url": "https://api.eu.navixy.com",
559+
"url": "https://api.eu.navixy.com/v2",
557560
"description": "Navixy production server on European platform"
558561
},
559562
{
560-
"url": "https://api.us.navixy.com",
563+
"url": "https://api.us.navixy.com/v2",
561564
"description": "Navixy production server on American platform"
562565
}
563566
],
@@ -620,11 +623,11 @@
620623
],
621624
"servers": [
622625
{
623-
"url": "https://api.eu.navixy.com",
626+
"url": "https://api.eu.navixy.com/v2",
624627
"description": "Navixy production server on European platform"
625628
},
626629
{
627-
"url": "https://api.us.navixy.com",
630+
"url": "https://api.us.navixy.com/v2",
628631
"description": "Navixy production server on American platform"
629632
}
630633
],
@@ -779,18 +782,18 @@
779782
"data_source"
780783
]
781784
},
782-
"title": {
783-
"type": "string",
784-
"examples": [
785-
"Standard Input Endpoint"
786-
]
787-
},
788785
"enabled": {
789786
"$ref": "#/components/schemas/Enabled"
790787
},
791788
"data": {
792789
"type": "object",
793790
"properties": {
791+
"title": {
792+
"type": "string",
793+
"examples": [
794+
"Standard Input Endpoint"
795+
]
796+
},
794797
"sources": {
795798
"type": "array",
796799
"items": {
@@ -877,15 +880,15 @@
877880
"initiate_attributes"
878881
]
879882
},
880-
"title": {
881-
"type": "string",
882-
"examples": [
883-
"Add/modify attributes"
884-
]
885-
},
886883
"data": {
887884
"type": "object",
888885
"properties": {
886+
"title": {
887+
"type": "string",
888+
"examples": [
889+
"Add/modify attributes"
890+
]
891+
},
889892
"items": {
890893
"type": "array",
891894
"items": {

‎assets/images/Flow-example.png

57.4 KB
Loading

‎docs/Contacts.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
stoplight-id: go8da0y2b7ltt
3+
---
4+
5+
# Contact-us
6+
7+
The beginning of an awesome article...

‎docs/Guides/Advanced-configurations.md

+12-12
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

+2-2
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
},

0 commit comments

Comments
 (0)