@ndla/types-backend 1.0.93 → 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.
Files changed (4) hide show
  1. package/build/article-api-openapi.d.ts +20 -16
  2. package/build/myndla-api-openapi.d.ts +117 -108
  3. package/build/search-api-openapi.d.ts +3 -12
  4. package/package.json +1 -1
package/build/article-api-openapi.d.ts CHANGED
@@ -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
  };
package/build/myndla-api-openapi.d.ts CHANGED
@@ -91,6 +91,26 @@ export type paths = {
91
91
  patch: operations["patchMyndla-apiV1FoldersFolder-id"];
92
92
  trace?: never;
93
93
  };
94
+ "/myndla-api/v1/folders/resources/has-favorited": {
95
+ parameters: {
96
+ query?: never;
97
+ header?: never;
98
+ path?: never;
99
+ cookie?: never;
100
+ };
101
+ /**
102
+ * Check if a resource has been favorited by the user
103
+ * @description Check if a resource has been favorited by the user
104
+ */
105
+ get: operations["getMyndla-apiV1FoldersResourcesHas-favorited"];
106
+ put?: never;
107
+ post?: never;
108
+ delete?: never;
109
+ options?: never;
110
+ head?: never;
111
+ patch?: never;
112
+ trace?: never;
113
+ };
94
114
  "/myndla-api/v1/folders/{folder-id}/resources": {
95
115
  parameters: {
96
116
  query?: never;
@@ -1018,10 +1038,7 @@ export interface operations {
1018
1038
  /** @description Choose if sub-folders should be included in the response */
1019
1039
  "include-subfolders"?: boolean;
1020
1040
  };
1021
- header?: {
1022
- /** @description Header containing FEIDE access token. */
1023
- FeideAuthorization?: string;
1024
- };
1041
+ header?: never;
1025
1042
  path?: never;
1026
1043
  cookie?: never;
1027
1044
  };
@@ -1080,10 +1097,7 @@ export interface operations {
1080
1097
  "postMyndla-apiV1Folders": {
1081
1098
  parameters: {
1082
1099
  query?: never;
1083
- header?: {
1084
- /** @description Header containing FEIDE access token. */
1085
- FeideAuthorization?: string;
1086
- };
1100
+ header?: never;
1087
1101
  path?: never;
1088
1102
  cookie?: never;
1089
1103
  };
@@ -1149,10 +1163,7 @@ export interface operations {
1149
1163
  /** @description Limit the number of results to this many elements */
1150
1164
  size?: number;
1151
1165
  };
1152
- header?: {
1153
- /** @description Header containing FEIDE access token. */
1154
- FeideAuthorization?: string;
1155
- };
1166
+ header?: never;
1156
1167
  path?: never;
1157
1168
  cookie?: never;
1158
1169
  };
@@ -1280,10 +1291,7 @@ export interface operations {
1280
1291
  /** @description Choose if sub-folders should be included in the response */
1281
1292
  "include-subfolders"?: boolean;
1282
1293
  };
1283
- header?: {
1284
- /** @description Header containing FEIDE access token. */
1285
- FeideAuthorization?: string;
1286
- };
1294
+ header?: never;
1287
1295
  path: {
1288
1296
  /** @description The UUID of the folder */
1289
1297
  "folder-id": string;
@@ -1345,10 +1353,7 @@ export interface operations {
1345
1353
  "deleteMyndla-apiV1FoldersFolder-id": {
1346
1354
  parameters: {
1347
1355
  query?: never;
1348
- header?: {
1349
- /** @description Header containing FEIDE access token. */
1350
- FeideAuthorization?: string;
1351
- };
1356
+ header?: never;
1352
1357
  path: {
1353
1358
  /** @description The UUID of the folder */
1354
1359
  "folder-id": string;
@@ -1408,10 +1413,7 @@ export interface operations {
1408
1413
  "patchMyndla-apiV1FoldersFolder-id": {
1409
1414
  parameters: {
1410
1415
  query?: never;
1411
- header?: {
1412
- /** @description Header containing FEIDE access token. */
1413
- FeideAuthorization?: string;
1414
- };
1416
+ header?: never;
1415
1417
  path: {
1416
1418
  /** @description The UUID of the folder */
1417
1419
  "folder-id": string;
@@ -1474,13 +1476,80 @@ export interface operations {
1474
1476
  };
1475
1477
  };
1476
1478
  };
1479
+ "getMyndla-apiV1FoldersResourcesHas-favorited": {
1480
+ parameters: {
1481
+ query: {
1482
+ /** @description The path of the resource to check */
1483
+ path: string;
1484
+ };
1485
+ header?: never;
1486
+ path?: never;
1487
+ cookie?: never;
1488
+ };
1489
+ requestBody?: never;
1490
+ responses: {
1491
+ 200: {
1492
+ headers: {
1493
+ [name: string]: unknown;
1494
+ };
1495
+ content: {
1496
+ "application/json": boolean;
1497
+ };
1498
+ };
1499
+ 400: {
1500
+ headers: {
1501
+ [name: string]: unknown;
1502
+ };
1503
+ content: {
1504
+ "application/json": components["schemas"]["AllErrors"];
1505
+ };
1506
+ };
1507
+ 401: {
1508
+ headers: {
1509
+ [name: string]: unknown;
1510
+ };
1511
+ content: {
1512
+ "application/json": components["schemas"]["AllErrors"];
1513
+ };
1514
+ };
1515
+ 403: {
1516
+ headers: {
1517
+ [name: string]: unknown;
1518
+ };
1519
+ content: {
1520
+ "application/json": components["schemas"]["AllErrors"];
1521
+ };
1522
+ };
1523
+ 404: {
1524
+ headers: {
1525
+ [name: string]: unknown;
1526
+ };
1527
+ content: {
1528
+ "application/json": components["schemas"]["AllErrors"];
1529
+ };
1530
+ };
1531
+ 500: {
1532
+ headers: {
1533
+ [name: string]: unknown;
1534
+ };
1535
+ content: {
1536
+ "application/json": components["schemas"]["ErrorBody"];
1537
+ };
1538
+ };
1539
+ 502: {
1540
+ headers: {
1541
+ [name: string]: unknown;
1542
+ };
1543
+ content: {
1544
+ "application/json": components["schemas"]["AllErrors"];
1545
+ };
1546
+ };
1547
+ };
1548
+ };
1477
1549
  "postMyndla-apiV1FoldersFolder-idResources": {
1478
1550
  parameters: {
1479
1551
  query?: never;
1480
- header?: {
1481
- /** @description Header containing FEIDE access token. */
1482
- FeideAuthorization?: string;
1483
- };
1552
+ header?: never;
1484
1553
  path: {
1485
1554
  /** @description The UUID of the folder */
1486
1555
  "folder-id": string;
@@ -1546,10 +1615,7 @@ export interface operations {
1546
1615
  "patchMyndla-apiV1FoldersResourcesResource-id": {
1547
1616
  parameters: {
1548
1617
  query?: never;
1549
- header?: {
1550
- /** @description Header containing FEIDE access token. */
1551
- FeideAuthorization?: string;
1552
- };
1618
+ header?: never;
1553
1619
  path: {
1554
1620
  /** @description The UUID of the resource */
1555
1621
  "resource-id": string;
@@ -1615,10 +1681,7 @@ export interface operations {
1615
1681
  "deleteMyndla-apiV1FoldersFolder-idResourcesResource-id": {
1616
1682
  parameters: {
1617
1683
  query?: never;
1618
- header?: {
1619
- /** @description Header containing FEIDE access token. */
1620
- FeideAuthorization?: string;
1621
- };
1684
+ header?: never;
1622
1685
  path: {
1623
1686
  /** @description The UUID of the folder */
1624
1687
  "folder-id": string;
@@ -1761,10 +1824,7 @@ export interface operations {
1761
1824
  /** @description Status of the folder */
1762
1825
  "folder-status": components["schemas"]["FolderStatus"];
1763
1826
  };
1764
- header?: {
1765
- /** @description Header containing FEIDE access token. */
1766
- FeideAuthorization?: string;
1767
- };
1827
+ header?: never;
1768
1828
  path: {
1769
1829
  /** @description The UUID of the folder */
1770
1830
  "folder-id": string;
@@ -1837,10 +1897,7 @@ export interface operations {
1837
1897
  /** @description Destination UUID of the folder. If None it will be cloned as a root folder. */
1838
1898
  "destination-folder-id"?: string;
1839
1899
  };
1840
- header?: {
1841
- /** @description Header containing FEIDE access token. */
1842
- FeideAuthorization?: string;
1843
- };
1900
+ header?: never;
1844
1901
  path: {
1845
1902
  /** @description Source UUID of the folder. */
1846
1903
  "source-folder-id": string;
@@ -1910,10 +1967,7 @@ export interface operations {
1910
1967
  "putMyndla-apiV1FoldersSort-resourcesFolder-id": {
1911
1968
  parameters: {
1912
1969
  query?: never;
1913
- header?: {
1914
- /** @description Header containing FEIDE access token. */
1915
- FeideAuthorization?: string;
1916
- };
1970
+ header?: never;
1917
1971
  path: {
1918
1972
  /** @description The UUID of the folder */
1919
1973
  "folder-id": string;
@@ -1988,10 +2042,7 @@ export interface operations {
1988
2042
  /** @description The UUID of the folder */
1989
2043
  "folder-id"?: string;
1990
2044
  };
1991
- header?: {
1992
- /** @description Header containing FEIDE access token. */
1993
- FeideAuthorization?: string;
1994
- };
2045
+ header?: never;
1995
2046
  path?: never;
1996
2047
  cookie?: never;
1997
2048
  };
@@ -2060,10 +2111,7 @@ export interface operations {
2060
2111
  "putMyndla-apiV1FoldersSort-saved": {
2061
2112
  parameters: {
2062
2113
  query?: never;
2063
- header?: {
2064
- /** @description Header containing FEIDE access token. */
2065
- FeideAuthorization?: string;
2066
- };
2114
+ header?: never;
2067
2115
  path?: never;
2068
2116
  cookie?: never;
2069
2117
  };
@@ -2132,10 +2180,7 @@ export interface operations {
2132
2180
  "postMyndla-apiV1FoldersSharedFolder-idSave": {
2133
2181
  parameters: {
2134
2182
  query?: never;
2135
- header?: {
2136
- /** @description Header containing FEIDE access token. */
2137
- FeideAuthorization?: string;
2138
- };
2183
+ header?: never;
2139
2184
  path: {
2140
2185
  /** @description The UUID of the folder */
2141
2186
  "folder-id": string;
@@ -2203,10 +2248,7 @@ export interface operations {
2203
2248
  "deleteMyndla-apiV1FoldersSharedFolder-idSave": {
2204
2249
  parameters: {
2205
2250
  query?: never;
2206
- header?: {
2207
- /** @description Header containing FEIDE access token. */
2208
- FeideAuthorization?: string;
2209
- };
2251
+ header?: never;
2210
2252
  path: {
2211
2253
  /** @description The UUID of the folder */
2212
2254
  "folder-id": string;
@@ -2274,10 +2316,7 @@ export interface operations {
2274
2316
  "getMyndla-apiV1Robots": {
2275
2317
  parameters: {
2276
2318
  query?: never;
2277
- header?: {
2278
- /** @description Header containing FEIDE access token. */
2279
- FeideAuthorization?: string;
2280
- };
2319
+ header?: never;
2281
2320
  path?: never;
2282
2321
  cookie?: never;
2283
2322
  };
@@ -2336,10 +2375,7 @@ export interface operations {
2336
2375
  "postMyndla-apiV1Robots": {
2337
2376
  parameters: {
2338
2377
  query?: never;
2339
- header?: {
2340
- /** @description Header containing FEIDE access token. */
2341
- FeideAuthorization?: string;
2342
- };
2378
+ header?: never;
2343
2379
  path?: never;
2344
2380
  cookie?: never;
2345
2381
  };
@@ -2402,10 +2438,7 @@ export interface operations {
2402
2438
  "getMyndla-apiV1RobotsRobot-id": {
2403
2439
  parameters: {
2404
2440
  query?: never;
2405
- header?: {
2406
- /** @description Header containing FEIDE access token. */
2407
- FeideAuthorization?: string;
2408
- };
2441
+ header?: never;
2409
2442
  path: {
2410
2443
  "robot-id": string;
2411
2444
  };
@@ -2466,10 +2499,7 @@ export interface operations {
2466
2499
  "putMyndla-apiV1RobotsRobot-id": {
2467
2500
  parameters: {
2468
2501
  query?: never;
2469
- header?: {
2470
- /** @description Header containing FEIDE access token. */
2471
- FeideAuthorization?: string;
2472
- };
2502
+ header?: never;
2473
2503
  path: {
2474
2504
  "robot-id": string;
2475
2505
  };
@@ -2534,10 +2564,7 @@ export interface operations {
2534
2564
  "deleteMyndla-apiV1RobotsRobot-id": {
2535
2565
  parameters: {
2536
2566
  query?: never;
2537
- header?: {
2538
- /** @description Header containing FEIDE access token. */
2539
- FeideAuthorization?: string;
2540
- };
2567
+ header?: never;
2541
2568
  path: {
2542
2569
  "robot-id": string;
2543
2570
  };
@@ -2596,10 +2623,7 @@ export interface operations {
2596
2623
  "putMyndla-apiV1RobotsRobot-idRobot-status": {
2597
2624
  parameters: {
2598
2625
  query?: never;
2599
- header?: {
2600
- /** @description Header containing FEIDE access token. */
2601
- FeideAuthorization?: string;
2602
- };
2626
+ header?: never;
2603
2627
  path: {
2604
2628
  "robot-id": string;
2605
2629
  "robot-status": components["schemas"]["RobotStatus"];
@@ -2661,10 +2685,7 @@ export interface operations {
2661
2685
  "getMyndla-apiV1Users": {
2662
2686
  parameters: {
2663
2687
  query?: never;
2664
- header?: {
2665
- /** @description Header containing FEIDE access token. */
2666
- FeideAuthorization?: string;
2667
- };
2688
+ header?: never;
2668
2689
  path?: never;
2669
2690
  cookie?: never;
2670
2691
  };
@@ -2723,10 +2744,7 @@ export interface operations {
2723
2744
  "patchMyndla-apiV1Users": {
2724
2745
  parameters: {
2725
2746
  query?: never;
2726
- header?: {
2727
- /** @description Header containing FEIDE access token. */
2728
- FeideAuthorization?: string;
2729
- };
2747
+ header?: never;
2730
2748
  path?: never;
2731
2749
  cookie?: never;
2732
2750
  };
@@ -2789,10 +2807,7 @@ export interface operations {
2789
2807
  "deleteMyndla-apiV1UsersDelete-personal-data": {
2790
2808
  parameters: {
2791
2809
  query?: never;
2792
- header?: {
2793
- /** @description Header containing FEIDE access token. */
2794
- FeideAuthorization?: string;
2795
- };
2810
+ header?: never;
2796
2811
  path?: never;
2797
2812
  cookie?: never;
2798
2813
  };
@@ -2849,10 +2864,7 @@ export interface operations {
2849
2864
  "getMyndla-apiV1UsersExport": {
2850
2865
  parameters: {
2851
2866
  query?: never;
2852
- header?: {
2853
- /** @description Header containing FEIDE access token. */
2854
- FeideAuthorization?: string;
2855
- };
2867
+ header?: never;
2856
2868
  path?: never;
2857
2869
  cookie?: never;
2858
2870
  };
@@ -2911,10 +2923,7 @@ export interface operations {
2911
2923
  "postMyndla-apiV1UsersImport": {
2912
2924
  parameters: {
2913
2925
  query?: never;
2914
- header?: {
2915
- /** @description Header containing FEIDE access token. */
2916
- FeideAuthorization?: string;
2917
- };
2926
+ header?: never;
2918
2927
  path?: never;
2919
2928
  cookie?: never;
2920
2929
  };
package/build/search-api-openapi.d.ts CHANGED
@@ -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
  };
package/package.json CHANGED
@@ -32,6 +32,6 @@
32
32
  "tsx": "^4.21.0",
33
33
  "typescript": "^5.9.3"
34
34
  },
35
- "version": "1.0.93",
35
+ "version": "1.0.95",
36
36
  "packageManager": "yarn@4.10.3"
37
37
  }