@ndla/types-backend 1.0.94 → 1.0.95
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/build/article-api-openapi.d.ts +20 -16
- package/build/myndla-api-openapi.d.ts +28 -112
- package/build/search-api-openapi.d.ts +3 -12
- package/package.json +1 -1
|
@@ -670,10 +670,7 @@ export interface operations {
|
|
|
670
670
|
/** @description The page number of the search hits to display. */
|
|
671
671
|
page?: number;
|
|
672
672
|
};
|
|
673
|
-
header?:
|
|
674
|
-
/** @description Header containing FEIDE access token. */
|
|
675
|
-
FeideAuthorization?: string;
|
|
676
|
-
};
|
|
673
|
+
header?: never;
|
|
677
674
|
path?: never;
|
|
678
675
|
cookie?: never;
|
|
679
676
|
};
|
|
@@ -777,10 +774,7 @@ export interface operations {
|
|
|
777
774
|
/** @description Fallback to existing language if language is specified. */
|
|
778
775
|
fallback?: boolean;
|
|
779
776
|
};
|
|
780
|
-
header?:
|
|
781
|
-
/** @description Header containing FEIDE access token. */
|
|
782
|
-
FeideAuthorization?: string;
|
|
783
|
-
};
|
|
777
|
+
header?: never;
|
|
784
778
|
path: {
|
|
785
779
|
/** @description Id or slug of the article that is to be fetched. */
|
|
786
780
|
article_id: string;
|
|
@@ -805,6 +799,22 @@ export interface operations {
|
|
|
805
799
|
"application/json": components["schemas"]["AllErrors"];
|
|
806
800
|
};
|
|
807
801
|
};
|
|
802
|
+
401: {
|
|
803
|
+
headers: {
|
|
804
|
+
[name: string]: unknown;
|
|
805
|
+
};
|
|
806
|
+
content: {
|
|
807
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
403: {
|
|
811
|
+
headers: {
|
|
812
|
+
[name: string]: unknown;
|
|
813
|
+
};
|
|
814
|
+
content: {
|
|
815
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
816
|
+
};
|
|
817
|
+
};
|
|
808
818
|
404: {
|
|
809
819
|
headers: {
|
|
810
820
|
[name: string]: unknown;
|
|
@@ -866,10 +876,7 @@ export interface operations {
|
|
|
866
876
|
/** @description A comma separated list of codes from GREP API the resources should be filtered by. */
|
|
867
877
|
"grep-codes"?: string[];
|
|
868
878
|
};
|
|
869
|
-
header?:
|
|
870
|
-
/** @description Header containing FEIDE access token. */
|
|
871
|
-
FeideAuthorization?: string;
|
|
872
|
-
};
|
|
879
|
+
header?: never;
|
|
873
880
|
path?: never;
|
|
874
881
|
cookie?: never;
|
|
875
882
|
};
|
|
@@ -912,10 +919,7 @@ export interface operations {
|
|
|
912
919
|
"postArticle-apiV2ArticlesSearch": {
|
|
913
920
|
parameters: {
|
|
914
921
|
query?: never;
|
|
915
|
-
header?:
|
|
916
|
-
/** @description Header containing FEIDE access token. */
|
|
917
|
-
FeideAuthorization?: string;
|
|
918
|
-
};
|
|
922
|
+
header?: never;
|
|
919
923
|
path?: never;
|
|
920
924
|
cookie?: never;
|
|
921
925
|
};
|
|
@@ -1038,10 +1038,7 @@ export interface operations {
|
|
|
1038
1038
|
/** @description Choose if sub-folders should be included in the response */
|
|
1039
1039
|
"include-subfolders"?: boolean;
|
|
1040
1040
|
};
|
|
1041
|
-
header?:
|
|
1042
|
-
/** @description Header containing FEIDE access token. */
|
|
1043
|
-
FeideAuthorization?: string;
|
|
1044
|
-
};
|
|
1041
|
+
header?: never;
|
|
1045
1042
|
path?: never;
|
|
1046
1043
|
cookie?: never;
|
|
1047
1044
|
};
|
|
@@ -1100,10 +1097,7 @@ export interface operations {
|
|
|
1100
1097
|
"postMyndla-apiV1Folders": {
|
|
1101
1098
|
parameters: {
|
|
1102
1099
|
query?: never;
|
|
1103
|
-
header?:
|
|
1104
|
-
/** @description Header containing FEIDE access token. */
|
|
1105
|
-
FeideAuthorization?: string;
|
|
1106
|
-
};
|
|
1100
|
+
header?: never;
|
|
1107
1101
|
path?: never;
|
|
1108
1102
|
cookie?: never;
|
|
1109
1103
|
};
|
|
@@ -1169,10 +1163,7 @@ export interface operations {
|
|
|
1169
1163
|
/** @description Limit the number of results to this many elements */
|
|
1170
1164
|
size?: number;
|
|
1171
1165
|
};
|
|
1172
|
-
header?:
|
|
1173
|
-
/** @description Header containing FEIDE access token. */
|
|
1174
|
-
FeideAuthorization?: string;
|
|
1175
|
-
};
|
|
1166
|
+
header?: never;
|
|
1176
1167
|
path?: never;
|
|
1177
1168
|
cookie?: never;
|
|
1178
1169
|
};
|
|
@@ -1300,10 +1291,7 @@ export interface operations {
|
|
|
1300
1291
|
/** @description Choose if sub-folders should be included in the response */
|
|
1301
1292
|
"include-subfolders"?: boolean;
|
|
1302
1293
|
};
|
|
1303
|
-
header?:
|
|
1304
|
-
/** @description Header containing FEIDE access token. */
|
|
1305
|
-
FeideAuthorization?: string;
|
|
1306
|
-
};
|
|
1294
|
+
header?: never;
|
|
1307
1295
|
path: {
|
|
1308
1296
|
/** @description The UUID of the folder */
|
|
1309
1297
|
"folder-id": string;
|
|
@@ -1365,10 +1353,7 @@ export interface operations {
|
|
|
1365
1353
|
"deleteMyndla-apiV1FoldersFolder-id": {
|
|
1366
1354
|
parameters: {
|
|
1367
1355
|
query?: never;
|
|
1368
|
-
header?:
|
|
1369
|
-
/** @description Header containing FEIDE access token. */
|
|
1370
|
-
FeideAuthorization?: string;
|
|
1371
|
-
};
|
|
1356
|
+
header?: never;
|
|
1372
1357
|
path: {
|
|
1373
1358
|
/** @description The UUID of the folder */
|
|
1374
1359
|
"folder-id": string;
|
|
@@ -1428,10 +1413,7 @@ export interface operations {
|
|
|
1428
1413
|
"patchMyndla-apiV1FoldersFolder-id": {
|
|
1429
1414
|
parameters: {
|
|
1430
1415
|
query?: never;
|
|
1431
|
-
header?:
|
|
1432
|
-
/** @description Header containing FEIDE access token. */
|
|
1433
|
-
FeideAuthorization?: string;
|
|
1434
|
-
};
|
|
1416
|
+
header?: never;
|
|
1435
1417
|
path: {
|
|
1436
1418
|
/** @description The UUID of the folder */
|
|
1437
1419
|
"folder-id": string;
|
|
@@ -1500,10 +1482,7 @@ export interface operations {
|
|
|
1500
1482
|
/** @description The path of the resource to check */
|
|
1501
1483
|
path: string;
|
|
1502
1484
|
};
|
|
1503
|
-
header?:
|
|
1504
|
-
/** @description Header containing FEIDE access token. */
|
|
1505
|
-
FeideAuthorization?: string;
|
|
1506
|
-
};
|
|
1485
|
+
header?: never;
|
|
1507
1486
|
path?: never;
|
|
1508
1487
|
cookie?: never;
|
|
1509
1488
|
};
|
|
@@ -1570,10 +1549,7 @@ export interface operations {
|
|
|
1570
1549
|
"postMyndla-apiV1FoldersFolder-idResources": {
|
|
1571
1550
|
parameters: {
|
|
1572
1551
|
query?: never;
|
|
1573
|
-
header?:
|
|
1574
|
-
/** @description Header containing FEIDE access token. */
|
|
1575
|
-
FeideAuthorization?: string;
|
|
1576
|
-
};
|
|
1552
|
+
header?: never;
|
|
1577
1553
|
path: {
|
|
1578
1554
|
/** @description The UUID of the folder */
|
|
1579
1555
|
"folder-id": string;
|
|
@@ -1639,10 +1615,7 @@ export interface operations {
|
|
|
1639
1615
|
"patchMyndla-apiV1FoldersResourcesResource-id": {
|
|
1640
1616
|
parameters: {
|
|
1641
1617
|
query?: never;
|
|
1642
|
-
header?:
|
|
1643
|
-
/** @description Header containing FEIDE access token. */
|
|
1644
|
-
FeideAuthorization?: string;
|
|
1645
|
-
};
|
|
1618
|
+
header?: never;
|
|
1646
1619
|
path: {
|
|
1647
1620
|
/** @description The UUID of the resource */
|
|
1648
1621
|
"resource-id": string;
|
|
@@ -1708,10 +1681,7 @@ export interface operations {
|
|
|
1708
1681
|
"deleteMyndla-apiV1FoldersFolder-idResourcesResource-id": {
|
|
1709
1682
|
parameters: {
|
|
1710
1683
|
query?: never;
|
|
1711
|
-
header?:
|
|
1712
|
-
/** @description Header containing FEIDE access token. */
|
|
1713
|
-
FeideAuthorization?: string;
|
|
1714
|
-
};
|
|
1684
|
+
header?: never;
|
|
1715
1685
|
path: {
|
|
1716
1686
|
/** @description The UUID of the folder */
|
|
1717
1687
|
"folder-id": string;
|
|
@@ -1854,10 +1824,7 @@ export interface operations {
|
|
|
1854
1824
|
/** @description Status of the folder */
|
|
1855
1825
|
"folder-status": components["schemas"]["FolderStatus"];
|
|
1856
1826
|
};
|
|
1857
|
-
header?:
|
|
1858
|
-
/** @description Header containing FEIDE access token. */
|
|
1859
|
-
FeideAuthorization?: string;
|
|
1860
|
-
};
|
|
1827
|
+
header?: never;
|
|
1861
1828
|
path: {
|
|
1862
1829
|
/** @description The UUID of the folder */
|
|
1863
1830
|
"folder-id": string;
|
|
@@ -1930,10 +1897,7 @@ export interface operations {
|
|
|
1930
1897
|
/** @description Destination UUID of the folder. If None it will be cloned as a root folder. */
|
|
1931
1898
|
"destination-folder-id"?: string;
|
|
1932
1899
|
};
|
|
1933
|
-
header?:
|
|
1934
|
-
/** @description Header containing FEIDE access token. */
|
|
1935
|
-
FeideAuthorization?: string;
|
|
1936
|
-
};
|
|
1900
|
+
header?: never;
|
|
1937
1901
|
path: {
|
|
1938
1902
|
/** @description Source UUID of the folder. */
|
|
1939
1903
|
"source-folder-id": string;
|
|
@@ -2003,10 +1967,7 @@ export interface operations {
|
|
|
2003
1967
|
"putMyndla-apiV1FoldersSort-resourcesFolder-id": {
|
|
2004
1968
|
parameters: {
|
|
2005
1969
|
query?: never;
|
|
2006
|
-
header?:
|
|
2007
|
-
/** @description Header containing FEIDE access token. */
|
|
2008
|
-
FeideAuthorization?: string;
|
|
2009
|
-
};
|
|
1970
|
+
header?: never;
|
|
2010
1971
|
path: {
|
|
2011
1972
|
/** @description The UUID of the folder */
|
|
2012
1973
|
"folder-id": string;
|
|
@@ -2081,10 +2042,7 @@ export interface operations {
|
|
|
2081
2042
|
/** @description The UUID of the folder */
|
|
2082
2043
|
"folder-id"?: string;
|
|
2083
2044
|
};
|
|
2084
|
-
header?:
|
|
2085
|
-
/** @description Header containing FEIDE access token. */
|
|
2086
|
-
FeideAuthorization?: string;
|
|
2087
|
-
};
|
|
2045
|
+
header?: never;
|
|
2088
2046
|
path?: never;
|
|
2089
2047
|
cookie?: never;
|
|
2090
2048
|
};
|
|
@@ -2153,10 +2111,7 @@ export interface operations {
|
|
|
2153
2111
|
"putMyndla-apiV1FoldersSort-saved": {
|
|
2154
2112
|
parameters: {
|
|
2155
2113
|
query?: never;
|
|
2156
|
-
header?:
|
|
2157
|
-
/** @description Header containing FEIDE access token. */
|
|
2158
|
-
FeideAuthorization?: string;
|
|
2159
|
-
};
|
|
2114
|
+
header?: never;
|
|
2160
2115
|
path?: never;
|
|
2161
2116
|
cookie?: never;
|
|
2162
2117
|
};
|
|
@@ -2225,10 +2180,7 @@ export interface operations {
|
|
|
2225
2180
|
"postMyndla-apiV1FoldersSharedFolder-idSave": {
|
|
2226
2181
|
parameters: {
|
|
2227
2182
|
query?: never;
|
|
2228
|
-
header?:
|
|
2229
|
-
/** @description Header containing FEIDE access token. */
|
|
2230
|
-
FeideAuthorization?: string;
|
|
2231
|
-
};
|
|
2183
|
+
header?: never;
|
|
2232
2184
|
path: {
|
|
2233
2185
|
/** @description The UUID of the folder */
|
|
2234
2186
|
"folder-id": string;
|
|
@@ -2296,10 +2248,7 @@ export interface operations {
|
|
|
2296
2248
|
"deleteMyndla-apiV1FoldersSharedFolder-idSave": {
|
|
2297
2249
|
parameters: {
|
|
2298
2250
|
query?: never;
|
|
2299
|
-
header?:
|
|
2300
|
-
/** @description Header containing FEIDE access token. */
|
|
2301
|
-
FeideAuthorization?: string;
|
|
2302
|
-
};
|
|
2251
|
+
header?: never;
|
|
2303
2252
|
path: {
|
|
2304
2253
|
/** @description The UUID of the folder */
|
|
2305
2254
|
"folder-id": string;
|
|
@@ -2367,10 +2316,7 @@ export interface operations {
|
|
|
2367
2316
|
"getMyndla-apiV1Robots": {
|
|
2368
2317
|
parameters: {
|
|
2369
2318
|
query?: never;
|
|
2370
|
-
header?:
|
|
2371
|
-
/** @description Header containing FEIDE access token. */
|
|
2372
|
-
FeideAuthorization?: string;
|
|
2373
|
-
};
|
|
2319
|
+
header?: never;
|
|
2374
2320
|
path?: never;
|
|
2375
2321
|
cookie?: never;
|
|
2376
2322
|
};
|
|
@@ -2429,10 +2375,7 @@ export interface operations {
|
|
|
2429
2375
|
"postMyndla-apiV1Robots": {
|
|
2430
2376
|
parameters: {
|
|
2431
2377
|
query?: never;
|
|
2432
|
-
header?:
|
|
2433
|
-
/** @description Header containing FEIDE access token. */
|
|
2434
|
-
FeideAuthorization?: string;
|
|
2435
|
-
};
|
|
2378
|
+
header?: never;
|
|
2436
2379
|
path?: never;
|
|
2437
2380
|
cookie?: never;
|
|
2438
2381
|
};
|
|
@@ -2495,10 +2438,7 @@ export interface operations {
|
|
|
2495
2438
|
"getMyndla-apiV1RobotsRobot-id": {
|
|
2496
2439
|
parameters: {
|
|
2497
2440
|
query?: never;
|
|
2498
|
-
header?:
|
|
2499
|
-
/** @description Header containing FEIDE access token. */
|
|
2500
|
-
FeideAuthorization?: string;
|
|
2501
|
-
};
|
|
2441
|
+
header?: never;
|
|
2502
2442
|
path: {
|
|
2503
2443
|
"robot-id": string;
|
|
2504
2444
|
};
|
|
@@ -2559,10 +2499,7 @@ export interface operations {
|
|
|
2559
2499
|
"putMyndla-apiV1RobotsRobot-id": {
|
|
2560
2500
|
parameters: {
|
|
2561
2501
|
query?: never;
|
|
2562
|
-
header?:
|
|
2563
|
-
/** @description Header containing FEIDE access token. */
|
|
2564
|
-
FeideAuthorization?: string;
|
|
2565
|
-
};
|
|
2502
|
+
header?: never;
|
|
2566
2503
|
path: {
|
|
2567
2504
|
"robot-id": string;
|
|
2568
2505
|
};
|
|
@@ -2627,10 +2564,7 @@ export interface operations {
|
|
|
2627
2564
|
"deleteMyndla-apiV1RobotsRobot-id": {
|
|
2628
2565
|
parameters: {
|
|
2629
2566
|
query?: never;
|
|
2630
|
-
header?:
|
|
2631
|
-
/** @description Header containing FEIDE access token. */
|
|
2632
|
-
FeideAuthorization?: string;
|
|
2633
|
-
};
|
|
2567
|
+
header?: never;
|
|
2634
2568
|
path: {
|
|
2635
2569
|
"robot-id": string;
|
|
2636
2570
|
};
|
|
@@ -2689,10 +2623,7 @@ export interface operations {
|
|
|
2689
2623
|
"putMyndla-apiV1RobotsRobot-idRobot-status": {
|
|
2690
2624
|
parameters: {
|
|
2691
2625
|
query?: never;
|
|
2692
|
-
header?:
|
|
2693
|
-
/** @description Header containing FEIDE access token. */
|
|
2694
|
-
FeideAuthorization?: string;
|
|
2695
|
-
};
|
|
2626
|
+
header?: never;
|
|
2696
2627
|
path: {
|
|
2697
2628
|
"robot-id": string;
|
|
2698
2629
|
"robot-status": components["schemas"]["RobotStatus"];
|
|
@@ -2754,10 +2685,7 @@ export interface operations {
|
|
|
2754
2685
|
"getMyndla-apiV1Users": {
|
|
2755
2686
|
parameters: {
|
|
2756
2687
|
query?: never;
|
|
2757
|
-
header?:
|
|
2758
|
-
/** @description Header containing FEIDE access token. */
|
|
2759
|
-
FeideAuthorization?: string;
|
|
2760
|
-
};
|
|
2688
|
+
header?: never;
|
|
2761
2689
|
path?: never;
|
|
2762
2690
|
cookie?: never;
|
|
2763
2691
|
};
|
|
@@ -2816,10 +2744,7 @@ export interface operations {
|
|
|
2816
2744
|
"patchMyndla-apiV1Users": {
|
|
2817
2745
|
parameters: {
|
|
2818
2746
|
query?: never;
|
|
2819
|
-
header?:
|
|
2820
|
-
/** @description Header containing FEIDE access token. */
|
|
2821
|
-
FeideAuthorization?: string;
|
|
2822
|
-
};
|
|
2747
|
+
header?: never;
|
|
2823
2748
|
path?: never;
|
|
2824
2749
|
cookie?: never;
|
|
2825
2750
|
};
|
|
@@ -2882,10 +2807,7 @@ export interface operations {
|
|
|
2882
2807
|
"deleteMyndla-apiV1UsersDelete-personal-data": {
|
|
2883
2808
|
parameters: {
|
|
2884
2809
|
query?: never;
|
|
2885
|
-
header?:
|
|
2886
|
-
/** @description Header containing FEIDE access token. */
|
|
2887
|
-
FeideAuthorization?: string;
|
|
2888
|
-
};
|
|
2810
|
+
header?: never;
|
|
2889
2811
|
path?: never;
|
|
2890
2812
|
cookie?: never;
|
|
2891
2813
|
};
|
|
@@ -2942,10 +2864,7 @@ export interface operations {
|
|
|
2942
2864
|
"getMyndla-apiV1UsersExport": {
|
|
2943
2865
|
parameters: {
|
|
2944
2866
|
query?: never;
|
|
2945
|
-
header?:
|
|
2946
|
-
/** @description Header containing FEIDE access token. */
|
|
2947
|
-
FeideAuthorization?: string;
|
|
2948
|
-
};
|
|
2867
|
+
header?: never;
|
|
2949
2868
|
path?: never;
|
|
2950
2869
|
cookie?: never;
|
|
2951
2870
|
};
|
|
@@ -3004,10 +2923,7 @@ export interface operations {
|
|
|
3004
2923
|
"postMyndla-apiV1UsersImport": {
|
|
3005
2924
|
parameters: {
|
|
3006
2925
|
query?: never;
|
|
3007
|
-
header?:
|
|
3008
|
-
/** @description Header containing FEIDE access token. */
|
|
3009
|
-
FeideAuthorization?: string;
|
|
3010
|
-
};
|
|
2926
|
+
header?: never;
|
|
3011
2927
|
path?: never;
|
|
3012
2928
|
cookie?: never;
|
|
3013
2929
|
};
|
|
@@ -1060,10 +1060,7 @@ export interface operations {
|
|
|
1060
1060
|
/** @description Whether to include group without resource-types for group-search. Defaults to false. */
|
|
1061
1061
|
"missing-group"?: boolean;
|
|
1062
1062
|
};
|
|
1063
|
-
header?:
|
|
1064
|
-
/** @description Header containing FEIDE access token. */
|
|
1065
|
-
FeideAuthorization?: string;
|
|
1066
|
-
};
|
|
1063
|
+
header?: never;
|
|
1067
1064
|
path?: never;
|
|
1068
1065
|
cookie?: never;
|
|
1069
1066
|
};
|
|
@@ -1147,10 +1144,7 @@ export interface operations {
|
|
|
1147
1144
|
"node-types"?: string[];
|
|
1148
1145
|
tags?: string[];
|
|
1149
1146
|
};
|
|
1150
|
-
header?:
|
|
1151
|
-
/** @description Header containing FEIDE access token. */
|
|
1152
|
-
FeideAuthorization?: string;
|
|
1153
|
-
};
|
|
1147
|
+
header?: never;
|
|
1154
1148
|
path?: never;
|
|
1155
1149
|
cookie?: never;
|
|
1156
1150
|
};
|
|
@@ -1209,10 +1203,7 @@ export interface operations {
|
|
|
1209
1203
|
"postSearch-apiV1Search": {
|
|
1210
1204
|
parameters: {
|
|
1211
1205
|
query?: never;
|
|
1212
|
-
header?:
|
|
1213
|
-
/** @description Header containing FEIDE access token. */
|
|
1214
|
-
FeideAuthorization?: string;
|
|
1215
|
-
};
|
|
1206
|
+
header?: never;
|
|
1216
1207
|
path?: never;
|
|
1217
1208
|
cookie?: never;
|
|
1218
1209
|
};
|