@ndla/types-backend 1.0.110 → 1.0.112
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/draft-api.d.ts +4 -4
- package/build/myndla-api.d.ts +100 -0
- package/build/search-api.d.ts +21 -12
- package/package.json +1 -1
package/build/draft-api.d.ts
CHANGED
|
@@ -3335,12 +3335,12 @@ export interface operations {
|
|
|
3335
3335
|
"application/json": components["schemas"]["AllErrors"];
|
|
3336
3336
|
};
|
|
3337
3337
|
};
|
|
3338
|
-
|
|
3338
|
+
default: {
|
|
3339
3339
|
headers: {
|
|
3340
3340
|
[name: string]: unknown;
|
|
3341
3341
|
};
|
|
3342
3342
|
content: {
|
|
3343
|
-
"application/json": components["schemas"]["
|
|
3343
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3344
3344
|
};
|
|
3345
3345
|
};
|
|
3346
3346
|
};
|
|
@@ -3394,12 +3394,12 @@ export interface operations {
|
|
|
3394
3394
|
"application/json": components["schemas"]["AllErrors"];
|
|
3395
3395
|
};
|
|
3396
3396
|
};
|
|
3397
|
-
|
|
3397
|
+
default: {
|
|
3398
3398
|
headers: {
|
|
3399
3399
|
[name: string]: unknown;
|
|
3400
3400
|
};
|
|
3401
3401
|
content: {
|
|
3402
|
-
"application/json": components["schemas"]["
|
|
3402
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3403
3403
|
};
|
|
3404
3404
|
};
|
|
3405
3405
|
};
|
package/build/myndla-api.d.ts
CHANGED
|
@@ -423,6 +423,26 @@ export type paths = {
|
|
|
423
423
|
patch?: never;
|
|
424
424
|
trace?: never;
|
|
425
425
|
};
|
|
426
|
+
"/myndla-api/v1/folders/resources/move": {
|
|
427
|
+
parameters: {
|
|
428
|
+
query?: never;
|
|
429
|
+
header?: never;
|
|
430
|
+
path?: never;
|
|
431
|
+
cookie?: never;
|
|
432
|
+
};
|
|
433
|
+
get?: never;
|
|
434
|
+
/**
|
|
435
|
+
* Move a resource from one folder to another
|
|
436
|
+
* @description Move a resource from one folder to another
|
|
437
|
+
*/
|
|
438
|
+
put: operations["putMyndla-apiV1FoldersResourcesMove"];
|
|
439
|
+
post?: never;
|
|
440
|
+
delete?: never;
|
|
441
|
+
options?: never;
|
|
442
|
+
head?: never;
|
|
443
|
+
patch?: never;
|
|
444
|
+
trace?: never;
|
|
445
|
+
};
|
|
426
446
|
"/myndla-api/v1/robots": {
|
|
427
447
|
parameters: {
|
|
428
448
|
query?: never;
|
|
@@ -810,6 +830,24 @@ export type components = {
|
|
|
810
830
|
Map_Map_String_Long: {
|
|
811
831
|
[key: string]: components["schemas"]["Map_Long"];
|
|
812
832
|
};
|
|
833
|
+
/** MoveResourceDTO */
|
|
834
|
+
MoveResourceDTO: {
|
|
835
|
+
/**
|
|
836
|
+
* Format: uuid
|
|
837
|
+
* @description Folder to move from. Empty value indicates root-resource.
|
|
838
|
+
*/
|
|
839
|
+
fromFolderId?: string;
|
|
840
|
+
/**
|
|
841
|
+
* Format: uuid
|
|
842
|
+
* @description Folder to move to. Empty value moves resource to root.
|
|
843
|
+
*/
|
|
844
|
+
toFolderId?: string;
|
|
845
|
+
/**
|
|
846
|
+
* Format: uuid
|
|
847
|
+
* @description The resource to move
|
|
848
|
+
*/
|
|
849
|
+
resourceId: string;
|
|
850
|
+
};
|
|
813
851
|
/** MyNDLAGroupDTO */
|
|
814
852
|
MyNDLAGroupDTO: {
|
|
815
853
|
/** @description ID of the group */
|
|
@@ -1186,6 +1224,7 @@ export type FolderStatus = components['schemas']['FolderStatus'];
|
|
|
1186
1224
|
export type ListOfRobotDefinitionsDTO = components['schemas']['ListOfRobotDefinitionsDTO'];
|
|
1187
1225
|
export type Map_Long = components['schemas']['Map_Long'];
|
|
1188
1226
|
export type Map_Map_String_Long = components['schemas']['Map_Map_String_Long'];
|
|
1227
|
+
export type MoveResourceDTO = components['schemas']['MoveResourceDTO'];
|
|
1189
1228
|
export type MyNDLAGroupDTO = components['schemas']['MyNDLAGroupDTO'];
|
|
1190
1229
|
export type MyNDLAUserDTO = components['schemas']['MyNDLAUserDTO'];
|
|
1191
1230
|
export type NewFolderDTO = components['schemas']['NewFolderDTO'];
|
|
@@ -2945,6 +2984,67 @@ export interface operations {
|
|
|
2945
2984
|
};
|
|
2946
2985
|
};
|
|
2947
2986
|
};
|
|
2987
|
+
"putMyndla-apiV1FoldersResourcesMove": {
|
|
2988
|
+
parameters: {
|
|
2989
|
+
query?: never;
|
|
2990
|
+
header?: never;
|
|
2991
|
+
path?: never;
|
|
2992
|
+
cookie?: never;
|
|
2993
|
+
};
|
|
2994
|
+
requestBody: {
|
|
2995
|
+
content: {
|
|
2996
|
+
"application/json": components["schemas"]["MoveResourceDTO"];
|
|
2997
|
+
};
|
|
2998
|
+
};
|
|
2999
|
+
responses: {
|
|
3000
|
+
204: {
|
|
3001
|
+
headers: {
|
|
3002
|
+
[name: string]: unknown;
|
|
3003
|
+
};
|
|
3004
|
+
content?: never;
|
|
3005
|
+
};
|
|
3006
|
+
400: {
|
|
3007
|
+
headers: {
|
|
3008
|
+
[name: string]: unknown;
|
|
3009
|
+
};
|
|
3010
|
+
content: {
|
|
3011
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3012
|
+
};
|
|
3013
|
+
};
|
|
3014
|
+
401: {
|
|
3015
|
+
headers: {
|
|
3016
|
+
[name: string]: unknown;
|
|
3017
|
+
};
|
|
3018
|
+
content: {
|
|
3019
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
403: {
|
|
3023
|
+
headers: {
|
|
3024
|
+
[name: string]: unknown;
|
|
3025
|
+
};
|
|
3026
|
+
content: {
|
|
3027
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3028
|
+
};
|
|
3029
|
+
};
|
|
3030
|
+
404: {
|
|
3031
|
+
headers: {
|
|
3032
|
+
[name: string]: unknown;
|
|
3033
|
+
};
|
|
3034
|
+
content: {
|
|
3035
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3036
|
+
};
|
|
3037
|
+
};
|
|
3038
|
+
default: {
|
|
3039
|
+
headers: {
|
|
3040
|
+
[name: string]: unknown;
|
|
3041
|
+
};
|
|
3042
|
+
content: {
|
|
3043
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3044
|
+
};
|
|
3045
|
+
};
|
|
3046
|
+
};
|
|
3047
|
+
};
|
|
2948
3048
|
"getMyndla-apiV1Robots": {
|
|
2949
3049
|
parameters: {
|
|
2950
3050
|
query?: never;
|
package/build/search-api.d.ts
CHANGED
|
@@ -211,13 +211,13 @@ export type components = {
|
|
|
211
211
|
pageSize?: number;
|
|
212
212
|
/** @description A list of article-types the search should be filtered by. */
|
|
213
213
|
articleTypes?: string[];
|
|
214
|
-
/** @description A list of context-types the
|
|
214
|
+
/** @description A list of context-types the resources should be filtered by. */
|
|
215
215
|
contextTypes?: string[];
|
|
216
216
|
/** @description The ISO 639-1 language code describing language. */
|
|
217
217
|
language?: string;
|
|
218
|
-
/** @description Return only
|
|
218
|
+
/** @description Return only resources that have one of the provided ids. */
|
|
219
219
|
ids?: number[];
|
|
220
|
-
/** @description Return only
|
|
220
|
+
/** @description Return only resources of specific type(s). */
|
|
221
221
|
resourceTypes?: string[];
|
|
222
222
|
/** @description Return only results with provided license. */
|
|
223
223
|
license?: string;
|
|
@@ -228,14 +228,17 @@ export type components = {
|
|
|
228
228
|
sort?: components["schemas"]["Sort"];
|
|
229
229
|
/** @description Fallback to existing language if language is specified. */
|
|
230
230
|
fallback?: boolean;
|
|
231
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* @description A comma separated list of subjects the resources should be filtered by (OR filter).
|
|
233
|
+
* Sending in an empty list can be used to filter for resources not in subjects.
|
|
234
|
+
*/
|
|
232
235
|
subjects?: string[];
|
|
233
|
-
/** @description A list of ISO 639-1 language codes that the
|
|
236
|
+
/** @description A list of ISO 639-1 language codes that the resource can be available in. */
|
|
234
237
|
languageFilter?: string[];
|
|
235
238
|
/**
|
|
236
|
-
* @description A list of relevances the
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
+
* @description A list of relevances the resources should be filtered by.
|
|
240
|
+
* If subjects are specified the resource must have specified relevances in relation to a specified subject.
|
|
241
|
+
* If levels are specified the resource must have specified relevances in relation to a specified level.
|
|
239
242
|
*/
|
|
240
243
|
relevance?: string[];
|
|
241
244
|
/**
|
|
@@ -244,7 +247,7 @@ export type components = {
|
|
|
244
247
|
* This value may change between scrolls. Always use the one in the latest scroll result.
|
|
245
248
|
*/
|
|
246
249
|
scrollId?: string;
|
|
247
|
-
/** @description List of statuses to filter by. A draft only needs to have one of the available statuses to be included in result (OR). */
|
|
250
|
+
/** @description List of statuses to filter by. A draft only needs to have one of the available statuses to be included in result (OR filter). */
|
|
248
251
|
draftStatus?: string[];
|
|
249
252
|
/**
|
|
250
253
|
* @description List of users to filter by.
|
|
@@ -258,7 +261,10 @@ export type components = {
|
|
|
258
261
|
traits?: components["schemas"]["ArticleTrait"][];
|
|
259
262
|
/** @description List of index-paths that should be term-aggregated and returned in result. */
|
|
260
263
|
aggregatePaths?: string[];
|
|
261
|
-
/**
|
|
264
|
+
/**
|
|
265
|
+
* @description Return only results with embed data-resource the specified resource.
|
|
266
|
+
* Can specify multiple with a comma separated list to filter for one of the embed types.
|
|
267
|
+
*/
|
|
262
268
|
embedResource?: string[];
|
|
263
269
|
/** @description Return only results with embed data-resource_id, data-videoid or data-url with the specified id. */
|
|
264
270
|
embedId?: string;
|
|
@@ -270,13 +276,16 @@ export type components = {
|
|
|
270
276
|
revisionDateTo?: string;
|
|
271
277
|
/** @description Set to true to avoid including hits from the revision history log. */
|
|
272
278
|
excludeRevisionLog?: boolean;
|
|
273
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* @description List of responsible ids to filter by (OR filter).
|
|
281
|
+
* Sending in an empty list can be used to filter for resources without responsible.
|
|
282
|
+
*/
|
|
274
283
|
responsibleIds?: string[];
|
|
275
284
|
/** @description Filter out inactive taxonomy contexts. */
|
|
276
285
|
filterInactive?: boolean;
|
|
277
286
|
/** @description List of priority-levels to filter by. */
|
|
278
287
|
priority?: components["schemas"]["Priority"][];
|
|
279
|
-
/** @description A list of parent topics the
|
|
288
|
+
/** @description A list of parent topics the resources should be filtered by. */
|
|
280
289
|
topics?: string[];
|
|
281
290
|
/** @description Return only results having published date after this date. */
|
|
282
291
|
publishedDateFrom?: string;
|