Skip to content
This repository was archived by the owner on Feb 26, 2026. It is now read-only.

Commit 6c80074

Browse files
rodneyosodorodneyosodo
authored
NOISSUE - Update Propeller Docs (#11)
* feat(postman): update collection to match latest API * feat(embedded propelt): documentation on embedded proplet * fix(supermq): change topic definition * docs(supermq): update getting started guide to match latest deployment of propeller * style: add new line * style: fix ci Link text should be descriptive
1 parent 83fd4bd commit 6c80074

File tree

8 files changed

+365
-162
lines changed

8 files changed

+365
-162
lines changed

‎docs/api/postman_collection.json‎

Lines changed: 157 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
"method": "GET",
2020
"header": [],
2121
"url": {
22-
"raw": "{{MANAGER_BASE_URL}}/proplets/{{WORKER_ID}}",
22+
"raw": "{{MANAGER_BASE_URL}}/proplets/{{PROPELLER_ID}}",
2323
"host": [
2424
"{{MANAGER_BASE_URL}}"
2525
],
2626
"path": [
2727
"proplets",
28-
"{{WORKER_ID}}"
28+
"{{PROPELLER_ID}}"
2929
]
3030
}
3131
},
@@ -61,13 +61,161 @@
6161
"name": "Task",
6262
"item": [
6363
{
64-
"name": "Create Task With Image",
64+
"name": "Embedded",
65+
"item": [
66+
{
67+
"name": "Create Task",
68+
"event": [
69+
{
70+
"listen": "test",
71+
"script": {
72+
"exec": [
73+
"function constructVisualizerPayload() {",
74+
" var res = pm.response.json();",
75+
" var id = res.id;",
76+
" return id;",
77+
"}",
78+
"",
79+
"pm.collectionVariables.set('TASK_ID', constructVisualizerPayload());",
80+
""
81+
],
82+
"type": "text/javascript",
83+
"packages": {}
84+
}
85+
},
86+
{
87+
"listen": "prerequest",
88+
"script": {
89+
"exec": [
90+
""
91+
],
92+
"type": "text/javascript",
93+
"packages": {}
94+
}
95+
}
96+
],
97+
"request": {
98+
"method": "POST",
99+
"header": [],
100+
"body": {
101+
"mode": "raw",
102+
"raw": "{\n \"name\": \"main\",\n \"image_url\": \"docker.io/mrstevenyaga/add.wasm\",\n \"file\": \"AGFzbQEAAAABBwFgAn9/AX8DAgEABwgBBG1haW4AAAoJAQcAIAAgAWoL\",\n \"inputs\": [\n 10,\n 20\n ]\n}",
103+
"options": {
104+
"raw": {
105+
"language": "json"
106+
}
107+
}
108+
},
109+
"url": {
110+
"raw": "{{MANAGER_BASE_URL}}/tasks",
111+
"host": [
112+
"{{MANAGER_BASE_URL}}"
113+
],
114+
"path": [
115+
"tasks"
116+
]
117+
}
118+
},
119+
"response": []
120+
},
121+
{
122+
"name": "Get Task",
123+
"request": {
124+
"method": "GET",
125+
"header": [],
126+
"url": {
127+
"raw": "{{MANAGER_BASE_URL}}/tasks/{{TASK_ID}}",
128+
"host": [
129+
"{{MANAGER_BASE_URL}}"
130+
],
131+
"path": [
132+
"tasks",
133+
"{{TASK_ID}}"
134+
]
135+
}
136+
},
137+
"response": []
138+
},
139+
{
140+
"name": "Start Task",
141+
"event": [
142+
{
143+
"listen": "test",
144+
"script": {
145+
"exec": [
146+
""
147+
],
148+
"type": "text/javascript",
149+
"packages": {}
150+
}
151+
},
152+
{
153+
"listen": "prerequest",
154+
"script": {
155+
"exec": [
156+
""
157+
],
158+
"type": "text/javascript",
159+
"packages": {}
160+
}
161+
}
162+
],
163+
"request": {
164+
"method": "POST",
165+
"header": [],
166+
"url": {
167+
"raw": "{{MANAGER_BASE_URL}}/tasks/{{TASK_ID}}/start",
168+
"host": [
169+
"{{MANAGER_BASE_URL}}"
170+
],
171+
"path": [
172+
"tasks",
173+
"{{TASK_ID}}",
174+
"start"
175+
]
176+
}
177+
},
178+
"response": []
179+
}
180+
]
181+
},
182+
{
183+
"name": "Create Task",
184+
"event": [
185+
{
186+
"listen": "test",
187+
"script": {
188+
"exec": [
189+
"function constructVisualizerPayload() {",
190+
" var res = pm.response.json();",
191+
" var id = res.id;",
192+
" return id;",
193+
"}",
194+
"",
195+
"pm.collectionVariables.set('TASK_ID', constructVisualizerPayload());",
196+
""
197+
],
198+
"type": "text/javascript",
199+
"packages": {}
200+
}
201+
},
202+
{
203+
"listen": "prerequest",
204+
"script": {
205+
"exec": [
206+
""
207+
],
208+
"type": "text/javascript",
209+
"packages": {}
210+
}
211+
}
212+
],
65213
"request": {
66214
"method": "POST",
67215
"header": [],
68216
"body": {
69217
"mode": "raw",
70-
"raw": "{\n \"name\": \"add\",\n \"inputs\": [\n 10,\n 20\n ],\n \"image_url\": \"docker.io/mrstevenyaga/add.wasm\"\n}",
218+
"raw": "{\n \"name\": \"add\",\n \"inputs\": [\n 10,\n 20\n ]\n}",
71219
"options": {
72220
"raw": {
73221
"language": "json"
@@ -87,7 +235,7 @@
87235
"response": []
88236
},
89237
{
90-
"name": "Create Task",
238+
"name": "Create Task With OCI Image",
91239
"event": [
92240
{
93241
"listen": "test",
@@ -122,7 +270,7 @@
122270
"header": [],
123271
"body": {
124272
"mode": "raw",
125-
"raw": "{\n \"name\": \"add\",\n \"inputs\": [\n 10,\n 20\n ]\n}",
273+
"raw": "{\n \"name\": \"add\",\n \"image_url\": \"docker.io/mrstevenyaga/add.wasm\",\n \"inputs\": [\n 10,\n 20\n ]\n}",
126274
"options": {
127275
"raw": {
128276
"language": "json"
@@ -188,7 +336,7 @@
188336
"header": [],
189337
"body": {
190338
"mode": "raw",
191-
"raw": "{\n \"name\": \"add\",\n \"inputs\": [\n 10,\n 20\n ]\n}",
339+
"raw": "{\n \"name\": \"main\",\n \"file\": \"AGFzbQEAAAABBwFgAn9/AX8DAgEABwgBBG1haW4AAAoJAQcAIAAgAWoL\",\n \"inputs\": [\n 10,\n 20\n ]\n}",
192340
"options": {
193341
"raw": {
194342
"language": "json"
@@ -444,11 +592,11 @@
444592
"variable": [
445593
{
446594
"key": "MANAGER_BASE_URL",
447-
"value": "http://localhost:8080",
595+
"value": "http://localhost:7070",
448596
"type": "string"
449597
},
450598
{
451-
"key": "WORKER_ID",
599+
"key": "PROPELLER_ID",
452600
"value": ""
453601
},
454602
{

‎docs/developer-guide.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,24 +104,24 @@ Propeller uses [golangci-lint](https://golangci-lint.run/) to lint the code. You
104104
make lint
105105
```
106106

107-
## Magistrala
107+
## SuperMQ
108108

109-
### Starting Magistrala
109+
### Starting SuperMQ
110110

111-
To start Magistrala, use the following:
111+
To start SuperMQ, use the following:
112112

113113
```bash
114-
make start-magistrala
114+
make start-supermq
115115
```
116116

117-
This will in the background run `docker compose -f docker/compose.yaml up -d` which will start the Magistrala services.
117+
This will in the background run `docker compose -f docker/compose.yaml up -d` which will start the SuperMQ services.
118118

119119
You can override the configuration or add some extra parameters to the docker compose configuration.
120120

121-
### Stopping Magistrala
121+
### Stopping SuperMQ
122122

123-
Magistrala can be stopped using the following:
123+
SuperMQ can be stopped using the following:
124124

125125
```bash
126-
make stop-magistrala
126+
make stop-supermq
127127
```

0 commit comments

Comments
 (0)