sbuilder-mcp 0.2.2 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/CHANGELOG.vi.md +28 -0
- package/README.md +11 -4
- package/README.vi.md +11 -4
- package/dist/catalog/api.generated.js +1350 -127
- package/dist/catalog/elements.generated.js +345 -2
- package/dist/core/tree.js +9 -0
- package/dist/domains/site/builder.js +5 -9
- package/dist/domains/site/document.js +34 -2
- package/dist/domains/site/node.js +50 -7
- package/dist/domains/site/readiness-fetch.js +17 -1
- package/dist/domains/site/readiness.js +65 -0
- package/dist/domains/site/review.js +23 -2
- package/dist/domains/site/traps.js +38 -1
- package/dist/install/index.js +40 -0
- package/dist/server.js +7 -1
- package/dist/tools/api.js +15 -1
- package/dist/tools/context.js +18 -1
- package/dist/tools/live.js +169 -15
- package/dist/tools/page.js +29 -17
- package/dist/tools/session.js +35 -10
- package/dist/transport/media.js +26 -5
- package/dist/vision/measure.js +19 -3
- package/dist/vision/shoot.js +39 -0
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export const SWAGGER_SOURCE = {
|
|
2
|
-
"operations":
|
|
3
|
-
"definitions":
|
|
4
|
-
"bodyCarrying":
|
|
2
|
+
"operations": 456,
|
|
3
|
+
"definitions": 99,
|
|
4
|
+
"bodyCarrying": 171,
|
|
5
5
|
"bodyUndescribed": 62,
|
|
6
6
|
"generatedFrom": "server/docs/swagger.json"
|
|
7
7
|
};
|
|
@@ -185,6 +185,66 @@ export const API_OPERATIONS = [
|
|
|
185
185
|
"bodyRef": null,
|
|
186
186
|
"credential": "siteScoped"
|
|
187
187
|
},
|
|
188
|
+
{
|
|
189
|
+
"id": "get:/_wb/account/course-quiz",
|
|
190
|
+
"method": "GET",
|
|
191
|
+
"path": "/_wb/account/course-quiz",
|
|
192
|
+
"tags": [
|
|
193
|
+
"storeaccount"
|
|
194
|
+
],
|
|
195
|
+
"summary": "The test on a lesson, as its student sees it",
|
|
196
|
+
"params": [
|
|
197
|
+
{
|
|
198
|
+
"name": "lessonId",
|
|
199
|
+
"in": "query",
|
|
200
|
+
"required": true,
|
|
201
|
+
"type": "string",
|
|
202
|
+
"description": "Lesson ID"
|
|
203
|
+
}
|
|
204
|
+
],
|
|
205
|
+
"bodyDescribed": false,
|
|
206
|
+
"bodyRef": null,
|
|
207
|
+
"credential": "siteScoped"
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"id": "post:/_wb/account/course-quiz-file",
|
|
211
|
+
"method": "POST",
|
|
212
|
+
"path": "/_wb/account/course-quiz-file",
|
|
213
|
+
"tags": [
|
|
214
|
+
"storeaccount"
|
|
215
|
+
],
|
|
216
|
+
"summary": "Hand in a file for one question",
|
|
217
|
+
"params": [],
|
|
218
|
+
"bodyDescribed": false,
|
|
219
|
+
"bodyRef": null,
|
|
220
|
+
"credential": "siteScoped"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"id": "post:/_wb/account/course-quiz-start",
|
|
224
|
+
"method": "POST",
|
|
225
|
+
"path": "/_wb/account/course-quiz-start",
|
|
226
|
+
"tags": [
|
|
227
|
+
"storeaccount"
|
|
228
|
+
],
|
|
229
|
+
"summary": "Start a sitting",
|
|
230
|
+
"params": [],
|
|
231
|
+
"bodyDescribed": false,
|
|
232
|
+
"bodyRef": null,
|
|
233
|
+
"credential": "siteScoped"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"id": "post:/_wb/account/course-quiz-submit",
|
|
237
|
+
"method": "POST",
|
|
238
|
+
"path": "/_wb/account/course-quiz-submit",
|
|
239
|
+
"tags": [
|
|
240
|
+
"storeaccount"
|
|
241
|
+
],
|
|
242
|
+
"summary": "Submit a sitting",
|
|
243
|
+
"params": [],
|
|
244
|
+
"bodyDescribed": false,
|
|
245
|
+
"bodyRef": null,
|
|
246
|
+
"credential": "siteScoped"
|
|
247
|
+
},
|
|
188
248
|
{
|
|
189
249
|
"id": "get:/_wb/account/courses",
|
|
190
250
|
"method": "GET",
|
|
@@ -237,6 +297,32 @@ export const API_OPERATIONS = [
|
|
|
237
297
|
"bodyRef": null,
|
|
238
298
|
"credential": "siteScoped"
|
|
239
299
|
},
|
|
300
|
+
{
|
|
301
|
+
"id": "get:/_wb/account/instructor",
|
|
302
|
+
"method": "GET",
|
|
303
|
+
"path": "/_wb/account/instructor",
|
|
304
|
+
"tags": [
|
|
305
|
+
"storeaccount"
|
|
306
|
+
],
|
|
307
|
+
"summary": "A shopper's own application to teach, and making one",
|
|
308
|
+
"params": [],
|
|
309
|
+
"bodyDescribed": false,
|
|
310
|
+
"bodyRef": null,
|
|
311
|
+
"credential": "siteScoped"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"id": "post:/_wb/account/instructor",
|
|
315
|
+
"method": "POST",
|
|
316
|
+
"path": "/_wb/account/instructor",
|
|
317
|
+
"tags": [
|
|
318
|
+
"storeaccount"
|
|
319
|
+
],
|
|
320
|
+
"summary": "A shopper's own application to teach, and making one",
|
|
321
|
+
"params": [],
|
|
322
|
+
"bodyDescribed": false,
|
|
323
|
+
"bodyRef": null,
|
|
324
|
+
"credential": "siteScoped"
|
|
325
|
+
},
|
|
240
326
|
{
|
|
241
327
|
"id": "post:/_wb/account/login",
|
|
242
328
|
"method": "POST",
|
|
@@ -518,6 +604,32 @@ export const API_OPERATIONS = [
|
|
|
518
604
|
"bodyRef": null,
|
|
519
605
|
"credential": "siteScoped"
|
|
520
606
|
},
|
|
607
|
+
{
|
|
608
|
+
"id": "post:/_wb/checkout/order",
|
|
609
|
+
"method": "POST",
|
|
610
|
+
"path": "/_wb/checkout/order",
|
|
611
|
+
"tags": [
|
|
612
|
+
"storecheckout"
|
|
613
|
+
],
|
|
614
|
+
"summary": "Look up an order as a guest",
|
|
615
|
+
"params": [],
|
|
616
|
+
"bodyDescribed": false,
|
|
617
|
+
"bodyRef": null,
|
|
618
|
+
"credential": "siteScoped"
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"id": "post:/_wb/checkout/quote",
|
|
622
|
+
"method": "POST",
|
|
623
|
+
"path": "/_wb/checkout/quote",
|
|
624
|
+
"tags": [
|
|
625
|
+
"storecheckout"
|
|
626
|
+
],
|
|
627
|
+
"summary": "Price a basket",
|
|
628
|
+
"params": [],
|
|
629
|
+
"bodyDescribed": false,
|
|
630
|
+
"bodyRef": null,
|
|
631
|
+
"credential": "siteScoped"
|
|
632
|
+
},
|
|
521
633
|
{
|
|
522
634
|
"id": "get:/_wb/course-outline",
|
|
523
635
|
"method": "GET",
|
|
@@ -1160,6 +1272,32 @@ export const API_OPERATIONS = [
|
|
|
1160
1272
|
"bodyRef": null,
|
|
1161
1273
|
"credential": "siteScoped"
|
|
1162
1274
|
},
|
|
1275
|
+
{
|
|
1276
|
+
"id": "get:/api/admin/translation-keys",
|
|
1277
|
+
"method": "GET",
|
|
1278
|
+
"path": "/api/admin/translation-keys",
|
|
1279
|
+
"tags": [
|
|
1280
|
+
"admin"
|
|
1281
|
+
],
|
|
1282
|
+
"summary": "Manage the platform's machine-translation credentials",
|
|
1283
|
+
"params": [],
|
|
1284
|
+
"bodyDescribed": false,
|
|
1285
|
+
"bodyRef": null,
|
|
1286
|
+
"credential": "siteScoped"
|
|
1287
|
+
},
|
|
1288
|
+
{
|
|
1289
|
+
"id": "post:/api/admin/translation-keys",
|
|
1290
|
+
"method": "POST",
|
|
1291
|
+
"path": "/api/admin/translation-keys",
|
|
1292
|
+
"tags": [
|
|
1293
|
+
"admin"
|
|
1294
|
+
],
|
|
1295
|
+
"summary": "Manage the platform's machine-translation credentials",
|
|
1296
|
+
"params": [],
|
|
1297
|
+
"bodyDescribed": false,
|
|
1298
|
+
"bodyRef": null,
|
|
1299
|
+
"credential": "siteScoped"
|
|
1300
|
+
},
|
|
1163
1301
|
{
|
|
1164
1302
|
"id": "post:/api/auth/change-password",
|
|
1165
1303
|
"method": "POST",
|
|
@@ -1417,6 +1555,146 @@ export const API_OPERATIONS = [
|
|
|
1417
1555
|
"bodyRef": null,
|
|
1418
1556
|
"credential": "siteScoped"
|
|
1419
1557
|
},
|
|
1558
|
+
{
|
|
1559
|
+
"id": "get:/api/instructor/{siteId}/courses",
|
|
1560
|
+
"method": "GET",
|
|
1561
|
+
"path": "/api/instructor/{siteId}/courses",
|
|
1562
|
+
"tags": [
|
|
1563
|
+
"instructor"
|
|
1564
|
+
],
|
|
1565
|
+
"summary": "The courses this instructor owns, and creating one",
|
|
1566
|
+
"params": [
|
|
1567
|
+
{
|
|
1568
|
+
"name": "siteId",
|
|
1569
|
+
"in": "path",
|
|
1570
|
+
"required": true,
|
|
1571
|
+
"type": "string",
|
|
1572
|
+
"description": "Site ID"
|
|
1573
|
+
}
|
|
1574
|
+
],
|
|
1575
|
+
"bodyDescribed": false,
|
|
1576
|
+
"bodyRef": null,
|
|
1577
|
+
"credential": "siteScoped"
|
|
1578
|
+
},
|
|
1579
|
+
{
|
|
1580
|
+
"id": "post:/api/instructor/{siteId}/courses",
|
|
1581
|
+
"method": "POST",
|
|
1582
|
+
"path": "/api/instructor/{siteId}/courses",
|
|
1583
|
+
"tags": [
|
|
1584
|
+
"instructor"
|
|
1585
|
+
],
|
|
1586
|
+
"summary": "The courses this instructor owns, and creating one",
|
|
1587
|
+
"params": [
|
|
1588
|
+
{
|
|
1589
|
+
"name": "siteId",
|
|
1590
|
+
"in": "path",
|
|
1591
|
+
"required": true,
|
|
1592
|
+
"type": "string",
|
|
1593
|
+
"description": "Site ID"
|
|
1594
|
+
}
|
|
1595
|
+
],
|
|
1596
|
+
"bodyDescribed": false,
|
|
1597
|
+
"bodyRef": null,
|
|
1598
|
+
"credential": "siteScoped"
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"id": "get:/api/instructor/{siteId}/courses/{courseId}",
|
|
1602
|
+
"method": "GET",
|
|
1603
|
+
"path": "/api/instructor/{siteId}/courses/{courseId}",
|
|
1604
|
+
"tags": [
|
|
1605
|
+
"instructor"
|
|
1606
|
+
],
|
|
1607
|
+
"summary": "Read or edit one course this instructor owns",
|
|
1608
|
+
"params": [
|
|
1609
|
+
{
|
|
1610
|
+
"name": "siteId",
|
|
1611
|
+
"in": "path",
|
|
1612
|
+
"required": true,
|
|
1613
|
+
"type": "string",
|
|
1614
|
+
"description": "Site ID"
|
|
1615
|
+
},
|
|
1616
|
+
{
|
|
1617
|
+
"name": "courseId",
|
|
1618
|
+
"in": "path",
|
|
1619
|
+
"required": true,
|
|
1620
|
+
"type": "string",
|
|
1621
|
+
"description": "Course ID"
|
|
1622
|
+
}
|
|
1623
|
+
],
|
|
1624
|
+
"bodyDescribed": false,
|
|
1625
|
+
"bodyRef": null,
|
|
1626
|
+
"credential": "siteScoped"
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"id": "put:/api/instructor/{siteId}/courses/{courseId}",
|
|
1630
|
+
"method": "PUT",
|
|
1631
|
+
"path": "/api/instructor/{siteId}/courses/{courseId}",
|
|
1632
|
+
"tags": [
|
|
1633
|
+
"instructor"
|
|
1634
|
+
],
|
|
1635
|
+
"summary": "Read or edit one course this instructor owns",
|
|
1636
|
+
"params": [
|
|
1637
|
+
{
|
|
1638
|
+
"name": "siteId",
|
|
1639
|
+
"in": "path",
|
|
1640
|
+
"required": true,
|
|
1641
|
+
"type": "string",
|
|
1642
|
+
"description": "Site ID"
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
"name": "courseId",
|
|
1646
|
+
"in": "path",
|
|
1647
|
+
"required": true,
|
|
1648
|
+
"type": "string",
|
|
1649
|
+
"description": "Course ID"
|
|
1650
|
+
}
|
|
1651
|
+
],
|
|
1652
|
+
"bodyDescribed": false,
|
|
1653
|
+
"bodyRef": null,
|
|
1654
|
+
"credential": "siteScoped"
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"id": "post:/api/instructor/{siteId}/login",
|
|
1658
|
+
"method": "POST",
|
|
1659
|
+
"path": "/api/instructor/{siteId}/login",
|
|
1660
|
+
"tags": [
|
|
1661
|
+
"instructor"
|
|
1662
|
+
],
|
|
1663
|
+
"summary": "Sign an instructor in to the authoring API",
|
|
1664
|
+
"params": [
|
|
1665
|
+
{
|
|
1666
|
+
"name": "siteId",
|
|
1667
|
+
"in": "path",
|
|
1668
|
+
"required": true,
|
|
1669
|
+
"type": "string",
|
|
1670
|
+
"description": "Site ID"
|
|
1671
|
+
}
|
|
1672
|
+
],
|
|
1673
|
+
"bodyDescribed": false,
|
|
1674
|
+
"bodyRef": null,
|
|
1675
|
+
"credential": "siteScoped"
|
|
1676
|
+
},
|
|
1677
|
+
{
|
|
1678
|
+
"id": "get:/api/instructor/{siteId}/me",
|
|
1679
|
+
"method": "GET",
|
|
1680
|
+
"path": "/api/instructor/{siteId}/me",
|
|
1681
|
+
"tags": [
|
|
1682
|
+
"instructor"
|
|
1683
|
+
],
|
|
1684
|
+
"summary": "Who the caller is on this store",
|
|
1685
|
+
"params": [
|
|
1686
|
+
{
|
|
1687
|
+
"name": "siteId",
|
|
1688
|
+
"in": "path",
|
|
1689
|
+
"required": true,
|
|
1690
|
+
"type": "string",
|
|
1691
|
+
"description": "Site ID"
|
|
1692
|
+
}
|
|
1693
|
+
],
|
|
1694
|
+
"bodyDescribed": false,
|
|
1695
|
+
"bodyRef": null,
|
|
1696
|
+
"credential": "siteScoped"
|
|
1697
|
+
},
|
|
1420
1698
|
{
|
|
1421
1699
|
"id": "delete:/api/invitations/{id}",
|
|
1422
1700
|
"method": "DELETE",
|
|
@@ -3872,14 +4150,13 @@ export const API_OPERATIONS = [
|
|
|
3872
4150
|
"credential": "siteScoped"
|
|
3873
4151
|
},
|
|
3874
4152
|
{
|
|
3875
|
-
"id": "get:/api/sites/{siteId}/
|
|
4153
|
+
"id": "get:/api/sites/{siteId}/course-instructors",
|
|
3876
4154
|
"method": "GET",
|
|
3877
|
-
"path": "/api/sites/{siteId}/
|
|
4155
|
+
"path": "/api/sites/{siteId}/course-instructors",
|
|
3878
4156
|
"tags": [
|
|
3879
|
-
"courses",
|
|
3880
4157
|
"courses"
|
|
3881
4158
|
],
|
|
3882
|
-
"summary": "
|
|
4159
|
+
"summary": "List or create instructors",
|
|
3883
4160
|
"params": [
|
|
3884
4161
|
{
|
|
3885
4162
|
"name": "siteId",
|
|
@@ -3889,11 +4166,25 @@ export const API_OPERATIONS = [
|
|
|
3889
4166
|
"description": "Site ID"
|
|
3890
4167
|
},
|
|
3891
4168
|
{
|
|
3892
|
-
"name": "
|
|
3893
|
-
"in": "
|
|
3894
|
-
"required":
|
|
4169
|
+
"name": "search",
|
|
4170
|
+
"in": "query",
|
|
4171
|
+
"required": false,
|
|
3895
4172
|
"type": "string",
|
|
3896
|
-
"description": "
|
|
4173
|
+
"description": "Match against name and title"
|
|
4174
|
+
},
|
|
4175
|
+
{
|
|
4176
|
+
"name": "status",
|
|
4177
|
+
"in": "query",
|
|
4178
|
+
"required": false,
|
|
4179
|
+
"type": "string",
|
|
4180
|
+
"description": "active | hidden"
|
|
4181
|
+
},
|
|
4182
|
+
{
|
|
4183
|
+
"name": "linked",
|
|
4184
|
+
"in": "query",
|
|
4185
|
+
"required": false,
|
|
4186
|
+
"type": "string",
|
|
4187
|
+
"description": "true to list only teachers holding a storefront account"
|
|
3897
4188
|
}
|
|
3898
4189
|
],
|
|
3899
4190
|
"bodyDescribed": false,
|
|
@@ -3901,14 +4192,13 @@ export const API_OPERATIONS = [
|
|
|
3901
4192
|
"credential": "siteScoped"
|
|
3902
4193
|
},
|
|
3903
4194
|
{
|
|
3904
|
-
"id": "post:/api/sites/{siteId}/
|
|
4195
|
+
"id": "post:/api/sites/{siteId}/course-instructors",
|
|
3905
4196
|
"method": "POST",
|
|
3906
|
-
"path": "/api/sites/{siteId}/
|
|
4197
|
+
"path": "/api/sites/{siteId}/course-instructors",
|
|
3907
4198
|
"tags": [
|
|
3908
|
-
"courses",
|
|
3909
4199
|
"courses"
|
|
3910
4200
|
],
|
|
3911
|
-
"summary": "
|
|
4201
|
+
"summary": "List or create instructors",
|
|
3912
4202
|
"params": [
|
|
3913
4203
|
{
|
|
3914
4204
|
"name": "siteId",
|
|
@@ -3918,12 +4208,196 @@ export const API_OPERATIONS = [
|
|
|
3918
4208
|
"description": "Site ID"
|
|
3919
4209
|
},
|
|
3920
4210
|
{
|
|
3921
|
-
"name": "
|
|
3922
|
-
"in": "
|
|
3923
|
-
"required":
|
|
4211
|
+
"name": "search",
|
|
4212
|
+
"in": "query",
|
|
4213
|
+
"required": false,
|
|
3924
4214
|
"type": "string",
|
|
3925
|
-
"description": "
|
|
3926
|
-
}
|
|
4215
|
+
"description": "Match against name and title"
|
|
4216
|
+
},
|
|
4217
|
+
{
|
|
4218
|
+
"name": "status",
|
|
4219
|
+
"in": "query",
|
|
4220
|
+
"required": false,
|
|
4221
|
+
"type": "string",
|
|
4222
|
+
"description": "active | hidden"
|
|
4223
|
+
},
|
|
4224
|
+
{
|
|
4225
|
+
"name": "linked",
|
|
4226
|
+
"in": "query",
|
|
4227
|
+
"required": false,
|
|
4228
|
+
"type": "string",
|
|
4229
|
+
"description": "true to list only teachers holding a storefront account"
|
|
4230
|
+
}
|
|
4231
|
+
],
|
|
4232
|
+
"bodyDescribed": false,
|
|
4233
|
+
"bodyRef": null,
|
|
4234
|
+
"credential": "siteScoped"
|
|
4235
|
+
},
|
|
4236
|
+
{
|
|
4237
|
+
"id": "get:/api/sites/{siteId}/course-instructors/{instructorId}",
|
|
4238
|
+
"method": "GET",
|
|
4239
|
+
"path": "/api/sites/{siteId}/course-instructors/{instructorId}",
|
|
4240
|
+
"tags": [
|
|
4241
|
+
"courses"
|
|
4242
|
+
],
|
|
4243
|
+
"summary": "Read, update or delete one instructor",
|
|
4244
|
+
"params": [
|
|
4245
|
+
{
|
|
4246
|
+
"name": "siteId",
|
|
4247
|
+
"in": "path",
|
|
4248
|
+
"required": true,
|
|
4249
|
+
"type": "string",
|
|
4250
|
+
"description": "Site ID"
|
|
4251
|
+
},
|
|
4252
|
+
{
|
|
4253
|
+
"name": "instructorId",
|
|
4254
|
+
"in": "path",
|
|
4255
|
+
"required": true,
|
|
4256
|
+
"type": "string",
|
|
4257
|
+
"description": "Instructor ID"
|
|
4258
|
+
}
|
|
4259
|
+
],
|
|
4260
|
+
"bodyDescribed": false,
|
|
4261
|
+
"bodyRef": null,
|
|
4262
|
+
"credential": "siteScoped"
|
|
4263
|
+
},
|
|
4264
|
+
{
|
|
4265
|
+
"id": "put:/api/sites/{siteId}/course-instructors/{instructorId}",
|
|
4266
|
+
"method": "PUT",
|
|
4267
|
+
"path": "/api/sites/{siteId}/course-instructors/{instructorId}",
|
|
4268
|
+
"tags": [
|
|
4269
|
+
"courses"
|
|
4270
|
+
],
|
|
4271
|
+
"summary": "Read, update or delete one instructor",
|
|
4272
|
+
"params": [
|
|
4273
|
+
{
|
|
4274
|
+
"name": "siteId",
|
|
4275
|
+
"in": "path",
|
|
4276
|
+
"required": true,
|
|
4277
|
+
"type": "string",
|
|
4278
|
+
"description": "Site ID"
|
|
4279
|
+
},
|
|
4280
|
+
{
|
|
4281
|
+
"name": "instructorId",
|
|
4282
|
+
"in": "path",
|
|
4283
|
+
"required": true,
|
|
4284
|
+
"type": "string",
|
|
4285
|
+
"description": "Instructor ID"
|
|
4286
|
+
}
|
|
4287
|
+
],
|
|
4288
|
+
"bodyDescribed": false,
|
|
4289
|
+
"bodyRef": null,
|
|
4290
|
+
"credential": "siteScoped"
|
|
4291
|
+
},
|
|
4292
|
+
{
|
|
4293
|
+
"id": "delete:/api/sites/{siteId}/course-instructors/{instructorId}",
|
|
4294
|
+
"method": "DELETE",
|
|
4295
|
+
"path": "/api/sites/{siteId}/course-instructors/{instructorId}",
|
|
4296
|
+
"tags": [
|
|
4297
|
+
"courses"
|
|
4298
|
+
],
|
|
4299
|
+
"summary": "Read, update or delete one instructor",
|
|
4300
|
+
"params": [
|
|
4301
|
+
{
|
|
4302
|
+
"name": "siteId",
|
|
4303
|
+
"in": "path",
|
|
4304
|
+
"required": true,
|
|
4305
|
+
"type": "string",
|
|
4306
|
+
"description": "Site ID"
|
|
4307
|
+
},
|
|
4308
|
+
{
|
|
4309
|
+
"name": "instructorId",
|
|
4310
|
+
"in": "path",
|
|
4311
|
+
"required": true,
|
|
4312
|
+
"type": "string",
|
|
4313
|
+
"description": "Instructor ID"
|
|
4314
|
+
}
|
|
4315
|
+
],
|
|
4316
|
+
"bodyDescribed": false,
|
|
4317
|
+
"bodyRef": null,
|
|
4318
|
+
"credential": "siteScoped"
|
|
4319
|
+
},
|
|
4320
|
+
{
|
|
4321
|
+
"id": "post:/api/sites/{siteId}/course-instructors/{instructorId}/review",
|
|
4322
|
+
"method": "POST",
|
|
4323
|
+
"path": "/api/sites/{siteId}/course-instructors/{instructorId}/review",
|
|
4324
|
+
"tags": [
|
|
4325
|
+
"courses"
|
|
4326
|
+
],
|
|
4327
|
+
"summary": "Answer an instructor's application",
|
|
4328
|
+
"params": [
|
|
4329
|
+
{
|
|
4330
|
+
"name": "siteId",
|
|
4331
|
+
"in": "path",
|
|
4332
|
+
"required": true,
|
|
4333
|
+
"type": "string",
|
|
4334
|
+
"description": "Site ID"
|
|
4335
|
+
},
|
|
4336
|
+
{
|
|
4337
|
+
"name": "instructorId",
|
|
4338
|
+
"in": "path",
|
|
4339
|
+
"required": true,
|
|
4340
|
+
"type": "string",
|
|
4341
|
+
"description": "Instructor ID"
|
|
4342
|
+
}
|
|
4343
|
+
],
|
|
4344
|
+
"bodyDescribed": false,
|
|
4345
|
+
"bodyRef": null,
|
|
4346
|
+
"credential": "siteScoped"
|
|
4347
|
+
},
|
|
4348
|
+
{
|
|
4349
|
+
"id": "get:/api/sites/{siteId}/courses",
|
|
4350
|
+
"method": "GET",
|
|
4351
|
+
"path": "/api/sites/{siteId}/courses",
|
|
4352
|
+
"tags": [
|
|
4353
|
+
"courses",
|
|
4354
|
+
"courses"
|
|
4355
|
+
],
|
|
4356
|
+
"summary": "The app dashboard's counts",
|
|
4357
|
+
"params": [
|
|
4358
|
+
{
|
|
4359
|
+
"name": "siteId",
|
|
4360
|
+
"in": "path",
|
|
4361
|
+
"required": true,
|
|
4362
|
+
"type": "string",
|
|
4363
|
+
"description": "Site ID"
|
|
4364
|
+
},
|
|
4365
|
+
{
|
|
4366
|
+
"name": "siteId",
|
|
4367
|
+
"in": "path",
|
|
4368
|
+
"required": true,
|
|
4369
|
+
"type": "string",
|
|
4370
|
+
"description": "Site ID"
|
|
4371
|
+
}
|
|
4372
|
+
],
|
|
4373
|
+
"bodyDescribed": false,
|
|
4374
|
+
"bodyRef": null,
|
|
4375
|
+
"credential": "siteScoped"
|
|
4376
|
+
},
|
|
4377
|
+
{
|
|
4378
|
+
"id": "post:/api/sites/{siteId}/courses",
|
|
4379
|
+
"method": "POST",
|
|
4380
|
+
"path": "/api/sites/{siteId}/courses",
|
|
4381
|
+
"tags": [
|
|
4382
|
+
"courses",
|
|
4383
|
+
"courses"
|
|
4384
|
+
],
|
|
4385
|
+
"summary": "The app dashboard's counts",
|
|
4386
|
+
"params": [
|
|
4387
|
+
{
|
|
4388
|
+
"name": "siteId",
|
|
4389
|
+
"in": "path",
|
|
4390
|
+
"required": true,
|
|
4391
|
+
"type": "string",
|
|
4392
|
+
"description": "Site ID"
|
|
4393
|
+
},
|
|
4394
|
+
{
|
|
4395
|
+
"name": "siteId",
|
|
4396
|
+
"in": "path",
|
|
4397
|
+
"required": true,
|
|
4398
|
+
"type": "string",
|
|
4399
|
+
"description": "Site ID"
|
|
4400
|
+
}
|
|
3927
4401
|
],
|
|
3928
4402
|
"bodyDescribed": false,
|
|
3929
4403
|
"bodyRef": null,
|
|
@@ -4098,6 +4572,62 @@ export const API_OPERATIONS = [
|
|
|
4098
4572
|
"bodyRef": null,
|
|
4099
4573
|
"credential": "siteScoped"
|
|
4100
4574
|
},
|
|
4575
|
+
{
|
|
4576
|
+
"id": "get:/api/sites/{siteId}/courses/{courseId}/instructors",
|
|
4577
|
+
"method": "GET",
|
|
4578
|
+
"path": "/api/sites/{siteId}/courses/{courseId}/instructors",
|
|
4579
|
+
"tags": [
|
|
4580
|
+
"courses"
|
|
4581
|
+
],
|
|
4582
|
+
"summary": "Read or replace a course's instructors",
|
|
4583
|
+
"params": [
|
|
4584
|
+
{
|
|
4585
|
+
"name": "siteId",
|
|
4586
|
+
"in": "path",
|
|
4587
|
+
"required": true,
|
|
4588
|
+
"type": "string",
|
|
4589
|
+
"description": "Site ID"
|
|
4590
|
+
},
|
|
4591
|
+
{
|
|
4592
|
+
"name": "courseId",
|
|
4593
|
+
"in": "path",
|
|
4594
|
+
"required": true,
|
|
4595
|
+
"type": "string",
|
|
4596
|
+
"description": "Course ID"
|
|
4597
|
+
}
|
|
4598
|
+
],
|
|
4599
|
+
"bodyDescribed": false,
|
|
4600
|
+
"bodyRef": null,
|
|
4601
|
+
"credential": "siteScoped"
|
|
4602
|
+
},
|
|
4603
|
+
{
|
|
4604
|
+
"id": "put:/api/sites/{siteId}/courses/{courseId}/instructors",
|
|
4605
|
+
"method": "PUT",
|
|
4606
|
+
"path": "/api/sites/{siteId}/courses/{courseId}/instructors",
|
|
4607
|
+
"tags": [
|
|
4608
|
+
"courses"
|
|
4609
|
+
],
|
|
4610
|
+
"summary": "Read or replace a course's instructors",
|
|
4611
|
+
"params": [
|
|
4612
|
+
{
|
|
4613
|
+
"name": "siteId",
|
|
4614
|
+
"in": "path",
|
|
4615
|
+
"required": true,
|
|
4616
|
+
"type": "string",
|
|
4617
|
+
"description": "Site ID"
|
|
4618
|
+
},
|
|
4619
|
+
{
|
|
4620
|
+
"name": "courseId",
|
|
4621
|
+
"in": "path",
|
|
4622
|
+
"required": true,
|
|
4623
|
+
"type": "string",
|
|
4624
|
+
"description": "Course ID"
|
|
4625
|
+
}
|
|
4626
|
+
],
|
|
4627
|
+
"bodyDescribed": false,
|
|
4628
|
+
"bodyRef": null,
|
|
4629
|
+
"credential": "siteScoped"
|
|
4630
|
+
},
|
|
4101
4631
|
{
|
|
4102
4632
|
"id": "get:/api/sites/{siteId}/courses/{courseId}/products",
|
|
4103
4633
|
"method": "GET",
|
|
@@ -6304,13 +6834,13 @@ export const API_OPERATIONS = [
|
|
|
6304
6834
|
"credential": "siteScoped"
|
|
6305
6835
|
},
|
|
6306
6836
|
{
|
|
6307
|
-
"id": "get:/api/sites/{siteId}/
|
|
6837
|
+
"id": "get:/api/sites/{siteId}/inventory",
|
|
6308
6838
|
"method": "GET",
|
|
6309
|
-
"path": "/api/sites/{siteId}/
|
|
6839
|
+
"path": "/api/sites/{siteId}/inventory",
|
|
6310
6840
|
"tags": [
|
|
6311
|
-
"
|
|
6841
|
+
"products"
|
|
6312
6842
|
],
|
|
6313
|
-
"summary": "
|
|
6843
|
+
"summary": "List variant stock levels",
|
|
6314
6844
|
"params": [
|
|
6315
6845
|
{
|
|
6316
6846
|
"name": "siteId",
|
|
@@ -6318,6 +6848,27 @@ export const API_OPERATIONS = [
|
|
|
6318
6848
|
"required": true,
|
|
6319
6849
|
"type": "string",
|
|
6320
6850
|
"description": "Site ID"
|
|
6851
|
+
},
|
|
6852
|
+
{
|
|
6853
|
+
"name": "search",
|
|
6854
|
+
"in": "query",
|
|
6855
|
+
"required": false,
|
|
6856
|
+
"type": "string",
|
|
6857
|
+
"description": "Product name, variant SKU or barcode"
|
|
6858
|
+
},
|
|
6859
|
+
{
|
|
6860
|
+
"name": "low",
|
|
6861
|
+
"in": "query",
|
|
6862
|
+
"required": false,
|
|
6863
|
+
"type": "boolean",
|
|
6864
|
+
"description": "Only variants at or below the threshold"
|
|
6865
|
+
},
|
|
6866
|
+
{
|
|
6867
|
+
"name": "lowAtOrBelow",
|
|
6868
|
+
"in": "query",
|
|
6869
|
+
"required": false,
|
|
6870
|
+
"type": "integer",
|
|
6871
|
+
"description": "The threshold; 0 means only what has run out"
|
|
6321
6872
|
}
|
|
6322
6873
|
],
|
|
6323
6874
|
"bodyDescribed": false,
|
|
@@ -6325,13 +6876,13 @@ export const API_OPERATIONS = [
|
|
|
6325
6876
|
"credential": "siteScoped"
|
|
6326
6877
|
},
|
|
6327
6878
|
{
|
|
6328
|
-
"id": "
|
|
6329
|
-
"method": "
|
|
6330
|
-
"path": "/api/sites/{siteId}/
|
|
6879
|
+
"id": "post:/api/sites/{siteId}/inventory/adjust",
|
|
6880
|
+
"method": "POST",
|
|
6881
|
+
"path": "/api/sites/{siteId}/inventory/adjust",
|
|
6331
6882
|
"tags": [
|
|
6332
|
-
"
|
|
6883
|
+
"products"
|
|
6333
6884
|
],
|
|
6334
|
-
"summary": "
|
|
6885
|
+
"summary": "Adjust a variant's stock",
|
|
6335
6886
|
"params": [
|
|
6336
6887
|
{
|
|
6337
6888
|
"name": "siteId",
|
|
@@ -6346,13 +6897,13 @@ export const API_OPERATIONS = [
|
|
|
6346
6897
|
"credential": "siteScoped"
|
|
6347
6898
|
},
|
|
6348
6899
|
{
|
|
6349
|
-
"id": "get:/api/sites/{siteId}/
|
|
6900
|
+
"id": "get:/api/sites/{siteId}/inventory/history",
|
|
6350
6901
|
"method": "GET",
|
|
6351
|
-
"path": "/api/sites/{siteId}/
|
|
6902
|
+
"path": "/api/sites/{siteId}/inventory/history",
|
|
6352
6903
|
"tags": [
|
|
6353
|
-
"
|
|
6904
|
+
"products"
|
|
6354
6905
|
],
|
|
6355
|
-
"summary": "
|
|
6906
|
+
"summary": "Stock movements",
|
|
6356
6907
|
"params": [
|
|
6357
6908
|
{
|
|
6358
6909
|
"name": "siteId",
|
|
@@ -6362,15 +6913,92 @@ export const API_OPERATIONS = [
|
|
|
6362
6913
|
"description": "Site ID"
|
|
6363
6914
|
},
|
|
6364
6915
|
{
|
|
6365
|
-
"name": "
|
|
6366
|
-
"in": "
|
|
6367
|
-
"required":
|
|
6916
|
+
"name": "productId",
|
|
6917
|
+
"in": "query",
|
|
6918
|
+
"required": false,
|
|
6368
6919
|
"type": "string",
|
|
6369
|
-
"description": "
|
|
6370
|
-
}
|
|
6371
|
-
|
|
6372
|
-
|
|
6373
|
-
|
|
6920
|
+
"description": "Narrow to one product"
|
|
6921
|
+
},
|
|
6922
|
+
{
|
|
6923
|
+
"name": "variantId",
|
|
6924
|
+
"in": "query",
|
|
6925
|
+
"required": false,
|
|
6926
|
+
"type": "string",
|
|
6927
|
+
"description": "Narrow to one variant"
|
|
6928
|
+
}
|
|
6929
|
+
],
|
|
6930
|
+
"bodyDescribed": false,
|
|
6931
|
+
"bodyRef": null,
|
|
6932
|
+
"credential": "siteScoped"
|
|
6933
|
+
},
|
|
6934
|
+
{
|
|
6935
|
+
"id": "get:/api/sites/{siteId}/loyalty",
|
|
6936
|
+
"method": "GET",
|
|
6937
|
+
"path": "/api/sites/{siteId}/loyalty",
|
|
6938
|
+
"tags": [
|
|
6939
|
+
"loyalty"
|
|
6940
|
+
],
|
|
6941
|
+
"summary": "Read or save the site's points policy",
|
|
6942
|
+
"params": [
|
|
6943
|
+
{
|
|
6944
|
+
"name": "siteId",
|
|
6945
|
+
"in": "path",
|
|
6946
|
+
"required": true,
|
|
6947
|
+
"type": "string",
|
|
6948
|
+
"description": "Site ID"
|
|
6949
|
+
}
|
|
6950
|
+
],
|
|
6951
|
+
"bodyDescribed": false,
|
|
6952
|
+
"bodyRef": null,
|
|
6953
|
+
"credential": "siteScoped"
|
|
6954
|
+
},
|
|
6955
|
+
{
|
|
6956
|
+
"id": "put:/api/sites/{siteId}/loyalty",
|
|
6957
|
+
"method": "PUT",
|
|
6958
|
+
"path": "/api/sites/{siteId}/loyalty",
|
|
6959
|
+
"tags": [
|
|
6960
|
+
"loyalty"
|
|
6961
|
+
],
|
|
6962
|
+
"summary": "Read or save the site's points policy",
|
|
6963
|
+
"params": [
|
|
6964
|
+
{
|
|
6965
|
+
"name": "siteId",
|
|
6966
|
+
"in": "path",
|
|
6967
|
+
"required": true,
|
|
6968
|
+
"type": "string",
|
|
6969
|
+
"description": "Site ID"
|
|
6970
|
+
}
|
|
6971
|
+
],
|
|
6972
|
+
"bodyDescribed": false,
|
|
6973
|
+
"bodyRef": null,
|
|
6974
|
+
"credential": "siteScoped"
|
|
6975
|
+
},
|
|
6976
|
+
{
|
|
6977
|
+
"id": "get:/api/sites/{siteId}/loyalty/{customerId}",
|
|
6978
|
+
"method": "GET",
|
|
6979
|
+
"path": "/api/sites/{siteId}/loyalty/{customerId}",
|
|
6980
|
+
"tags": [
|
|
6981
|
+
"loyalty"
|
|
6982
|
+
],
|
|
6983
|
+
"summary": "A customer's points balance and ledger",
|
|
6984
|
+
"params": [
|
|
6985
|
+
{
|
|
6986
|
+
"name": "siteId",
|
|
6987
|
+
"in": "path",
|
|
6988
|
+
"required": true,
|
|
6989
|
+
"type": "string",
|
|
6990
|
+
"description": "Site ID"
|
|
6991
|
+
},
|
|
6992
|
+
{
|
|
6993
|
+
"name": "customerId",
|
|
6994
|
+
"in": "path",
|
|
6995
|
+
"required": true,
|
|
6996
|
+
"type": "string",
|
|
6997
|
+
"description": "Customer ID"
|
|
6998
|
+
}
|
|
6999
|
+
],
|
|
7000
|
+
"bodyDescribed": false,
|
|
7001
|
+
"bodyRef": null,
|
|
6374
7002
|
"credential": "siteScoped"
|
|
6375
7003
|
},
|
|
6376
7004
|
{
|
|
@@ -8091,6 +8719,111 @@ export const API_OPERATIONS = [
|
|
|
8091
8719
|
"bodyRef": null,
|
|
8092
8720
|
"credential": "siteScoped"
|
|
8093
8721
|
},
|
|
8722
|
+
{
|
|
8723
|
+
"id": "get:/api/sites/{siteId}/payment-gateways/{provider}",
|
|
8724
|
+
"method": "GET",
|
|
8725
|
+
"path": "/api/sites/{siteId}/payment-gateways/{provider}",
|
|
8726
|
+
"tags": [
|
|
8727
|
+
"payments"
|
|
8728
|
+
],
|
|
8729
|
+
"summary": "Read, save or clear one payment gateway's configuration",
|
|
8730
|
+
"params": [
|
|
8731
|
+
{
|
|
8732
|
+
"name": "siteId",
|
|
8733
|
+
"in": "path",
|
|
8734
|
+
"required": true,
|
|
8735
|
+
"type": "string",
|
|
8736
|
+
"description": "Site ID"
|
|
8737
|
+
},
|
|
8738
|
+
{
|
|
8739
|
+
"name": "provider",
|
|
8740
|
+
"in": "path",
|
|
8741
|
+
"required": true,
|
|
8742
|
+
"type": "string",
|
|
8743
|
+
"description": "Gateway provider key, e.g. stripe, vnpay, momo, payos, sepay, zalopay, paypal"
|
|
8744
|
+
},
|
|
8745
|
+
{
|
|
8746
|
+
"name": "body",
|
|
8747
|
+
"in": "body",
|
|
8748
|
+
"required": false,
|
|
8749
|
+
"type": "object",
|
|
8750
|
+
"description": "Gateway configuration (PUT only)"
|
|
8751
|
+
}
|
|
8752
|
+
],
|
|
8753
|
+
"bodyDescribed": true,
|
|
8754
|
+
"bodyRef": "github_com_webbuilder_server_internal_payments.GatewayInput",
|
|
8755
|
+
"credential": "siteScoped"
|
|
8756
|
+
},
|
|
8757
|
+
{
|
|
8758
|
+
"id": "put:/api/sites/{siteId}/payment-gateways/{provider}",
|
|
8759
|
+
"method": "PUT",
|
|
8760
|
+
"path": "/api/sites/{siteId}/payment-gateways/{provider}",
|
|
8761
|
+
"tags": [
|
|
8762
|
+
"payments"
|
|
8763
|
+
],
|
|
8764
|
+
"summary": "Read, save or clear one payment gateway's configuration",
|
|
8765
|
+
"params": [
|
|
8766
|
+
{
|
|
8767
|
+
"name": "siteId",
|
|
8768
|
+
"in": "path",
|
|
8769
|
+
"required": true,
|
|
8770
|
+
"type": "string",
|
|
8771
|
+
"description": "Site ID"
|
|
8772
|
+
},
|
|
8773
|
+
{
|
|
8774
|
+
"name": "provider",
|
|
8775
|
+
"in": "path",
|
|
8776
|
+
"required": true,
|
|
8777
|
+
"type": "string",
|
|
8778
|
+
"description": "Gateway provider key, e.g. stripe, vnpay, momo, payos, sepay, zalopay, paypal"
|
|
8779
|
+
},
|
|
8780
|
+
{
|
|
8781
|
+
"name": "body",
|
|
8782
|
+
"in": "body",
|
|
8783
|
+
"required": false,
|
|
8784
|
+
"type": "object",
|
|
8785
|
+
"description": "Gateway configuration (PUT only)"
|
|
8786
|
+
}
|
|
8787
|
+
],
|
|
8788
|
+
"bodyDescribed": true,
|
|
8789
|
+
"bodyRef": "github_com_webbuilder_server_internal_payments.GatewayInput",
|
|
8790
|
+
"credential": "siteScoped"
|
|
8791
|
+
},
|
|
8792
|
+
{
|
|
8793
|
+
"id": "delete:/api/sites/{siteId}/payment-gateways/{provider}",
|
|
8794
|
+
"method": "DELETE",
|
|
8795
|
+
"path": "/api/sites/{siteId}/payment-gateways/{provider}",
|
|
8796
|
+
"tags": [
|
|
8797
|
+
"payments"
|
|
8798
|
+
],
|
|
8799
|
+
"summary": "Read, save or clear one payment gateway's configuration",
|
|
8800
|
+
"params": [
|
|
8801
|
+
{
|
|
8802
|
+
"name": "siteId",
|
|
8803
|
+
"in": "path",
|
|
8804
|
+
"required": true,
|
|
8805
|
+
"type": "string",
|
|
8806
|
+
"description": "Site ID"
|
|
8807
|
+
},
|
|
8808
|
+
{
|
|
8809
|
+
"name": "provider",
|
|
8810
|
+
"in": "path",
|
|
8811
|
+
"required": true,
|
|
8812
|
+
"type": "string",
|
|
8813
|
+
"description": "Gateway provider key, e.g. stripe, vnpay, momo, payos, sepay, zalopay, paypal"
|
|
8814
|
+
},
|
|
8815
|
+
{
|
|
8816
|
+
"name": "body",
|
|
8817
|
+
"in": "body",
|
|
8818
|
+
"required": false,
|
|
8819
|
+
"type": "object",
|
|
8820
|
+
"description": "Gateway configuration (PUT only)"
|
|
8821
|
+
}
|
|
8822
|
+
],
|
|
8823
|
+
"bodyDescribed": true,
|
|
8824
|
+
"bodyRef": "github_com_webbuilder_server_internal_payments.GatewayInput",
|
|
8825
|
+
"credential": "siteScoped"
|
|
8826
|
+
},
|
|
8094
8827
|
{
|
|
8095
8828
|
"id": "get:/api/sites/{siteId}/payment-transactions",
|
|
8096
8829
|
"method": "GET",
|
|
@@ -8660,11 +9393,333 @@ export const API_OPERATIONS = [
|
|
|
8660
9393
|
"description": "Site ID"
|
|
8661
9394
|
},
|
|
8662
9395
|
{
|
|
8663
|
-
"name": "file",
|
|
8664
|
-
"in": "formData",
|
|
8665
|
-
"required": true,
|
|
8666
|
-
"type": "file",
|
|
8667
|
-
"description": "xlsx workbook (see the import template)"
|
|
9396
|
+
"name": "file",
|
|
9397
|
+
"in": "formData",
|
|
9398
|
+
"required": true,
|
|
9399
|
+
"type": "file",
|
|
9400
|
+
"description": "xlsx workbook (see the import template)"
|
|
9401
|
+
}
|
|
9402
|
+
],
|
|
9403
|
+
"bodyDescribed": false,
|
|
9404
|
+
"bodyRef": null,
|
|
9405
|
+
"credential": "siteScoped"
|
|
9406
|
+
},
|
|
9407
|
+
{
|
|
9408
|
+
"id": "get:/api/sites/{siteId}/products/import-template",
|
|
9409
|
+
"method": "GET",
|
|
9410
|
+
"path": "/api/sites/{siteId}/products/import-template",
|
|
9411
|
+
"tags": [
|
|
9412
|
+
"products"
|
|
9413
|
+
],
|
|
9414
|
+
"summary": "Download the product bulk-import Excel template",
|
|
9415
|
+
"params": [
|
|
9416
|
+
{
|
|
9417
|
+
"name": "siteId",
|
|
9418
|
+
"in": "path",
|
|
9419
|
+
"required": true,
|
|
9420
|
+
"type": "string",
|
|
9421
|
+
"description": "Site ID"
|
|
9422
|
+
}
|
|
9423
|
+
],
|
|
9424
|
+
"bodyDescribed": false,
|
|
9425
|
+
"bodyRef": null,
|
|
9426
|
+
"credential": "siteScoped"
|
|
9427
|
+
},
|
|
9428
|
+
{
|
|
9429
|
+
"id": "get:/api/sites/{siteId}/products/{id}",
|
|
9430
|
+
"method": "GET",
|
|
9431
|
+
"path": "/api/sites/{siteId}/products/{id}",
|
|
9432
|
+
"tags": [
|
|
9433
|
+
"products"
|
|
9434
|
+
],
|
|
9435
|
+
"summary": "Get, update or delete a product",
|
|
9436
|
+
"params": [
|
|
9437
|
+
{
|
|
9438
|
+
"name": "siteId",
|
|
9439
|
+
"in": "path",
|
|
9440
|
+
"required": true,
|
|
9441
|
+
"type": "string",
|
|
9442
|
+
"description": "Site ID"
|
|
9443
|
+
},
|
|
9444
|
+
{
|
|
9445
|
+
"name": "id",
|
|
9446
|
+
"in": "path",
|
|
9447
|
+
"required": true,
|
|
9448
|
+
"type": "string",
|
|
9449
|
+
"description": "Product ID"
|
|
9450
|
+
},
|
|
9451
|
+
{
|
|
9452
|
+
"name": "product",
|
|
9453
|
+
"in": "body",
|
|
9454
|
+
"required": false,
|
|
9455
|
+
"type": "object",
|
|
9456
|
+
"description": "Updated product (PUT only)"
|
|
9457
|
+
}
|
|
9458
|
+
],
|
|
9459
|
+
"bodyDescribed": true,
|
|
9460
|
+
"bodyRef": "github_com_webbuilder_server_internal_products.Product",
|
|
9461
|
+
"credential": "siteScoped"
|
|
9462
|
+
},
|
|
9463
|
+
{
|
|
9464
|
+
"id": "put:/api/sites/{siteId}/products/{id}",
|
|
9465
|
+
"method": "PUT",
|
|
9466
|
+
"path": "/api/sites/{siteId}/products/{id}",
|
|
9467
|
+
"tags": [
|
|
9468
|
+
"products"
|
|
9469
|
+
],
|
|
9470
|
+
"summary": "Get, update or delete a product",
|
|
9471
|
+
"params": [
|
|
9472
|
+
{
|
|
9473
|
+
"name": "siteId",
|
|
9474
|
+
"in": "path",
|
|
9475
|
+
"required": true,
|
|
9476
|
+
"type": "string",
|
|
9477
|
+
"description": "Site ID"
|
|
9478
|
+
},
|
|
9479
|
+
{
|
|
9480
|
+
"name": "id",
|
|
9481
|
+
"in": "path",
|
|
9482
|
+
"required": true,
|
|
9483
|
+
"type": "string",
|
|
9484
|
+
"description": "Product ID"
|
|
9485
|
+
},
|
|
9486
|
+
{
|
|
9487
|
+
"name": "product",
|
|
9488
|
+
"in": "body",
|
|
9489
|
+
"required": false,
|
|
9490
|
+
"type": "object",
|
|
9491
|
+
"description": "Updated product (PUT only)"
|
|
9492
|
+
}
|
|
9493
|
+
],
|
|
9494
|
+
"bodyDescribed": true,
|
|
9495
|
+
"bodyRef": "github_com_webbuilder_server_internal_products.Product",
|
|
9496
|
+
"credential": "siteScoped"
|
|
9497
|
+
},
|
|
9498
|
+
{
|
|
9499
|
+
"id": "delete:/api/sites/{siteId}/products/{id}",
|
|
9500
|
+
"method": "DELETE",
|
|
9501
|
+
"path": "/api/sites/{siteId}/products/{id}",
|
|
9502
|
+
"tags": [
|
|
9503
|
+
"products"
|
|
9504
|
+
],
|
|
9505
|
+
"summary": "Get, update or delete a product",
|
|
9506
|
+
"params": [
|
|
9507
|
+
{
|
|
9508
|
+
"name": "siteId",
|
|
9509
|
+
"in": "path",
|
|
9510
|
+
"required": true,
|
|
9511
|
+
"type": "string",
|
|
9512
|
+
"description": "Site ID"
|
|
9513
|
+
},
|
|
9514
|
+
{
|
|
9515
|
+
"name": "id",
|
|
9516
|
+
"in": "path",
|
|
9517
|
+
"required": true,
|
|
9518
|
+
"type": "string",
|
|
9519
|
+
"description": "Product ID"
|
|
9520
|
+
},
|
|
9521
|
+
{
|
|
9522
|
+
"name": "product",
|
|
9523
|
+
"in": "body",
|
|
9524
|
+
"required": false,
|
|
9525
|
+
"type": "object",
|
|
9526
|
+
"description": "Updated product (PUT only)"
|
|
9527
|
+
}
|
|
9528
|
+
],
|
|
9529
|
+
"bodyDescribed": true,
|
|
9530
|
+
"bodyRef": "github_com_webbuilder_server_internal_products.Product",
|
|
9531
|
+
"credential": "siteScoped"
|
|
9532
|
+
},
|
|
9533
|
+
{
|
|
9534
|
+
"id": "get:/api/sites/{siteId}/products/{productId}/categories",
|
|
9535
|
+
"method": "GET",
|
|
9536
|
+
"path": "/api/sites/{siteId}/products/{productId}/categories",
|
|
9537
|
+
"tags": [
|
|
9538
|
+
"products"
|
|
9539
|
+
],
|
|
9540
|
+
"summary": "Get or set a product's category links",
|
|
9541
|
+
"params": [
|
|
9542
|
+
{
|
|
9543
|
+
"name": "siteId",
|
|
9544
|
+
"in": "path",
|
|
9545
|
+
"required": true,
|
|
9546
|
+
"type": "string",
|
|
9547
|
+
"description": "Site ID"
|
|
9548
|
+
},
|
|
9549
|
+
{
|
|
9550
|
+
"name": "productId",
|
|
9551
|
+
"in": "path",
|
|
9552
|
+
"required": true,
|
|
9553
|
+
"type": "string",
|
|
9554
|
+
"description": "Product ID"
|
|
9555
|
+
},
|
|
9556
|
+
{
|
|
9557
|
+
"name": "body",
|
|
9558
|
+
"in": "body",
|
|
9559
|
+
"required": false,
|
|
9560
|
+
"type": "object",
|
|
9561
|
+
"description": "Category IDs to set (PUT only): {\\"
|
|
9562
|
+
}
|
|
9563
|
+
],
|
|
9564
|
+
"bodyDescribed": false,
|
|
9565
|
+
"bodyRef": null,
|
|
9566
|
+
"credential": "siteScoped"
|
|
9567
|
+
},
|
|
9568
|
+
{
|
|
9569
|
+
"id": "put:/api/sites/{siteId}/products/{productId}/categories",
|
|
9570
|
+
"method": "PUT",
|
|
9571
|
+
"path": "/api/sites/{siteId}/products/{productId}/categories",
|
|
9572
|
+
"tags": [
|
|
9573
|
+
"products"
|
|
9574
|
+
],
|
|
9575
|
+
"summary": "Get or set a product's category links",
|
|
9576
|
+
"params": [
|
|
9577
|
+
{
|
|
9578
|
+
"name": "siteId",
|
|
9579
|
+
"in": "path",
|
|
9580
|
+
"required": true,
|
|
9581
|
+
"type": "string",
|
|
9582
|
+
"description": "Site ID"
|
|
9583
|
+
},
|
|
9584
|
+
{
|
|
9585
|
+
"name": "productId",
|
|
9586
|
+
"in": "path",
|
|
9587
|
+
"required": true,
|
|
9588
|
+
"type": "string",
|
|
9589
|
+
"description": "Product ID"
|
|
9590
|
+
},
|
|
9591
|
+
{
|
|
9592
|
+
"name": "body",
|
|
9593
|
+
"in": "body",
|
|
9594
|
+
"required": false,
|
|
9595
|
+
"type": "object",
|
|
9596
|
+
"description": "Category IDs to set (PUT only): {\\"
|
|
9597
|
+
}
|
|
9598
|
+
],
|
|
9599
|
+
"bodyDescribed": false,
|
|
9600
|
+
"bodyRef": null,
|
|
9601
|
+
"credential": "siteScoped"
|
|
9602
|
+
},
|
|
9603
|
+
{
|
|
9604
|
+
"id": "post:/api/sites/{siteId}/publish",
|
|
9605
|
+
"method": "POST",
|
|
9606
|
+
"path": "/api/sites/{siteId}/publish",
|
|
9607
|
+
"tags": [
|
|
9608
|
+
"pages"
|
|
9609
|
+
],
|
|
9610
|
+
"summary": "Publish a site's pages (mint versions + compile live HTML/CSS)",
|
|
9611
|
+
"params": [
|
|
9612
|
+
{
|
|
9613
|
+
"name": "siteId",
|
|
9614
|
+
"in": "path",
|
|
9615
|
+
"required": true,
|
|
9616
|
+
"type": "string",
|
|
9617
|
+
"description": "Site ID"
|
|
9618
|
+
}
|
|
9619
|
+
],
|
|
9620
|
+
"bodyDescribed": false,
|
|
9621
|
+
"bodyRef": null,
|
|
9622
|
+
"credential": "siteScoped"
|
|
9623
|
+
},
|
|
9624
|
+
{
|
|
9625
|
+
"id": "get:/api/sites/{siteId}/quiz-grading",
|
|
9626
|
+
"method": "GET",
|
|
9627
|
+
"path": "/api/sites/{siteId}/quiz-grading",
|
|
9628
|
+
"tags": [
|
|
9629
|
+
"assessment"
|
|
9630
|
+
],
|
|
9631
|
+
"summary": "The marking queue",
|
|
9632
|
+
"params": [
|
|
9633
|
+
{
|
|
9634
|
+
"name": "siteId",
|
|
9635
|
+
"in": "path",
|
|
9636
|
+
"required": true,
|
|
9637
|
+
"type": "string",
|
|
9638
|
+
"description": "Site ID"
|
|
9639
|
+
},
|
|
9640
|
+
{
|
|
9641
|
+
"name": "courseId",
|
|
9642
|
+
"in": "query",
|
|
9643
|
+
"required": false,
|
|
9644
|
+
"type": "string",
|
|
9645
|
+
"description": "Only this course's papers"
|
|
9646
|
+
},
|
|
9647
|
+
{
|
|
9648
|
+
"name": "quizId",
|
|
9649
|
+
"in": "query",
|
|
9650
|
+
"required": false,
|
|
9651
|
+
"type": "string",
|
|
9652
|
+
"description": "Only this quiz's papers"
|
|
9653
|
+
}
|
|
9654
|
+
],
|
|
9655
|
+
"bodyDescribed": false,
|
|
9656
|
+
"bodyRef": null,
|
|
9657
|
+
"credential": "siteScoped"
|
|
9658
|
+
},
|
|
9659
|
+
{
|
|
9660
|
+
"id": "get:/api/sites/{siteId}/quizzes",
|
|
9661
|
+
"method": "GET",
|
|
9662
|
+
"path": "/api/sites/{siteId}/quizzes",
|
|
9663
|
+
"tags": [
|
|
9664
|
+
"assessment"
|
|
9665
|
+
],
|
|
9666
|
+
"summary": "List or create quizzes",
|
|
9667
|
+
"params": [
|
|
9668
|
+
{
|
|
9669
|
+
"name": "siteId",
|
|
9670
|
+
"in": "path",
|
|
9671
|
+
"required": true,
|
|
9672
|
+
"type": "string",
|
|
9673
|
+
"description": "Site ID"
|
|
9674
|
+
},
|
|
9675
|
+
{
|
|
9676
|
+
"name": "courseId",
|
|
9677
|
+
"in": "query",
|
|
9678
|
+
"required": false,
|
|
9679
|
+
"type": "string",
|
|
9680
|
+
"description": "Only this course's quizzes"
|
|
9681
|
+
},
|
|
9682
|
+
{
|
|
9683
|
+
"name": "lessonId",
|
|
9684
|
+
"in": "query",
|
|
9685
|
+
"required": false,
|
|
9686
|
+
"type": "string",
|
|
9687
|
+
"description": "Only the quiz on this lesson"
|
|
9688
|
+
}
|
|
9689
|
+
],
|
|
9690
|
+
"bodyDescribed": false,
|
|
9691
|
+
"bodyRef": null,
|
|
9692
|
+
"credential": "siteScoped"
|
|
9693
|
+
},
|
|
9694
|
+
{
|
|
9695
|
+
"id": "post:/api/sites/{siteId}/quizzes",
|
|
9696
|
+
"method": "POST",
|
|
9697
|
+
"path": "/api/sites/{siteId}/quizzes",
|
|
9698
|
+
"tags": [
|
|
9699
|
+
"assessment"
|
|
9700
|
+
],
|
|
9701
|
+
"summary": "List or create quizzes",
|
|
9702
|
+
"params": [
|
|
9703
|
+
{
|
|
9704
|
+
"name": "siteId",
|
|
9705
|
+
"in": "path",
|
|
9706
|
+
"required": true,
|
|
9707
|
+
"type": "string",
|
|
9708
|
+
"description": "Site ID"
|
|
9709
|
+
},
|
|
9710
|
+
{
|
|
9711
|
+
"name": "courseId",
|
|
9712
|
+
"in": "query",
|
|
9713
|
+
"required": false,
|
|
9714
|
+
"type": "string",
|
|
9715
|
+
"description": "Only this course's quizzes"
|
|
9716
|
+
},
|
|
9717
|
+
{
|
|
9718
|
+
"name": "lessonId",
|
|
9719
|
+
"in": "query",
|
|
9720
|
+
"required": false,
|
|
9721
|
+
"type": "string",
|
|
9722
|
+
"description": "Only the quiz on this lesson"
|
|
8668
9723
|
}
|
|
8669
9724
|
],
|
|
8670
9725
|
"bodyDescribed": false,
|
|
@@ -8672,13 +9727,13 @@ export const API_OPERATIONS = [
|
|
|
8672
9727
|
"credential": "siteScoped"
|
|
8673
9728
|
},
|
|
8674
9729
|
{
|
|
8675
|
-
"id": "
|
|
8676
|
-
"method": "
|
|
8677
|
-
"path": "/api/sites/{siteId}/
|
|
9730
|
+
"id": "post:/api/sites/{siteId}/quizzes/{attemptId}/grade",
|
|
9731
|
+
"method": "POST",
|
|
9732
|
+
"path": "/api/sites/{siteId}/quizzes/{attemptId}/grade",
|
|
8678
9733
|
"tags": [
|
|
8679
|
-
"
|
|
9734
|
+
"assessment"
|
|
8680
9735
|
],
|
|
8681
|
-
"summary": "
|
|
9736
|
+
"summary": "Mark the written answers on one attempt",
|
|
8682
9737
|
"params": [
|
|
8683
9738
|
{
|
|
8684
9739
|
"name": "siteId",
|
|
@@ -8686,6 +9741,13 @@ export const API_OPERATIONS = [
|
|
|
8686
9741
|
"required": true,
|
|
8687
9742
|
"type": "string",
|
|
8688
9743
|
"description": "Site ID"
|
|
9744
|
+
},
|
|
9745
|
+
{
|
|
9746
|
+
"name": "attemptId",
|
|
9747
|
+
"in": "path",
|
|
9748
|
+
"required": true,
|
|
9749
|
+
"type": "string",
|
|
9750
|
+
"description": "Attempt ID"
|
|
8689
9751
|
}
|
|
8690
9752
|
],
|
|
8691
9753
|
"bodyDescribed": false,
|
|
@@ -8693,13 +9755,13 @@ export const API_OPERATIONS = [
|
|
|
8693
9755
|
"credential": "siteScoped"
|
|
8694
9756
|
},
|
|
8695
9757
|
{
|
|
8696
|
-
"id": "get:/api/sites/{siteId}/
|
|
9758
|
+
"id": "get:/api/sites/{siteId}/quizzes/{quizId}",
|
|
8697
9759
|
"method": "GET",
|
|
8698
|
-
"path": "/api/sites/{siteId}/
|
|
9760
|
+
"path": "/api/sites/{siteId}/quizzes/{quizId}",
|
|
8699
9761
|
"tags": [
|
|
8700
|
-
"
|
|
9762
|
+
"assessment"
|
|
8701
9763
|
],
|
|
8702
|
-
"summary": "
|
|
9764
|
+
"summary": "Read, update or delete one quiz",
|
|
8703
9765
|
"params": [
|
|
8704
9766
|
{
|
|
8705
9767
|
"name": "siteId",
|
|
@@ -8709,32 +9771,25 @@ export const API_OPERATIONS = [
|
|
|
8709
9771
|
"description": "Site ID"
|
|
8710
9772
|
},
|
|
8711
9773
|
{
|
|
8712
|
-
"name": "
|
|
9774
|
+
"name": "quizId",
|
|
8713
9775
|
"in": "path",
|
|
8714
9776
|
"required": true,
|
|
8715
9777
|
"type": "string",
|
|
8716
|
-
"description": "
|
|
8717
|
-
},
|
|
8718
|
-
{
|
|
8719
|
-
"name": "product",
|
|
8720
|
-
"in": "body",
|
|
8721
|
-
"required": false,
|
|
8722
|
-
"type": "object",
|
|
8723
|
-
"description": "Updated product (PUT only)"
|
|
9778
|
+
"description": "Quiz ID"
|
|
8724
9779
|
}
|
|
8725
9780
|
],
|
|
8726
|
-
"bodyDescribed":
|
|
8727
|
-
"bodyRef":
|
|
9781
|
+
"bodyDescribed": false,
|
|
9782
|
+
"bodyRef": null,
|
|
8728
9783
|
"credential": "siteScoped"
|
|
8729
9784
|
},
|
|
8730
9785
|
{
|
|
8731
|
-
"id": "put:/api/sites/{siteId}/
|
|
9786
|
+
"id": "put:/api/sites/{siteId}/quizzes/{quizId}",
|
|
8732
9787
|
"method": "PUT",
|
|
8733
|
-
"path": "/api/sites/{siteId}/
|
|
9788
|
+
"path": "/api/sites/{siteId}/quizzes/{quizId}",
|
|
8734
9789
|
"tags": [
|
|
8735
|
-
"
|
|
9790
|
+
"assessment"
|
|
8736
9791
|
],
|
|
8737
|
-
"summary": "
|
|
9792
|
+
"summary": "Read, update or delete one quiz",
|
|
8738
9793
|
"params": [
|
|
8739
9794
|
{
|
|
8740
9795
|
"name": "siteId",
|
|
@@ -8744,32 +9799,25 @@ export const API_OPERATIONS = [
|
|
|
8744
9799
|
"description": "Site ID"
|
|
8745
9800
|
},
|
|
8746
9801
|
{
|
|
8747
|
-
"name": "
|
|
9802
|
+
"name": "quizId",
|
|
8748
9803
|
"in": "path",
|
|
8749
9804
|
"required": true,
|
|
8750
9805
|
"type": "string",
|
|
8751
|
-
"description": "
|
|
8752
|
-
},
|
|
8753
|
-
{
|
|
8754
|
-
"name": "product",
|
|
8755
|
-
"in": "body",
|
|
8756
|
-
"required": false,
|
|
8757
|
-
"type": "object",
|
|
8758
|
-
"description": "Updated product (PUT only)"
|
|
9806
|
+
"description": "Quiz ID"
|
|
8759
9807
|
}
|
|
8760
9808
|
],
|
|
8761
|
-
"bodyDescribed":
|
|
8762
|
-
"bodyRef":
|
|
9809
|
+
"bodyDescribed": false,
|
|
9810
|
+
"bodyRef": null,
|
|
8763
9811
|
"credential": "siteScoped"
|
|
8764
9812
|
},
|
|
8765
9813
|
{
|
|
8766
|
-
"id": "delete:/api/sites/{siteId}/
|
|
9814
|
+
"id": "delete:/api/sites/{siteId}/quizzes/{quizId}",
|
|
8767
9815
|
"method": "DELETE",
|
|
8768
|
-
"path": "/api/sites/{siteId}/
|
|
9816
|
+
"path": "/api/sites/{siteId}/quizzes/{quizId}",
|
|
8769
9817
|
"tags": [
|
|
8770
|
-
"
|
|
9818
|
+
"assessment"
|
|
8771
9819
|
],
|
|
8772
|
-
"summary": "
|
|
9820
|
+
"summary": "Read, update or delete one quiz",
|
|
8773
9821
|
"params": [
|
|
8774
9822
|
{
|
|
8775
9823
|
"name": "siteId",
|
|
@@ -8779,32 +9827,25 @@ export const API_OPERATIONS = [
|
|
|
8779
9827
|
"description": "Site ID"
|
|
8780
9828
|
},
|
|
8781
9829
|
{
|
|
8782
|
-
"name": "
|
|
9830
|
+
"name": "quizId",
|
|
8783
9831
|
"in": "path",
|
|
8784
9832
|
"required": true,
|
|
8785
9833
|
"type": "string",
|
|
8786
|
-
"description": "
|
|
8787
|
-
},
|
|
8788
|
-
{
|
|
8789
|
-
"name": "product",
|
|
8790
|
-
"in": "body",
|
|
8791
|
-
"required": false,
|
|
8792
|
-
"type": "object",
|
|
8793
|
-
"description": "Updated product (PUT only)"
|
|
9834
|
+
"description": "Quiz ID"
|
|
8794
9835
|
}
|
|
8795
9836
|
],
|
|
8796
|
-
"bodyDescribed":
|
|
8797
|
-
"bodyRef":
|
|
9837
|
+
"bodyDescribed": false,
|
|
9838
|
+
"bodyRef": null,
|
|
8798
9839
|
"credential": "siteScoped"
|
|
8799
9840
|
},
|
|
8800
9841
|
{
|
|
8801
|
-
"id": "get:/api/sites/{siteId}/
|
|
9842
|
+
"id": "get:/api/sites/{siteId}/quizzes/{quizId}/attempts",
|
|
8802
9843
|
"method": "GET",
|
|
8803
|
-
"path": "/api/sites/{siteId}/
|
|
9844
|
+
"path": "/api/sites/{siteId}/quizzes/{quizId}/attempts",
|
|
8804
9845
|
"tags": [
|
|
8805
|
-
"
|
|
9846
|
+
"assessment"
|
|
8806
9847
|
],
|
|
8807
|
-
"summary": "
|
|
9848
|
+
"summary": "A quiz's attempts",
|
|
8808
9849
|
"params": [
|
|
8809
9850
|
{
|
|
8810
9851
|
"name": "siteId",
|
|
@@ -8814,18 +9855,18 @@ export const API_OPERATIONS = [
|
|
|
8814
9855
|
"description": "Site ID"
|
|
8815
9856
|
},
|
|
8816
9857
|
{
|
|
8817
|
-
"name": "
|
|
9858
|
+
"name": "quizId",
|
|
8818
9859
|
"in": "path",
|
|
8819
9860
|
"required": true,
|
|
8820
9861
|
"type": "string",
|
|
8821
|
-
"description": "
|
|
9862
|
+
"description": "Quiz ID"
|
|
8822
9863
|
},
|
|
8823
9864
|
{
|
|
8824
|
-
"name": "
|
|
8825
|
-
"in": "
|
|
9865
|
+
"name": "enrollmentId",
|
|
9866
|
+
"in": "query",
|
|
8826
9867
|
"required": false,
|
|
8827
|
-
"type": "
|
|
8828
|
-
"description": "
|
|
9868
|
+
"type": "string",
|
|
9869
|
+
"description": "One student's history"
|
|
8829
9870
|
}
|
|
8830
9871
|
],
|
|
8831
9872
|
"bodyDescribed": false,
|
|
@@ -8833,13 +9874,13 @@ export const API_OPERATIONS = [
|
|
|
8833
9874
|
"credential": "siteScoped"
|
|
8834
9875
|
},
|
|
8835
9876
|
{
|
|
8836
|
-
"id": "
|
|
8837
|
-
"method": "
|
|
8838
|
-
"path": "/api/sites/{siteId}/
|
|
9877
|
+
"id": "get:/api/sites/{siteId}/quizzes/{quizId}/questions",
|
|
9878
|
+
"method": "GET",
|
|
9879
|
+
"path": "/api/sites/{siteId}/quizzes/{quizId}/questions",
|
|
8839
9880
|
"tags": [
|
|
8840
|
-
"
|
|
9881
|
+
"assessment"
|
|
8841
9882
|
],
|
|
8842
|
-
"summary": "
|
|
9883
|
+
"summary": "Read or replace a quiz's questions",
|
|
8843
9884
|
"params": [
|
|
8844
9885
|
{
|
|
8845
9886
|
"name": "siteId",
|
|
@@ -8849,18 +9890,11 @@ export const API_OPERATIONS = [
|
|
|
8849
9890
|
"description": "Site ID"
|
|
8850
9891
|
},
|
|
8851
9892
|
{
|
|
8852
|
-
"name": "
|
|
9893
|
+
"name": "quizId",
|
|
8853
9894
|
"in": "path",
|
|
8854
9895
|
"required": true,
|
|
8855
9896
|
"type": "string",
|
|
8856
|
-
"description": "
|
|
8857
|
-
},
|
|
8858
|
-
{
|
|
8859
|
-
"name": "body",
|
|
8860
|
-
"in": "body",
|
|
8861
|
-
"required": false,
|
|
8862
|
-
"type": "object",
|
|
8863
|
-
"description": "Category IDs to set (PUT only): {\\"
|
|
9897
|
+
"description": "Quiz ID"
|
|
8864
9898
|
}
|
|
8865
9899
|
],
|
|
8866
9900
|
"bodyDescribed": false,
|
|
@@ -8868,13 +9902,13 @@ export const API_OPERATIONS = [
|
|
|
8868
9902
|
"credential": "siteScoped"
|
|
8869
9903
|
},
|
|
8870
9904
|
{
|
|
8871
|
-
"id": "
|
|
8872
|
-
"method": "
|
|
8873
|
-
"path": "/api/sites/{siteId}/
|
|
9905
|
+
"id": "put:/api/sites/{siteId}/quizzes/{quizId}/questions",
|
|
9906
|
+
"method": "PUT",
|
|
9907
|
+
"path": "/api/sites/{siteId}/quizzes/{quizId}/questions",
|
|
8874
9908
|
"tags": [
|
|
8875
|
-
"
|
|
9909
|
+
"assessment"
|
|
8876
9910
|
],
|
|
8877
|
-
"summary": "
|
|
9911
|
+
"summary": "Read or replace a quiz's questions",
|
|
8878
9912
|
"params": [
|
|
8879
9913
|
{
|
|
8880
9914
|
"name": "siteId",
|
|
@@ -8882,6 +9916,13 @@ export const API_OPERATIONS = [
|
|
|
8882
9916
|
"required": true,
|
|
8883
9917
|
"type": "string",
|
|
8884
9918
|
"description": "Site ID"
|
|
9919
|
+
},
|
|
9920
|
+
{
|
|
9921
|
+
"name": "quizId",
|
|
9922
|
+
"in": "path",
|
|
9923
|
+
"required": true,
|
|
9924
|
+
"type": "string",
|
|
9925
|
+
"description": "Quiz ID"
|
|
8885
9926
|
}
|
|
8886
9927
|
],
|
|
8887
9928
|
"bodyDescribed": false,
|
|
@@ -9973,6 +11014,104 @@ export const API_OPERATIONS = [
|
|
|
9973
11014
|
"bodyRef": "github_com_webbuilder_server_internal_shipping.Method",
|
|
9974
11015
|
"credential": "siteScoped"
|
|
9975
11016
|
},
|
|
11017
|
+
{
|
|
11018
|
+
"id": "get:/api/sites/{siteId}/shipping-zones",
|
|
11019
|
+
"method": "GET",
|
|
11020
|
+
"path": "/api/sites/{siteId}/shipping-zones",
|
|
11021
|
+
"tags": [
|
|
11022
|
+
"shipping"
|
|
11023
|
+
],
|
|
11024
|
+
"summary": "List or create delivery zones",
|
|
11025
|
+
"params": [
|
|
11026
|
+
{
|
|
11027
|
+
"name": "siteId",
|
|
11028
|
+
"in": "path",
|
|
11029
|
+
"required": true,
|
|
11030
|
+
"type": "string",
|
|
11031
|
+
"description": "Site ID"
|
|
11032
|
+
}
|
|
11033
|
+
],
|
|
11034
|
+
"bodyDescribed": false,
|
|
11035
|
+
"bodyRef": null,
|
|
11036
|
+
"credential": "siteScoped"
|
|
11037
|
+
},
|
|
11038
|
+
{
|
|
11039
|
+
"id": "post:/api/sites/{siteId}/shipping-zones",
|
|
11040
|
+
"method": "POST",
|
|
11041
|
+
"path": "/api/sites/{siteId}/shipping-zones",
|
|
11042
|
+
"tags": [
|
|
11043
|
+
"shipping"
|
|
11044
|
+
],
|
|
11045
|
+
"summary": "List or create delivery zones",
|
|
11046
|
+
"params": [
|
|
11047
|
+
{
|
|
11048
|
+
"name": "siteId",
|
|
11049
|
+
"in": "path",
|
|
11050
|
+
"required": true,
|
|
11051
|
+
"type": "string",
|
|
11052
|
+
"description": "Site ID"
|
|
11053
|
+
}
|
|
11054
|
+
],
|
|
11055
|
+
"bodyDescribed": false,
|
|
11056
|
+
"bodyRef": null,
|
|
11057
|
+
"credential": "siteScoped"
|
|
11058
|
+
},
|
|
11059
|
+
{
|
|
11060
|
+
"id": "put:/api/sites/{siteId}/shipping-zones/{id}",
|
|
11061
|
+
"method": "PUT",
|
|
11062
|
+
"path": "/api/sites/{siteId}/shipping-zones/{id}",
|
|
11063
|
+
"tags": [
|
|
11064
|
+
"shipping"
|
|
11065
|
+
],
|
|
11066
|
+
"summary": "Update or delete a delivery zone",
|
|
11067
|
+
"params": [
|
|
11068
|
+
{
|
|
11069
|
+
"name": "siteId",
|
|
11070
|
+
"in": "path",
|
|
11071
|
+
"required": true,
|
|
11072
|
+
"type": "string",
|
|
11073
|
+
"description": "Site ID"
|
|
11074
|
+
},
|
|
11075
|
+
{
|
|
11076
|
+
"name": "id",
|
|
11077
|
+
"in": "path",
|
|
11078
|
+
"required": true,
|
|
11079
|
+
"type": "string",
|
|
11080
|
+
"description": "Zone ID"
|
|
11081
|
+
}
|
|
11082
|
+
],
|
|
11083
|
+
"bodyDescribed": false,
|
|
11084
|
+
"bodyRef": null,
|
|
11085
|
+
"credential": "siteScoped"
|
|
11086
|
+
},
|
|
11087
|
+
{
|
|
11088
|
+
"id": "delete:/api/sites/{siteId}/shipping-zones/{id}",
|
|
11089
|
+
"method": "DELETE",
|
|
11090
|
+
"path": "/api/sites/{siteId}/shipping-zones/{id}",
|
|
11091
|
+
"tags": [
|
|
11092
|
+
"shipping"
|
|
11093
|
+
],
|
|
11094
|
+
"summary": "Update or delete a delivery zone",
|
|
11095
|
+
"params": [
|
|
11096
|
+
{
|
|
11097
|
+
"name": "siteId",
|
|
11098
|
+
"in": "path",
|
|
11099
|
+
"required": true,
|
|
11100
|
+
"type": "string",
|
|
11101
|
+
"description": "Site ID"
|
|
11102
|
+
},
|
|
11103
|
+
{
|
|
11104
|
+
"name": "id",
|
|
11105
|
+
"in": "path",
|
|
11106
|
+
"required": true,
|
|
11107
|
+
"type": "string",
|
|
11108
|
+
"description": "Zone ID"
|
|
11109
|
+
}
|
|
11110
|
+
],
|
|
11111
|
+
"bodyDescribed": false,
|
|
11112
|
+
"bodyRef": null,
|
|
11113
|
+
"credential": "siteScoped"
|
|
11114
|
+
},
|
|
9976
11115
|
{
|
|
9977
11116
|
"id": "post:/api/sites/{siteId}/template",
|
|
9978
11117
|
"method": "POST",
|
|
@@ -13300,6 +14439,10 @@ export const API_DEFINITIONS = {
|
|
|
13300
14439
|
"shipTo": {
|
|
13301
14440
|
"$ref": "#/definitions/github_com_webbuilder_server_internal_orders.Address"
|
|
13302
14441
|
},
|
|
14442
|
+
"shipToProvinceCode": {
|
|
14443
|
+
"description": "ShipToWardCode is the same key one level down — the ward the parcel is\ngoing to, as the platform's own admin-unit code.\n\nNothing reads it yet. It is stored because the shopper already gave it and\nit cannot be recovered afterwards: a column added when the first reader\narrives would leave every order placed before it permanently unable to\nanswer. See forms.OrderAddress.WardCode.",
|
|
14444
|
+
"type": "string"
|
|
14445
|
+
},
|
|
13303
14446
|
"shippingCents": {
|
|
13304
14447
|
"type": "integer"
|
|
13305
14448
|
},
|
|
@@ -13307,6 +14450,10 @@ export const API_DEFINITIONS = {
|
|
|
13307
14450
|
"description": "ShippingMethod is the delivery option this order was placed under — the\nmerchant-authored NAME, the same string internal/shipping keys a method\nby. It is what ShippingCents was derived FROM on a storefront order, and\nkeeping it on the record is what lets a merchant see why a fee is what it\nis (or why it is zero, when the option no longer exists).\n\nEmpty on every order that names no option, which is every order placed\nbefore this field existed and every merchant-typed order whose\nShippingCents was entered by hand.",
|
|
13308
14451
|
"type": "string"
|
|
13309
14452
|
},
|
|
14453
|
+
"shippingTaxCents": {
|
|
14454
|
+
"description": "ShippingTaxCents is the part of TaxCents that the DELIVERY FEE accounts\nfor, and it is only non-zero on an order whose lines carry more than one\ntax rate. On any other order the shipping is inside the single base\nApplyTax works over and has no separable figure — writing one would be\ninventing a split that was never computed.\n\nIt exists so a mixed order reconciles: without it, Σ(item tax) is short\nof the order's own TaxCents by the delivery's share and nothing on the\nrecord says where the difference went. See orders/taxclass.go.",
|
|
14455
|
+
"type": "integer"
|
|
14456
|
+
},
|
|
13310
14457
|
"siteId": {
|
|
13311
14458
|
"type": "string"
|
|
13312
14459
|
},
|
|
@@ -13380,6 +14527,17 @@ export const API_DEFINITIONS = {
|
|
|
13380
14527
|
"sku": {
|
|
13381
14528
|
"type": "string"
|
|
13382
14529
|
},
|
|
14530
|
+
"taxCents": {
|
|
14531
|
+
"type": "integer"
|
|
14532
|
+
},
|
|
14533
|
+
"taxClassId": {
|
|
14534
|
+
"description": "TaxClassID is the class this line was taxed under, copied from the\nproduct at the moment of sale. Empty means the site's own rate, which is\nevery line in every store that has not defined a class.",
|
|
14535
|
+
"type": "string"
|
|
14536
|
+
},
|
|
14537
|
+
"taxRateBps": {
|
|
14538
|
+
"description": "TaxRateBps and TaxCents are the per-line SNAPSHOT — what this line was\nactually taxed at and for. Server-computed on every write, never read\nfrom a request: a caller-supplied line tax is a caller-chosen invoice.\n\nGrouping items by TaxRateBps is what gives an invoice its \"VAT 10% … VAT\n5% …\" breakdown, which is why there is no separate stored breakdown\ndocument to disagree with them. See orders/taxclass.go.",
|
|
14539
|
+
"type": "integer"
|
|
14540
|
+
},
|
|
13383
14541
|
"totalCents": {
|
|
13384
14542
|
"description": "derived: PriceCents × Quantity",
|
|
13385
14543
|
"type": "integer"
|
|
@@ -13511,6 +14669,26 @@ export const API_DEFINITIONS = {
|
|
|
13511
14669
|
}
|
|
13512
14670
|
}
|
|
13513
14671
|
},
|
|
14672
|
+
"github_com_webbuilder_server_internal_payments.GatewayInput": {
|
|
14673
|
+
"type": "object",
|
|
14674
|
+
"properties": {
|
|
14675
|
+
"credentials": {
|
|
14676
|
+
"type": "object",
|
|
14677
|
+
"additionalProperties": {
|
|
14678
|
+
"type": "string"
|
|
14679
|
+
}
|
|
14680
|
+
},
|
|
14681
|
+
"enabled": {
|
|
14682
|
+
"type": "boolean"
|
|
14683
|
+
},
|
|
14684
|
+
"label": {
|
|
14685
|
+
"type": "string"
|
|
14686
|
+
},
|
|
14687
|
+
"sandbox": {
|
|
14688
|
+
"type": "boolean"
|
|
14689
|
+
}
|
|
14690
|
+
}
|
|
14691
|
+
},
|
|
13514
14692
|
"github_com_webbuilder_server_internal_products.MetaTag": {
|
|
13515
14693
|
"type": "object",
|
|
13516
14694
|
"properties": {
|
|
@@ -13638,6 +14816,10 @@ export const API_DEFINITIONS = {
|
|
|
13638
14816
|
"type": "string"
|
|
13639
14817
|
}
|
|
13640
14818
|
},
|
|
14819
|
+
"taxClassId": {
|
|
14820
|
+
"description": "TaxClassID names which of the site's tax classes this product is sold\nunder — \"\" meaning the site's own rate, which is every product in every\nstore that has not defined a class.\n\nA CLASS ID rather than a rate: the rate belongs to the class, so a\nmerchant changes 5% in one place instead of on every book they sell. The\nclasses live in the site settings document; the order path resolves this\nthrough the orders.TaxClassRates port and SNAPSHOTS the resolved rate onto\nthe order line, so re-rating a class next year cannot re-tax last year's\ninvoices. See internal/orders/taxclass.go.",
|
|
14821
|
+
"type": "string"
|
|
14822
|
+
},
|
|
13641
14823
|
"totalStock": {
|
|
13642
14824
|
"description": "Σ variant Stock values",
|
|
13643
14825
|
"type": "integer"
|
|
@@ -14081,6 +15263,45 @@ export const API_DEFINITIONS = {
|
|
|
14081
15263
|
"siteId": {
|
|
14082
15264
|
"type": "string"
|
|
14083
15265
|
},
|
|
15266
|
+
"updatedAt": {
|
|
15267
|
+
"type": "string"
|
|
15268
|
+
},
|
|
15269
|
+
"zoneFees": {
|
|
15270
|
+
"description": "ZoneFees prices this method PER ZONE, keyed by zone id — the map behind\nFeeForZone. A zone with no entry falls back to FeeCents, so a merchant\nwho prices one method for one zone still has a working checkout for\nevery other combination.\n\nA MAP ON THE ROW rather than a method×zone table, and that is a\nconsidered exception to the normalise-everything rule: these fees are\nnever queried, sorted or aggregated on their own — every read wants them\nalongside the method they belong to — so a join table would buy a query\nnobody makes and cost one on every checkout.",
|
|
15271
|
+
"type": "object",
|
|
15272
|
+
"additionalProperties": {
|
|
15273
|
+
"type": "integer"
|
|
15274
|
+
}
|
|
15275
|
+
}
|
|
15276
|
+
}
|
|
15277
|
+
},
|
|
15278
|
+
"github_com_webbuilder_server_internal_shipping.Zone": {
|
|
15279
|
+
"type": "object",
|
|
15280
|
+
"properties": {
|
|
15281
|
+
"createdAt": {
|
|
15282
|
+
"type": "string"
|
|
15283
|
+
},
|
|
15284
|
+
"id": {
|
|
15285
|
+
"type": "string"
|
|
15286
|
+
},
|
|
15287
|
+
"name": {
|
|
15288
|
+
"description": "Name is what the merchant reads on the settings screen (\"Nội thành Hà\nNội\"). Unique per site, case-insensitively. Never matched against\nanything a shopper sends.",
|
|
15289
|
+
"type": "string"
|
|
15290
|
+
},
|
|
15291
|
+
"position": {
|
|
15292
|
+
"description": "Position is the merchant's arrangement, and it is LOAD-BEARING: a\nprovince listed in two zones resolves to the first, so the order is how a\nmerchant expresses \"this one wins\". Ties break on name.",
|
|
15293
|
+
"type": "integer"
|
|
15294
|
+
},
|
|
15295
|
+
"provinces": {
|
|
15296
|
+
"description": "Provinces are the admin-unit codes this zone covers (\"84_VN101\"). A zone\nwith none matches nothing, which is a zone still being written rather\nthan a zone that covers everywhere — see ZoneFor.",
|
|
15297
|
+
"type": "array",
|
|
15298
|
+
"items": {
|
|
15299
|
+
"type": "string"
|
|
15300
|
+
}
|
|
15301
|
+
},
|
|
15302
|
+
"siteId": {
|
|
15303
|
+
"type": "string"
|
|
15304
|
+
},
|
|
14084
15305
|
"updatedAt": {
|
|
14085
15306
|
"type": "string"
|
|
14086
15307
|
}
|
|
@@ -14098,7 +15319,8 @@ export const API_DEFINITIONS = {
|
|
|
14098
15319
|
"product.deleted",
|
|
14099
15320
|
"page.published",
|
|
14100
15321
|
"course.enrolled",
|
|
14101
|
-
"course.revoked"
|
|
15322
|
+
"course.revoked",
|
|
15323
|
+
"form.submitted"
|
|
14102
15324
|
],
|
|
14103
15325
|
"x-enum-varnames": [
|
|
14104
15326
|
"EventOrderCreated",
|
|
@@ -14110,7 +15332,8 @@ export const API_DEFINITIONS = {
|
|
|
14110
15332
|
"EventProductDeleted",
|
|
14111
15333
|
"EventPagePublished",
|
|
14112
15334
|
"EventCourseEnrolled",
|
|
14113
|
-
"EventCourseRevoked"
|
|
15335
|
+
"EventCourseRevoked",
|
|
15336
|
+
"EventFormSubmitted"
|
|
14114
15337
|
]
|
|
14115
15338
|
},
|
|
14116
15339
|
"internal_appinstalls_rest.versionChoice": {
|