@ndla/types-backend 1.0.109 → 1.0.111
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 +158 -0
- package/build/search-api.d.ts +21 -12
- package/package.json +1 -1
package/build/draft-api.d.ts
CHANGED
|
@@ -496,6 +496,46 @@ export type paths = {
|
|
|
496
496
|
patch: operations["patchDraft-apiV1User-data"];
|
|
497
497
|
trace?: never;
|
|
498
498
|
};
|
|
499
|
+
"/draft-api/v1/user-data/responsibles": {
|
|
500
|
+
parameters: {
|
|
501
|
+
query?: never;
|
|
502
|
+
header?: never;
|
|
503
|
+
path?: never;
|
|
504
|
+
cookie?: never;
|
|
505
|
+
};
|
|
506
|
+
/**
|
|
507
|
+
* Get list of responsibles for drafts
|
|
508
|
+
* @description Get list of responsibles for drafts
|
|
509
|
+
*/
|
|
510
|
+
get: operations["getDraft-apiV1User-dataResponsibles"];
|
|
511
|
+
put?: never;
|
|
512
|
+
post?: never;
|
|
513
|
+
delete?: never;
|
|
514
|
+
options?: never;
|
|
515
|
+
head?: never;
|
|
516
|
+
patch?: never;
|
|
517
|
+
trace?: never;
|
|
518
|
+
};
|
|
519
|
+
"/draft-api/v1/user-data/editors": {
|
|
520
|
+
parameters: {
|
|
521
|
+
query?: never;
|
|
522
|
+
header?: never;
|
|
523
|
+
path?: never;
|
|
524
|
+
cookie?: never;
|
|
525
|
+
};
|
|
526
|
+
/**
|
|
527
|
+
* Get list of user IDs that have edited drafts
|
|
528
|
+
* @description Get list of user IDs from updatedBy and editor notes in drafts
|
|
529
|
+
*/
|
|
530
|
+
get: operations["getDraft-apiV1User-dataEditors"];
|
|
531
|
+
put?: never;
|
|
532
|
+
post?: never;
|
|
533
|
+
delete?: never;
|
|
534
|
+
options?: never;
|
|
535
|
+
head?: never;
|
|
536
|
+
patch?: never;
|
|
537
|
+
trace?: never;
|
|
538
|
+
};
|
|
499
539
|
};
|
|
500
540
|
export type webhooks = Record<string, never>;
|
|
501
541
|
export type components = {
|
|
@@ -3246,4 +3286,122 @@ export interface operations {
|
|
|
3246
3286
|
};
|
|
3247
3287
|
};
|
|
3248
3288
|
};
|
|
3289
|
+
"getDraft-apiV1User-dataResponsibles": {
|
|
3290
|
+
parameters: {
|
|
3291
|
+
query?: never;
|
|
3292
|
+
header?: never;
|
|
3293
|
+
path?: never;
|
|
3294
|
+
cookie?: never;
|
|
3295
|
+
};
|
|
3296
|
+
requestBody?: never;
|
|
3297
|
+
responses: {
|
|
3298
|
+
200: {
|
|
3299
|
+
headers: {
|
|
3300
|
+
[name: string]: unknown;
|
|
3301
|
+
};
|
|
3302
|
+
content: {
|
|
3303
|
+
"application/json": string[];
|
|
3304
|
+
};
|
|
3305
|
+
};
|
|
3306
|
+
400: {
|
|
3307
|
+
headers: {
|
|
3308
|
+
[name: string]: unknown;
|
|
3309
|
+
};
|
|
3310
|
+
content: {
|
|
3311
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3312
|
+
};
|
|
3313
|
+
};
|
|
3314
|
+
401: {
|
|
3315
|
+
headers: {
|
|
3316
|
+
[name: string]: unknown;
|
|
3317
|
+
};
|
|
3318
|
+
content: {
|
|
3319
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3320
|
+
};
|
|
3321
|
+
};
|
|
3322
|
+
403: {
|
|
3323
|
+
headers: {
|
|
3324
|
+
[name: string]: unknown;
|
|
3325
|
+
};
|
|
3326
|
+
content: {
|
|
3327
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3328
|
+
};
|
|
3329
|
+
};
|
|
3330
|
+
404: {
|
|
3331
|
+
headers: {
|
|
3332
|
+
[name: string]: unknown;
|
|
3333
|
+
};
|
|
3334
|
+
content: {
|
|
3335
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3336
|
+
};
|
|
3337
|
+
};
|
|
3338
|
+
default: {
|
|
3339
|
+
headers: {
|
|
3340
|
+
[name: string]: unknown;
|
|
3341
|
+
};
|
|
3342
|
+
content: {
|
|
3343
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3344
|
+
};
|
|
3345
|
+
};
|
|
3346
|
+
};
|
|
3347
|
+
};
|
|
3348
|
+
"getDraft-apiV1User-dataEditors": {
|
|
3349
|
+
parameters: {
|
|
3350
|
+
query?: never;
|
|
3351
|
+
header?: never;
|
|
3352
|
+
path?: never;
|
|
3353
|
+
cookie?: never;
|
|
3354
|
+
};
|
|
3355
|
+
requestBody?: never;
|
|
3356
|
+
responses: {
|
|
3357
|
+
200: {
|
|
3358
|
+
headers: {
|
|
3359
|
+
[name: string]: unknown;
|
|
3360
|
+
};
|
|
3361
|
+
content: {
|
|
3362
|
+
"application/json": string[];
|
|
3363
|
+
};
|
|
3364
|
+
};
|
|
3365
|
+
400: {
|
|
3366
|
+
headers: {
|
|
3367
|
+
[name: string]: unknown;
|
|
3368
|
+
};
|
|
3369
|
+
content: {
|
|
3370
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3371
|
+
};
|
|
3372
|
+
};
|
|
3373
|
+
401: {
|
|
3374
|
+
headers: {
|
|
3375
|
+
[name: string]: unknown;
|
|
3376
|
+
};
|
|
3377
|
+
content: {
|
|
3378
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3379
|
+
};
|
|
3380
|
+
};
|
|
3381
|
+
403: {
|
|
3382
|
+
headers: {
|
|
3383
|
+
[name: string]: unknown;
|
|
3384
|
+
};
|
|
3385
|
+
content: {
|
|
3386
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3387
|
+
};
|
|
3388
|
+
};
|
|
3389
|
+
404: {
|
|
3390
|
+
headers: {
|
|
3391
|
+
[name: string]: unknown;
|
|
3392
|
+
};
|
|
3393
|
+
content: {
|
|
3394
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
default: {
|
|
3398
|
+
headers: {
|
|
3399
|
+
[name: string]: unknown;
|
|
3400
|
+
};
|
|
3401
|
+
content: {
|
|
3402
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
3403
|
+
};
|
|
3404
|
+
};
|
|
3405
|
+
};
|
|
3406
|
+
};
|
|
3249
3407
|
}
|
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;
|