@ndla/types-backend 1.0.34 → 1.0.35

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 (61) hide show
  1. package/build/article-api-openapi.d.ts +1092 -0
  2. package/build/article-api-openapi.js +7 -0
  3. package/build/article-api-openapi.js.map +1 -0
  4. package/build/article-api.d.ts +57 -156
  5. package/build/article-api.js +27 -13
  6. package/build/article-api.js.map +1 -1
  7. package/build/audio-api-openapi.d.ts +2153 -0
  8. package/build/audio-api-openapi.js +7 -0
  9. package/build/audio-api-openapi.js.map +1 -0
  10. package/build/audio-api.d.ts +69 -190
  11. package/build/audio-api.js +27 -13
  12. package/build/audio-api.js.map +1 -1
  13. package/build/concept-api-openapi.d.ts +1682 -0
  14. package/build/concept-api-openapi.js +7 -0
  15. package/build/concept-api-openapi.js.map +1 -0
  16. package/build/concept-api.d.ts +69 -221
  17. package/build/concept-api.js +27 -21
  18. package/build/concept-api.js.map +1 -1
  19. package/build/draft-api-openapi.d.ts +2893 -0
  20. package/build/draft-api-openapi.js +7 -0
  21. package/build/draft-api-openapi.js.map +1 -0
  22. package/build/draft-api.d.ts +117 -292
  23. package/build/draft-api.js +27 -13
  24. package/build/draft-api.js.map +1 -1
  25. package/build/frontpage-api-openapi.d.ts +800 -0
  26. package/build/frontpage-api-openapi.js +7 -0
  27. package/build/frontpage-api-openapi.js.map +1 -0
  28. package/build/frontpage-api.d.ts +53 -121
  29. package/build/frontpage-api.js +27 -1
  30. package/build/frontpage-api.js.map +1 -1
  31. package/build/image-api-openapi.d.ts +2192 -0
  32. package/build/image-api-openapi.js +7 -0
  33. package/build/image-api-openapi.js.map +1 -0
  34. package/build/image-api.d.ts +61 -174
  35. package/build/image-api.js +27 -13
  36. package/build/image-api.js.map +1 -1
  37. package/build/learningpath-api-openapi.d.ts +2671 -0
  38. package/build/learningpath-api-openapi.js +7 -0
  39. package/build/learningpath-api-openapi.js.map +1 -0
  40. package/build/learningpath-api.d.ts +71 -143
  41. package/build/learningpath-api.js +27 -1
  42. package/build/learningpath-api.js.map +1 -1
  43. package/build/myndla-api-openapi.d.ts +2718 -0
  44. package/build/myndla-api-openapi.js +7 -0
  45. package/build/myndla-api-openapi.js.map +1 -0
  46. package/build/myndla-api.d.ts +69 -125
  47. package/build/myndla-api.js +27 -1
  48. package/build/myndla-api.js.map +1 -1
  49. package/build/oembed-proxy-openapi.d.ts +249 -0
  50. package/build/oembed-proxy-openapi.js +7 -0
  51. package/build/oembed-proxy-openapi.js.map +1 -0
  52. package/build/oembed-proxy.d.ts +15 -0
  53. package/build/oembed-proxy.js +30 -0
  54. package/build/oembed-proxy.js.map +1 -0
  55. package/build/search-api-openapi.d.ts +1525 -0
  56. package/build/search-api-openapi.js +7 -0
  57. package/build/search-api-openapi.js.map +1 -0
  58. package/build/search-api.d.ts +121 -422
  59. package/build/search-api.js +27 -33
  60. package/build/search-api.js.map +1 -1
  61. package/package.json +2 -1
@@ -0,0 +1,2893 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export type paths = {
6
+ "/draft-api/v1/drafts/licenses": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * Show all valid licenses
15
+ * @description Shows all valid licenses
16
+ */
17
+ get: operations["getDraft-apiV1DraftsLicenses"];
18
+ put?: never;
19
+ post?: never;
20
+ delete?: never;
21
+ options?: never;
22
+ head?: never;
23
+ patch?: never;
24
+ trace?: never;
25
+ };
26
+ "/draft-api/v1/drafts/tag-search": {
27
+ parameters: {
28
+ query?: never;
29
+ header?: never;
30
+ path?: never;
31
+ cookie?: never;
32
+ };
33
+ /**
34
+ * Retrieves a list of all previously used tags in articles
35
+ * @description Retrieves a list of all previously used tags in articles
36
+ */
37
+ get: operations["getDraft-apiV1DraftsTag-search"];
38
+ put?: never;
39
+ post?: never;
40
+ delete?: never;
41
+ options?: never;
42
+ head?: never;
43
+ patch?: never;
44
+ trace?: never;
45
+ };
46
+ "/draft-api/v1/drafts/grep-codes": {
47
+ parameters: {
48
+ query?: never;
49
+ header?: never;
50
+ path?: never;
51
+ cookie?: never;
52
+ };
53
+ /**
54
+ * Retrieves a list of all previously used grepCodes in articles
55
+ * @deprecated
56
+ * @description Retrieves a list of all previously used grepCodes in articles
57
+ */
58
+ get: operations["getDraft-apiV1DraftsGrep-codes"];
59
+ put?: never;
60
+ post?: never;
61
+ delete?: never;
62
+ options?: never;
63
+ head?: never;
64
+ patch?: never;
65
+ trace?: never;
66
+ };
67
+ "/draft-api/v1/drafts": {
68
+ parameters: {
69
+ query?: never;
70
+ header?: never;
71
+ path?: never;
72
+ cookie?: never;
73
+ };
74
+ /**
75
+ * Show all articles
76
+ * @description Shows all articles. You can search it too.
77
+ */
78
+ get: operations["getDraft-apiV1Drafts"];
79
+ put?: never;
80
+ /**
81
+ * Create a new article
82
+ * @description Creates a new article
83
+ */
84
+ post: operations["postDraft-apiV1Drafts"];
85
+ delete?: never;
86
+ options?: never;
87
+ head?: never;
88
+ patch?: never;
89
+ trace?: never;
90
+ };
91
+ "/draft-api/v1/drafts/search": {
92
+ parameters: {
93
+ query?: never;
94
+ header?: never;
95
+ path?: never;
96
+ cookie?: never;
97
+ };
98
+ get?: never;
99
+ put?: never;
100
+ /**
101
+ * Show all articles
102
+ * @description Shows all articles. You can search it too.
103
+ */
104
+ post: operations["postDraft-apiV1DraftsSearch"];
105
+ delete?: never;
106
+ options?: never;
107
+ head?: never;
108
+ patch?: never;
109
+ trace?: never;
110
+ };
111
+ "/draft-api/v1/drafts/status-state-machine": {
112
+ parameters: {
113
+ query?: never;
114
+ header?: never;
115
+ path?: never;
116
+ cookie?: never;
117
+ };
118
+ /**
119
+ * Get status state machine
120
+ * @description Get status state machine
121
+ */
122
+ get: operations["getDraft-apiV1DraftsStatus-state-machine"];
123
+ put?: never;
124
+ post?: never;
125
+ delete?: never;
126
+ options?: never;
127
+ head?: never;
128
+ patch?: never;
129
+ trace?: never;
130
+ };
131
+ "/draft-api/v1/drafts/ids": {
132
+ parameters: {
133
+ query?: never;
134
+ header?: never;
135
+ path?: never;
136
+ cookie?: never;
137
+ };
138
+ /**
139
+ * Fetch articles that matches ids parameter.
140
+ * @description Returns articles that matches ids parameter.
141
+ */
142
+ get: operations["getDraft-apiV1DraftsIds"];
143
+ put?: never;
144
+ post?: never;
145
+ delete?: never;
146
+ options?: never;
147
+ head?: never;
148
+ patch?: never;
149
+ trace?: never;
150
+ };
151
+ "/draft-api/v1/drafts/{article_id}": {
152
+ parameters: {
153
+ query?: never;
154
+ header?: never;
155
+ path?: never;
156
+ cookie?: never;
157
+ };
158
+ /**
159
+ * Show article with a specified Id
160
+ * @description Shows the article for the specified id.
161
+ */
162
+ get: operations["getDraft-apiV1DraftsArticle_id"];
163
+ put?: never;
164
+ post?: never;
165
+ delete?: never;
166
+ options?: never;
167
+ head?: never;
168
+ /**
169
+ * Update an existing article
170
+ * @description Update an existing article
171
+ */
172
+ patch: operations["patchDraft-apiV1DraftsArticle_id"];
173
+ trace?: never;
174
+ };
175
+ "/draft-api/v1/drafts/{article_id}/history": {
176
+ parameters: {
177
+ query?: never;
178
+ header?: never;
179
+ path?: never;
180
+ cookie?: never;
181
+ };
182
+ /**
183
+ * Get all saved articles with a specified Id, latest revision first
184
+ * @description Retrieves all current and previously published articles with the specified id, latest revision first.
185
+ */
186
+ get: operations["getDraft-apiV1DraftsArticle_idHistory"];
187
+ put?: never;
188
+ post?: never;
189
+ delete?: never;
190
+ options?: never;
191
+ head?: never;
192
+ patch?: never;
193
+ trace?: never;
194
+ };
195
+ "/draft-api/v1/drafts/external_id/{deprecated_node_id}": {
196
+ parameters: {
197
+ query?: never;
198
+ header?: never;
199
+ path?: never;
200
+ cookie?: never;
201
+ };
202
+ /**
203
+ * Get internal id of article for a specified ndla_node_id
204
+ * @description Get internal id of article for a specified ndla_node_id
205
+ */
206
+ get: operations["getDraft-apiV1DraftsExternal_idDeprecated_node_id"];
207
+ put?: never;
208
+ post?: never;
209
+ delete?: never;
210
+ options?: never;
211
+ head?: never;
212
+ patch?: never;
213
+ trace?: never;
214
+ };
215
+ "/draft-api/v1/drafts/{article_id}/status/{STATUS}": {
216
+ parameters: {
217
+ query?: never;
218
+ header?: never;
219
+ path?: never;
220
+ cookie?: never;
221
+ };
222
+ get?: never;
223
+ /**
224
+ * Update status of an article
225
+ * @description Update status of an article
226
+ */
227
+ put: operations["putDraft-apiV1DraftsArticle_idStatusStatus"];
228
+ post?: never;
229
+ delete?: never;
230
+ options?: never;
231
+ head?: never;
232
+ patch?: never;
233
+ trace?: never;
234
+ };
235
+ "/draft-api/v1/drafts/{article_id}/validate": {
236
+ parameters: {
237
+ query?: never;
238
+ header?: never;
239
+ path?: never;
240
+ cookie?: never;
241
+ };
242
+ get?: never;
243
+ /**
244
+ * Validate an article
245
+ * @description Validate an article
246
+ */
247
+ put: operations["putDraft-apiV1DraftsArticle_idValidate"];
248
+ post?: never;
249
+ delete?: never;
250
+ options?: never;
251
+ head?: never;
252
+ patch?: never;
253
+ trace?: never;
254
+ };
255
+ "/draft-api/v1/drafts/{article_id}/language/{language}": {
256
+ parameters: {
257
+ query?: never;
258
+ header?: never;
259
+ path?: never;
260
+ cookie?: never;
261
+ };
262
+ get?: never;
263
+ put?: never;
264
+ post?: never;
265
+ /**
266
+ * Delete language from article
267
+ * @description Delete language from article
268
+ */
269
+ delete: operations["deleteDraft-apiV1DraftsArticle_idLanguageLanguage"];
270
+ options?: never;
271
+ head?: never;
272
+ patch?: never;
273
+ trace?: never;
274
+ };
275
+ "/draft-api/v1/drafts/clone/{article_id}": {
276
+ parameters: {
277
+ query?: never;
278
+ header?: never;
279
+ path?: never;
280
+ cookie?: never;
281
+ };
282
+ get?: never;
283
+ put?: never;
284
+ /**
285
+ * Create a new article with the content of the article with the specified id
286
+ * @description Create a new article with the content of the article with the specified id
287
+ */
288
+ post: operations["postDraft-apiV1DraftsCloneArticle_id"];
289
+ delete?: never;
290
+ options?: never;
291
+ head?: never;
292
+ patch?: never;
293
+ trace?: never;
294
+ };
295
+ "/draft-api/v1/drafts/partial-publish/{article_id}": {
296
+ parameters: {
297
+ query?: never;
298
+ header?: never;
299
+ path?: never;
300
+ cookie?: never;
301
+ };
302
+ get?: never;
303
+ put?: never;
304
+ /**
305
+ * Partial publish selected fields
306
+ * @description Partial publish selected fields
307
+ */
308
+ post: operations["postDraft-apiV1DraftsPartial-publishArticle_id"];
309
+ delete?: never;
310
+ options?: never;
311
+ head?: never;
312
+ patch?: never;
313
+ trace?: never;
314
+ };
315
+ "/draft-api/v1/drafts/partial-publish": {
316
+ parameters: {
317
+ query?: never;
318
+ header?: never;
319
+ path?: never;
320
+ cookie?: never;
321
+ };
322
+ get?: never;
323
+ put?: never;
324
+ /**
325
+ * Partial publish selected fields for multiple articles
326
+ * @description Partial publish selected fields for multiple articles
327
+ */
328
+ post: operations["postDraft-apiV1DraftsPartial-publish"];
329
+ delete?: never;
330
+ options?: never;
331
+ head?: never;
332
+ patch?: never;
333
+ trace?: never;
334
+ };
335
+ "/draft-api/v1/drafts/copyRevisionDates/{node_id}": {
336
+ parameters: {
337
+ query?: never;
338
+ header?: never;
339
+ path?: never;
340
+ cookie?: never;
341
+ };
342
+ get?: never;
343
+ put?: never;
344
+ /**
345
+ * Copy revision dates from the node with this id to _all_ children in taxonomy
346
+ * @description Copy revision dates from the node with this id to _all_ children in taxonomy
347
+ */
348
+ post: operations["postDraft-apiV1DraftsCopyrevisiondatesNode_id"];
349
+ delete?: never;
350
+ options?: never;
351
+ head?: never;
352
+ patch?: never;
353
+ trace?: never;
354
+ };
355
+ "/draft-api/v1/drafts/slug/{slug}": {
356
+ parameters: {
357
+ query?: never;
358
+ header?: never;
359
+ path?: never;
360
+ cookie?: never;
361
+ };
362
+ /**
363
+ * Show article with a specified slug
364
+ * @description Shows the article for the specified slug.
365
+ */
366
+ get: operations["getDraft-apiV1DraftsSlugSlug"];
367
+ put?: never;
368
+ post?: never;
369
+ delete?: never;
370
+ options?: never;
371
+ head?: never;
372
+ patch?: never;
373
+ trace?: never;
374
+ };
375
+ "/draft-api/v1/drafts/migrate-greps": {
376
+ parameters: {
377
+ query?: never;
378
+ header?: never;
379
+ path?: never;
380
+ cookie?: never;
381
+ };
382
+ get?: never;
383
+ put?: never;
384
+ /**
385
+ * Iterate all articles and migrate outdated grep codes
386
+ * @description Iterate all articles and migrate outdated grep codes
387
+ */
388
+ post: operations["postDraft-apiV1DraftsMigrate-greps"];
389
+ delete?: never;
390
+ options?: never;
391
+ head?: never;
392
+ patch?: never;
393
+ trace?: never;
394
+ };
395
+ "/draft-api/v1/files": {
396
+ parameters: {
397
+ query?: never;
398
+ header?: never;
399
+ path?: never;
400
+ cookie?: never;
401
+ };
402
+ get?: never;
403
+ put?: never;
404
+ /**
405
+ * Uploads provided file
406
+ * @description Uploads provided file
407
+ */
408
+ post: operations["postDraft-apiV1Files"];
409
+ /**
410
+ * Deletes provided file
411
+ * @description Deletes provided file
412
+ */
413
+ delete: operations["deleteDraft-apiV1Files"];
414
+ options?: never;
415
+ head?: never;
416
+ patch?: never;
417
+ trace?: never;
418
+ };
419
+ "/draft-api/v1/user-data": {
420
+ parameters: {
421
+ query?: never;
422
+ header?: never;
423
+ path?: never;
424
+ cookie?: never;
425
+ };
426
+ /**
427
+ * Retrieves user's data
428
+ * @description Retrieves user's data
429
+ */
430
+ get: operations["getDraft-apiV1User-data"];
431
+ put?: never;
432
+ post?: never;
433
+ delete?: never;
434
+ options?: never;
435
+ head?: never;
436
+ /**
437
+ * Update data of logged in user
438
+ * @description Update data of logged in user
439
+ */
440
+ patch: operations["patchDraft-apiV1User-data"];
441
+ trace?: never;
442
+ };
443
+ };
444
+ export type webhooks = Record<string, never>;
445
+ export type components = {
446
+ schemas: {
447
+ /** AllErrors */
448
+ AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
449
+ /**
450
+ * ArticleContentDTO
451
+ * @description The content of the article in available languages
452
+ */
453
+ ArticleContentDTO: {
454
+ /** @description The html content */
455
+ content: string;
456
+ /** @description ISO 639-1 code that represents the language used in the content */
457
+ language: string;
458
+ };
459
+ /**
460
+ * ArticleDTO
461
+ * @description Information about the article
462
+ */
463
+ ArticleDTO: {
464
+ /**
465
+ * Format: int64
466
+ * @description The unique id of the article
467
+ */
468
+ id: number;
469
+ /** @description Link to article on old platform */
470
+ oldNdlaUrl?: string;
471
+ /**
472
+ * Format: int32
473
+ * @description The revision number for the article
474
+ */
475
+ revision: number;
476
+ /** @description The status of this article */
477
+ status: components["schemas"]["StatusDTO"];
478
+ /** @description Available titles for the article */
479
+ title?: components["schemas"]["ArticleTitleDTO"];
480
+ content?: components["schemas"]["ArticleContentDTO"];
481
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
482
+ tags?: components["schemas"]["ArticleTagDTO"];
483
+ /** @description Required libraries in order to render the article */
484
+ requiredLibraries: components["schemas"]["RequiredLibraryDTO"][];
485
+ visualElement?: components["schemas"]["VisualElementDTO"];
486
+ introduction?: components["schemas"]["ArticleIntroductionDTO"];
487
+ metaDescription?: components["schemas"]["ArticleMetaDescriptionDTO"];
488
+ metaImage?: components["schemas"]["ArticleMetaImageDTO"];
489
+ /** @description When the article was created */
490
+ created: string;
491
+ /** @description When the article was last updated */
492
+ updated: string;
493
+ /** @description By whom the article was last updated */
494
+ updatedBy: string;
495
+ /** @description When the article was last published */
496
+ published: string;
497
+ /** @description The type of article this is. Possible values are frontpage-article, standard, topic-article */
498
+ articleType: string;
499
+ /** @description The languages this article supports */
500
+ supportedLanguages: string[];
501
+ /** @description The notes for this article draft */
502
+ notes: components["schemas"]["EditorNoteDTO"][];
503
+ /** @description The labels attached to this article; meant for editors. */
504
+ editorLabels: string[];
505
+ /** @description A list of codes from GREP API connected to the article */
506
+ grepCodes: string[];
507
+ /** @description A list of conceptIds connected to the article */
508
+ conceptIds: number[];
509
+ /** @description Value that dictates who gets to see the article. Possible values are: everyone/teacher */
510
+ availability: string;
511
+ /** @description A list of content related to the article */
512
+ relatedContent: (components["schemas"]["RelatedContentLinkDTO"] | number)[];
513
+ /** @description A list of revisions planned for the article */
514
+ revisions: components["schemas"]["RevisionMetaDTO"][];
515
+ responsible?: components["schemas"]["DraftResponsibleDTO"];
516
+ /** @description The path to the frontpage article */
517
+ slug?: string;
518
+ /** @description Information about comments attached to the article */
519
+ comments: components["schemas"]["CommentDTO"][];
520
+ /** @description If the article should be prioritized */
521
+ prioritized: boolean;
522
+ /** @description If the article should be prioritized. Possible values are prioritized, on-hold, unspecified */
523
+ priority: string;
524
+ /** @description If the article has been edited after last status or responsible change */
525
+ started: boolean;
526
+ qualityEvaluation?: components["schemas"]["QualityEvaluationDTO"];
527
+ disclaimer?: components["schemas"]["DisclaimerDTO"];
528
+ };
529
+ /**
530
+ * ArticleIntroductionDTO
531
+ * @description An introduction for the article
532
+ */
533
+ ArticleIntroductionDTO: {
534
+ /** @description The introduction content */
535
+ introduction: string;
536
+ /** @description The html introduction content */
537
+ htmlIntroduction: string;
538
+ /** @description The ISO 639-1 language code describing which article translation this introduction belongs to */
539
+ language: string;
540
+ };
541
+ /**
542
+ * ArticleMetaDescriptionDTO
543
+ * @description Meta description for the article
544
+ */
545
+ ArticleMetaDescriptionDTO: {
546
+ /** @description The meta description */
547
+ metaDescription: string;
548
+ /** @description The ISO 639-1 language code describing which article translation this meta description belongs to */
549
+ language: string;
550
+ };
551
+ /**
552
+ * ArticleMetaImageDTO
553
+ * @description Meta image for the article
554
+ */
555
+ ArticleMetaImageDTO: {
556
+ /** @description The meta image */
557
+ url: string;
558
+ /** @description The meta image alt text */
559
+ alt: string;
560
+ /** @description The ISO 639-1 language code describing which article translation this meta image belongs to */
561
+ language: string;
562
+ };
563
+ /**
564
+ * ArticleSearchParamsDTO
565
+ * @description The search parameters
566
+ */
567
+ ArticleSearchParamsDTO: {
568
+ /** @description The search query */
569
+ query?: string;
570
+ /** @description The ISO 639-1 language code describing language used in query-params */
571
+ language?: string;
572
+ /** @description Return only articles with provided license. */
573
+ license?: string;
574
+ /**
575
+ * Format: int32
576
+ * @description The page number of the search hits to display.
577
+ */
578
+ page?: number;
579
+ /**
580
+ * Format: int32
581
+ * @description The number of search hits to display for each page.
582
+ */
583
+ pageSize?: number;
584
+ /** @description Return only articles that have one of the provided ids */
585
+ ids?: number[];
586
+ /** @description Return only articles of specific type(s) */
587
+ articleTypes?: string[];
588
+ sort?: components["schemas"]["Sort"];
589
+ /** @description A search context retrieved from the response header of a previous search. */
590
+ scrollId?: string;
591
+ /** @description Fallback to some existing language if language is specified. */
592
+ fallback?: boolean;
593
+ /** @description Return only articles containing codes from GREP API */
594
+ grepCodes?: string[];
595
+ };
596
+ /**
597
+ * ArticleSearchResultDTO
598
+ * @description Information about search-results
599
+ */
600
+ ArticleSearchResultDTO: {
601
+ /**
602
+ * Format: int64
603
+ * @description The total number of articles matching this query
604
+ */
605
+ totalCount: number;
606
+ /**
607
+ * Format: int32
608
+ * @description For which page results are shown from
609
+ */
610
+ page?: number;
611
+ /**
612
+ * Format: int32
613
+ * @description The number of results per page
614
+ */
615
+ pageSize: number;
616
+ /** @description The search results */
617
+ results: components["schemas"]["ArticleSummaryDTO"][];
618
+ };
619
+ /**
620
+ * ArticleSummaryDTO
621
+ * @description Short summary of information about the article
622
+ */
623
+ ArticleSummaryDTO: {
624
+ /**
625
+ * Format: int64
626
+ * @description The unique id of the article
627
+ */
628
+ id: number;
629
+ /** @description The title of the article */
630
+ title: components["schemas"]["ArticleTitleDTO"];
631
+ visualElement?: components["schemas"]["VisualElementDTO"];
632
+ introduction?: components["schemas"]["ArticleIntroductionDTO"];
633
+ /** @description The full url to where the complete information about the article can be found */
634
+ url: string;
635
+ /** @description Describes the license of the article */
636
+ license: string;
637
+ /** @description The type of article this is. Possible values are frontpage-article, standard, topic-article */
638
+ articleType: string;
639
+ /** @description A list of available languages for this audio */
640
+ supportedLanguages: string[];
641
+ tags?: components["schemas"]["ArticleTagDTO"];
642
+ /** @description The notes for this draft article */
643
+ notes: string[];
644
+ /** @description The users saved for this draft article */
645
+ users: string[];
646
+ /** @description The codes from GREP API registered for this draft article */
647
+ grepCodes: string[];
648
+ /** @description The status of this article */
649
+ status: components["schemas"]["StatusDTO"];
650
+ /** @description When the article was last updated */
651
+ updated: string;
652
+ };
653
+ /**
654
+ * ArticleTagDTO
655
+ * @description Searchable tags for the article
656
+ */
657
+ ArticleTagDTO: {
658
+ /** @description The searchable tag. */
659
+ tags: string[];
660
+ /** @description ISO 639-1 code that represents the language used in tag */
661
+ language: string;
662
+ };
663
+ /** ArticleTitleDTO */
664
+ ArticleTitleDTO: {
665
+ /** @description The freetext title of the article */
666
+ title: string;
667
+ /** @description The freetext html title of the article */
668
+ htmlTitle: string;
669
+ /** @description ISO 639-1 code that represents the language used in title */
670
+ language: string;
671
+ };
672
+ /**
673
+ * AuthorDTO
674
+ * @description Information about an author
675
+ */
676
+ AuthorDTO: {
677
+ type: components["schemas"]["ContributorType"];
678
+ /** @description The name of the of the author */
679
+ name: string;
680
+ };
681
+ /**
682
+ * CommentDTO
683
+ * @description Information about a comment attached to an article
684
+ */
685
+ CommentDTO: {
686
+ /** @description Id of the comment */
687
+ id: string;
688
+ /** @description Content of the comment */
689
+ content: string;
690
+ /** @description When the comment was created */
691
+ created: string;
692
+ /** @description When the comment was last updated */
693
+ updated: string;
694
+ /** @description If the comment is open or closed */
695
+ isOpen: boolean;
696
+ /** @description If the comment is solved or not */
697
+ solved: boolean;
698
+ };
699
+ /**
700
+ * ContentIdDTO
701
+ * @description Id for a single Article
702
+ */
703
+ ContentIdDTO: {
704
+ /**
705
+ * Format: int64
706
+ * @description The unique id of the article
707
+ */
708
+ id: number;
709
+ };
710
+ /**
711
+ * ContributorType
712
+ * @description The description of the author. Eg. Photographer or Supplier
713
+ * @enum {string}
714
+ */
715
+ ContributorType: "artist" | "cowriter" | "compiler" | "composer" | "correction" | "director" | "distributor" | "editorial" | "facilitator" | "idea" | "illustrator" | "linguistic" | "originator" | "photographer" | "processor" | "publisher" | "reader" | "rightsholder" | "scriptwriter" | "supplier" | "translator" | "writer";
716
+ /**
717
+ * DisclaimerDTO
718
+ * @description The disclaimer of the article
719
+ */
720
+ DisclaimerDTO: {
721
+ /** @description The freetext html content of the disclaimer */
722
+ disclaimer: string;
723
+ /** @description ISO 639-1 code that represents the language used in the disclaimer */
724
+ language: string;
725
+ };
726
+ /**
727
+ * DraftCopyrightDTO
728
+ * @description Describes the copyright information for the article
729
+ */
730
+ DraftCopyrightDTO: {
731
+ /** @description Describes the license of the article */
732
+ license?: components["schemas"]["LicenseDTO"];
733
+ /** @description Reference to where the article is procured */
734
+ origin?: string;
735
+ /** @description List of creators */
736
+ creators: components["schemas"]["AuthorDTO"][];
737
+ /** @description List of processors */
738
+ processors: components["schemas"]["AuthorDTO"][];
739
+ /** @description List of rightsholders */
740
+ rightsholders: components["schemas"]["AuthorDTO"][];
741
+ /** @description Date from which the copyright is valid */
742
+ validFrom?: string;
743
+ /** @description Date to which the copyright is valid */
744
+ validTo?: string;
745
+ /** @description Whether or not the content has been processed */
746
+ processed: boolean;
747
+ };
748
+ /**
749
+ * DraftResponsibleDTO
750
+ * @description Object with data representing the editor responsible for this article
751
+ */
752
+ DraftResponsibleDTO: {
753
+ /** @description NDLA ID of responsible editor */
754
+ responsibleId: string;
755
+ /** @description Date of when the responsible editor was last updated */
756
+ lastUpdated: string;
757
+ };
758
+ /**
759
+ * EditorNoteDTO
760
+ * @description Information about the editorial notes
761
+ */
762
+ EditorNoteDTO: {
763
+ /** @description Editorial note */
764
+ note: string;
765
+ /** @description User which saved the note */
766
+ user: string;
767
+ /** @description Status of article at saved time */
768
+ status: components["schemas"]["StatusDTO"];
769
+ /** @description Timestamp of when note was saved */
770
+ timestamp: string;
771
+ };
772
+ /**
773
+ * ErrorBody
774
+ * @description Information about an error
775
+ */
776
+ ErrorBody: {
777
+ /** @description Code stating the type of error */
778
+ code: string;
779
+ /** @description Description of the error */
780
+ description: string;
781
+ /** @description When the error occurred */
782
+ occurredAt: string;
783
+ /**
784
+ * Format: int32
785
+ * @description Numeric http status code
786
+ */
787
+ statusCode: number;
788
+ };
789
+ /** FileForm */
790
+ FileForm: {
791
+ /** Format: binary */
792
+ file: string;
793
+ };
794
+ /**
795
+ * Grade
796
+ * Format: int32
797
+ * @description The grade (1-5) of the article
798
+ * @enum {integer}
799
+ */
800
+ Grade: 1 | 2 | 3 | 4 | 5;
801
+ /**
802
+ * GrepCodesSearchResultDTO
803
+ * @description Information and metadata about codes from GREP API
804
+ */
805
+ GrepCodesSearchResultDTO: {
806
+ /**
807
+ * Format: int64
808
+ * @description The total number of codes from GREP API matching this query
809
+ */
810
+ totalCount: number;
811
+ /**
812
+ * Format: int32
813
+ * @description For which page results are shown from
814
+ */
815
+ page: number;
816
+ /**
817
+ * Format: int32
818
+ * @description The number of results per page
819
+ */
820
+ pageSize: number;
821
+ /** @description The search results */
822
+ results: string[];
823
+ };
824
+ /** LicenseDTO */
825
+ LicenseDTO: {
826
+ /** @description The name of the license */
827
+ license: string;
828
+ /** @description Description of the license */
829
+ description?: string;
830
+ /** @description Url to where the license can be found */
831
+ url?: string;
832
+ };
833
+ /** Map_List_String */
834
+ Map_List_String: {
835
+ [key: string]: string[];
836
+ };
837
+ /**
838
+ * MultiPartialPublishResultDTO
839
+ * @description A list of articles that were partial published to article-api
840
+ */
841
+ MultiPartialPublishResultDTO: {
842
+ /** @description Successful ids */
843
+ successes: number[];
844
+ /** @description Failed ids with error messages */
845
+ failures: components["schemas"]["PartialPublishFailureDTO"][];
846
+ };
847
+ /**
848
+ * NewArticleDTO
849
+ * @description Information about the article
850
+ */
851
+ NewArticleDTO: {
852
+ /** @description The chosen language */
853
+ language: string;
854
+ /** @description The title of the article */
855
+ title: string;
856
+ /** @description The date the article is published */
857
+ published?: string;
858
+ /** @description The content of the article */
859
+ content?: string;
860
+ /** @description Searchable tags */
861
+ tags?: string[];
862
+ /** @description An introduction */
863
+ introduction?: string;
864
+ /** @description A meta description */
865
+ metaDescription?: string;
866
+ /** @description Meta image for the article */
867
+ metaImage?: components["schemas"]["NewArticleMetaImageDTO"];
868
+ /** @description A visual element for the article. May be anything from an image to a video or H5P */
869
+ visualElement?: string;
870
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
871
+ /** @description Required libraries in order to render the article */
872
+ requiredLibraries?: components["schemas"]["RequiredLibraryDTO"][];
873
+ /** @description The type of article this is. Possible values are frontpage-article, standard, topic-article */
874
+ articleType: string;
875
+ /** @description The notes for this article draft */
876
+ notes?: string[];
877
+ /** @description The labels attached to this article; meant for editors. */
878
+ editorLabels?: string[];
879
+ /** @description A list of codes from GREP API connected to the article */
880
+ grepCodes?: string[];
881
+ /** @description A list of conceptIds connected to the article */
882
+ conceptIds?: number[];
883
+ /** @description Value that dictates who gets to see the article. Possible values are: everyone/teacher */
884
+ availability?: string;
885
+ /** @description A list of content related to the article */
886
+ relatedContent?: (components["schemas"]["RelatedContentLinkDTO"] | number)[];
887
+ /** @description An object describing a future revision */
888
+ revisionMeta?: components["schemas"]["RevisionMetaDTO"][];
889
+ /** @description NDLA ID representing the editor responsible for this article */
890
+ responsibleId?: string;
891
+ /** @description The path to the frontpage article */
892
+ slug?: string;
893
+ /** @description Information about a comment attached to an article */
894
+ comments?: components["schemas"]["NewCommentDTO"][];
895
+ /** @description If the article should be prioritized */
896
+ prioritized?: boolean;
897
+ /** @description If the article should be prioritized. Possible values are prioritized, on-hold, unspecified */
898
+ priority?: string;
899
+ qualityEvaluation?: components["schemas"]["QualityEvaluationDTO"];
900
+ /** @description The disclaimer of the article */
901
+ disclaimer?: string;
902
+ };
903
+ /** NewArticleMetaImageDTO */
904
+ NewArticleMetaImageDTO: {
905
+ /** @description The image-api id of the meta image */
906
+ id: string;
907
+ /** @description The alt text of the meta image */
908
+ alt: string;
909
+ };
910
+ /**
911
+ * NewCommentDTO
912
+ * @description Information about a comment attached to an article
913
+ */
914
+ NewCommentDTO: {
915
+ /** @description Content of the comment */
916
+ content: string;
917
+ /** @description If the comment is open or closed */
918
+ isOpen?: boolean;
919
+ };
920
+ /**
921
+ * NotFoundWithSupportedLanguages
922
+ * @description Information about an error
923
+ */
924
+ NotFoundWithSupportedLanguages: {
925
+ /** @description Code stating the type of error */
926
+ code: string;
927
+ /** @description Description of the error */
928
+ description: string;
929
+ /** @description When the error occurred */
930
+ occurredAt: string;
931
+ /** @description List of supported languages */
932
+ supportedLanguages?: string[];
933
+ /**
934
+ * Format: int32
935
+ * @description Numeric http status code
936
+ */
937
+ statusCode: number;
938
+ };
939
+ /** PartialArticleFieldsDTO */
940
+ PartialArticleFieldsDTO: components["schemas"]["availability"] | components["schemas"]["grepCodes"] | components["schemas"]["license"] | components["schemas"]["metaDescription"] | components["schemas"]["published"] | components["schemas"]["relatedContent"] | components["schemas"]["revisionDate"] | components["schemas"]["tags"];
941
+ /**
942
+ * PartialBulkArticlesDTO
943
+ * @description Partial data about articles to publish in bulk
944
+ */
945
+ PartialBulkArticlesDTO: {
946
+ /** @description A list of article ids to partially publish */
947
+ articleIds: number[];
948
+ /** @description A list of fields that should be partially published */
949
+ fields: components["schemas"]["PartialArticleFieldsDTO"][];
950
+ };
951
+ /**
952
+ * PartialPublishFailureDTO
953
+ * @description Single failed result
954
+ */
955
+ PartialPublishFailureDTO: {
956
+ /**
957
+ * Format: int64
958
+ * @description Id of the article in question
959
+ */
960
+ id: number;
961
+ /** @description Error message */
962
+ message: string;
963
+ };
964
+ /**
965
+ * QualityEvaluationDTO
966
+ * @description The quality evaluation of the article. Consist of a score from 1 to 5 and a comment.
967
+ */
968
+ QualityEvaluationDTO: {
969
+ grade: components["schemas"]["Grade"];
970
+ /** @description Note explaining the score */
971
+ note?: string;
972
+ };
973
+ /**
974
+ * RelatedContentLinkDTO
975
+ * @description External link related to the article
976
+ */
977
+ RelatedContentLinkDTO: {
978
+ /** @description Title of the article */
979
+ title: string;
980
+ /** @description The url to where the article can be viewed */
981
+ url: string;
982
+ };
983
+ /**
984
+ * RequiredLibraryDTO
985
+ * @description Information about a library required to render the article
986
+ */
987
+ RequiredLibraryDTO: {
988
+ /** @description The type of the library. E.g. CSS or JavaScript */
989
+ mediaType: string;
990
+ /** @description The name of the library */
991
+ name: string;
992
+ /** @description The full url to where the library can be downloaded */
993
+ url: string;
994
+ };
995
+ /**
996
+ * RevisionMetaDTO
997
+ * @description Information about the editorial notes
998
+ */
999
+ RevisionMetaDTO: {
1000
+ /** @description An unique uuid of the revision. If none supplied, one is generated. */
1001
+ id?: string;
1002
+ /** @description A date on which the article would need to be revised */
1003
+ revisionDate: string;
1004
+ /** @description Notes to keep track of what needs to happen before revision */
1005
+ note: string;
1006
+ /** @description Status of a revision, either 'revised' or 'needs-revision' */
1007
+ status: string;
1008
+ };
1009
+ /**
1010
+ * SavedSearchDTO
1011
+ * @description Information about saved search
1012
+ */
1013
+ SavedSearchDTO: {
1014
+ /** @description The search url */
1015
+ searchUrl: string;
1016
+ /** @description The search phrase */
1017
+ searchPhrase: string;
1018
+ };
1019
+ /**
1020
+ * Sort
1021
+ * @description The sorting used on results. Default is by -relevance.
1022
+ * @enum {string}
1023
+ */
1024
+ Sort: "-relevance" | "relevance" | "-title" | "title" | "-lastUpdated" | "lastUpdated" | "-id" | "id";
1025
+ /** StatusDTO */
1026
+ StatusDTO: {
1027
+ /** @description The current status of the article */
1028
+ current: string;
1029
+ /** @description Previous statuses this article has been in */
1030
+ other: string[];
1031
+ };
1032
+ /**
1033
+ * TagsSearchResultDTO
1034
+ * @description Information about tags-search-results
1035
+ */
1036
+ TagsSearchResultDTO: {
1037
+ /**
1038
+ * Format: int64
1039
+ * @description The total number of tags matching this query
1040
+ */
1041
+ totalCount: number;
1042
+ /**
1043
+ * Format: int32
1044
+ * @description For which page results are shown from
1045
+ */
1046
+ page: number;
1047
+ /**
1048
+ * Format: int32
1049
+ * @description The number of results per page
1050
+ */
1051
+ pageSize: number;
1052
+ /** @description The chosen search language */
1053
+ language: string;
1054
+ /** @description The search results */
1055
+ results: string[];
1056
+ };
1057
+ /**
1058
+ * UpdatedArticleDTO
1059
+ * @description Information about the article
1060
+ */
1061
+ UpdatedArticleDTO: {
1062
+ /**
1063
+ * Format: int32
1064
+ * @description The revision number for the article
1065
+ */
1066
+ revision: number;
1067
+ /** @description The chosen language */
1068
+ language?: string;
1069
+ /** @description The title of the article */
1070
+ title?: string;
1071
+ /** @description The status of the article */
1072
+ status?: string;
1073
+ /** @description The date the article is published */
1074
+ published?: string;
1075
+ /** @description The content of the article */
1076
+ content?: string;
1077
+ /** @description Searchable tags */
1078
+ tags?: string[];
1079
+ /** @description An introduction */
1080
+ introduction?: string;
1081
+ /** @description A meta description */
1082
+ metaDescription?: string;
1083
+ metaImage?: components["schemas"]["NewArticleMetaImageDTO"] | null;
1084
+ /** @description A visual element for the article. May be anything from an image to a video or H5P */
1085
+ visualElement?: string;
1086
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
1087
+ /** @description Required libraries in order to render the article */
1088
+ requiredLibraries?: components["schemas"]["RequiredLibraryDTO"][];
1089
+ /** @description The type of article this is. Possible values are frontpage-article, standard, topic-article */
1090
+ articleType?: string;
1091
+ /** @description The notes for this article draft */
1092
+ notes?: string[];
1093
+ /** @description The labels attached to this article; meant for editors. */
1094
+ editorLabels?: string[];
1095
+ /** @description A list of codes from GREP API connected to the article */
1096
+ grepCodes?: string[];
1097
+ /** @description A list of conceptIds connected to the article */
1098
+ conceptIds?: number[];
1099
+ /** @description Stores the new article as a separate version. Useful when making big changes that should be revertable. */
1100
+ createNewVersion?: boolean;
1101
+ /** @description Value that dictates who gets to see the article. Possible values are: everyone/teacher */
1102
+ availability?: string;
1103
+ /** @description A list of content related to the article */
1104
+ relatedContent?: (components["schemas"]["RelatedContentLinkDTO"] | number)[];
1105
+ /** @description A list of all revisions of the article */
1106
+ revisionMeta?: components["schemas"]["RevisionMetaDTO"][];
1107
+ /** @description NDLA ID representing the editor responsible for this article */
1108
+ responsibleId?: string | null;
1109
+ /** @description The path to the frontpage article */
1110
+ slug?: string;
1111
+ /** @description Information about a comment attached to an article */
1112
+ comments?: components["schemas"]["UpdatedCommentDTO"][];
1113
+ /** @description If the article should be prioritized */
1114
+ prioritized?: boolean;
1115
+ /** @description If the article should be prioritized. Possible values are prioritized, on-hold, unspecified */
1116
+ priority?: string;
1117
+ qualityEvaluation?: components["schemas"]["QualityEvaluationDTO"];
1118
+ /** @description The disclaimer of the article */
1119
+ disclaimer?: string;
1120
+ };
1121
+ /**
1122
+ * UpdatedCommentDTO
1123
+ * @description Information about a comment attached to an article
1124
+ */
1125
+ UpdatedCommentDTO: {
1126
+ /** @description Id of the comment */
1127
+ id?: string;
1128
+ /** @description Content of the comment */
1129
+ content: string;
1130
+ /** @description If the comment is open or closed */
1131
+ isOpen?: boolean;
1132
+ /** @description If the comment is solved or not */
1133
+ solved?: boolean;
1134
+ };
1135
+ /**
1136
+ * UpdatedUserDataDTO
1137
+ * @description Information about user data
1138
+ */
1139
+ UpdatedUserDataDTO: {
1140
+ /** @description User's saved searches */
1141
+ savedSearches?: components["schemas"]["SavedSearchDTO"][];
1142
+ /** @description User's last edited articles */
1143
+ latestEditedArticles?: string[];
1144
+ /** @description User's last edited concepts */
1145
+ latestEditedConcepts?: string[];
1146
+ /** @description User's favorite subjects */
1147
+ favoriteSubjects?: string[];
1148
+ };
1149
+ /**
1150
+ * UploadedFileDTO
1151
+ * @description Information about the uploaded file
1152
+ */
1153
+ UploadedFileDTO: {
1154
+ /** @description Uploaded file's basename */
1155
+ filename: string;
1156
+ /** @description Uploaded file's mime type */
1157
+ mime: string;
1158
+ /** @description Uploaded file's file extension */
1159
+ extension: string;
1160
+ /** @description Full path of uploaded file */
1161
+ path: string;
1162
+ };
1163
+ /**
1164
+ * UserDataDTO
1165
+ * @description Information about user data
1166
+ */
1167
+ UserDataDTO: {
1168
+ /** @description The auth0 id of the user */
1169
+ userId: string;
1170
+ /** @description User's saved searches */
1171
+ savedSearches?: components["schemas"]["SavedSearchDTO"][];
1172
+ /** @description User's last edited articles */
1173
+ latestEditedArticles?: string[];
1174
+ /** @description User's last edited concepts */
1175
+ latestEditedConcepts?: string[];
1176
+ /** @description User's favorite subjects */
1177
+ favoriteSubjects?: string[];
1178
+ };
1179
+ /**
1180
+ * ValidationErrorBody
1181
+ * @description Information about an error
1182
+ */
1183
+ ValidationErrorBody: {
1184
+ /** @description Code stating the type of error */
1185
+ code: string;
1186
+ /** @description Description of the error */
1187
+ description: string;
1188
+ /** @description When the error occurred */
1189
+ occurredAt: string;
1190
+ /** @description List of validation messages */
1191
+ messages?: components["schemas"]["ValidationMessage"][];
1192
+ /**
1193
+ * Format: int32
1194
+ * @description Numeric http status code
1195
+ */
1196
+ statusCode: number;
1197
+ };
1198
+ /**
1199
+ * ValidationMessage
1200
+ * @description A message describing a validation error on a specific field
1201
+ */
1202
+ ValidationMessage: {
1203
+ /** @description The field the error occured in */
1204
+ field: string;
1205
+ /** @description The validation message */
1206
+ message: string;
1207
+ };
1208
+ /**
1209
+ * VisualElementDTO
1210
+ * @description A visual element article
1211
+ */
1212
+ VisualElementDTO: {
1213
+ /** @description Html containing the visual element. May contain any legal html element, including the embed-tag */
1214
+ visualElement: string;
1215
+ /** @description The ISO 639-1 language code describing which article translation this visual element belongs to */
1216
+ language: string;
1217
+ };
1218
+ /** availability */
1219
+ availability: Record<string, never>;
1220
+ /** grepCodes */
1221
+ grepCodes: Record<string, never>;
1222
+ /** license */
1223
+ license: Record<string, never>;
1224
+ /** metaDescription */
1225
+ metaDescription: Record<string, never>;
1226
+ /** published */
1227
+ published: Record<string, never>;
1228
+ /** relatedContent */
1229
+ relatedContent: Record<string, never>;
1230
+ /** revisionDate */
1231
+ revisionDate: Record<string, never>;
1232
+ /** tags */
1233
+ tags: Record<string, never>;
1234
+ };
1235
+ responses: never;
1236
+ parameters: never;
1237
+ requestBodies: never;
1238
+ headers: never;
1239
+ pathItems: never;
1240
+ };
1241
+ export type $defs = Record<string, never>;
1242
+ export interface operations {
1243
+ "getDraft-apiV1DraftsLicenses": {
1244
+ parameters: {
1245
+ query?: {
1246
+ /** @description A filter to remove a specific entry */
1247
+ filterNot?: string;
1248
+ /** @description A filter to include a specific entry */
1249
+ filter?: string;
1250
+ };
1251
+ header?: never;
1252
+ path?: never;
1253
+ cookie?: never;
1254
+ };
1255
+ requestBody?: never;
1256
+ responses: {
1257
+ 200: {
1258
+ headers: {
1259
+ [name: string]: unknown;
1260
+ };
1261
+ content: {
1262
+ "application/json": components["schemas"]["LicenseDTO"][];
1263
+ };
1264
+ };
1265
+ 400: {
1266
+ headers: {
1267
+ [name: string]: unknown;
1268
+ };
1269
+ content: {
1270
+ "application/json": components["schemas"]["AllErrors"];
1271
+ };
1272
+ };
1273
+ 401: {
1274
+ headers: {
1275
+ [name: string]: unknown;
1276
+ };
1277
+ content: {
1278
+ "application/json": components["schemas"]["AllErrors"];
1279
+ };
1280
+ };
1281
+ 403: {
1282
+ headers: {
1283
+ [name: string]: unknown;
1284
+ };
1285
+ content: {
1286
+ "application/json": components["schemas"]["AllErrors"];
1287
+ };
1288
+ };
1289
+ 404: {
1290
+ headers: {
1291
+ [name: string]: unknown;
1292
+ };
1293
+ content: {
1294
+ "application/json": components["schemas"]["AllErrors"];
1295
+ };
1296
+ };
1297
+ 500: {
1298
+ headers: {
1299
+ [name: string]: unknown;
1300
+ };
1301
+ content: {
1302
+ "application/json": components["schemas"]["ErrorBody"];
1303
+ };
1304
+ };
1305
+ };
1306
+ };
1307
+ "getDraft-apiV1DraftsTag-search": {
1308
+ parameters: {
1309
+ query?: {
1310
+ /** @description Return only articles with content matching the specified query. */
1311
+ query?: string;
1312
+ /** @description The number of search hits to display for each page. */
1313
+ "page-size"?: number;
1314
+ /** @description The page number of the search hits to display. */
1315
+ page?: number;
1316
+ /** @description The ISO 639-1 language code describing language. */
1317
+ language?: string;
1318
+ };
1319
+ header?: never;
1320
+ path?: never;
1321
+ cookie?: never;
1322
+ };
1323
+ requestBody?: never;
1324
+ responses: {
1325
+ 200: {
1326
+ headers: {
1327
+ [name: string]: unknown;
1328
+ };
1329
+ content: {
1330
+ "application/json": components["schemas"]["TagsSearchResultDTO"];
1331
+ };
1332
+ };
1333
+ 400: {
1334
+ headers: {
1335
+ [name: string]: unknown;
1336
+ };
1337
+ content: {
1338
+ "application/json": components["schemas"]["AllErrors"];
1339
+ };
1340
+ };
1341
+ 401: {
1342
+ headers: {
1343
+ [name: string]: unknown;
1344
+ };
1345
+ content: {
1346
+ "application/json": components["schemas"]["AllErrors"];
1347
+ };
1348
+ };
1349
+ 403: {
1350
+ headers: {
1351
+ [name: string]: unknown;
1352
+ };
1353
+ content: {
1354
+ "application/json": components["schemas"]["AllErrors"];
1355
+ };
1356
+ };
1357
+ 404: {
1358
+ headers: {
1359
+ [name: string]: unknown;
1360
+ };
1361
+ content: {
1362
+ "application/json": components["schemas"]["AllErrors"];
1363
+ };
1364
+ };
1365
+ 500: {
1366
+ headers: {
1367
+ [name: string]: unknown;
1368
+ };
1369
+ content: {
1370
+ "application/json": components["schemas"]["ErrorBody"];
1371
+ };
1372
+ };
1373
+ };
1374
+ };
1375
+ "getDraft-apiV1DraftsGrep-codes": {
1376
+ parameters: {
1377
+ query?: {
1378
+ /** @description Return only articles with content matching the specified query. */
1379
+ query?: string;
1380
+ /** @description The number of search hits to display for each page. */
1381
+ "page-size"?: number;
1382
+ /** @description The page number of the search hits to display. */
1383
+ page?: number;
1384
+ };
1385
+ header?: never;
1386
+ path?: never;
1387
+ cookie?: never;
1388
+ };
1389
+ requestBody?: never;
1390
+ responses: {
1391
+ 200: {
1392
+ headers: {
1393
+ [name: string]: unknown;
1394
+ };
1395
+ content: {
1396
+ "application/json": components["schemas"]["GrepCodesSearchResultDTO"];
1397
+ };
1398
+ };
1399
+ 400: {
1400
+ headers: {
1401
+ [name: string]: unknown;
1402
+ };
1403
+ content: {
1404
+ "application/json": components["schemas"]["AllErrors"];
1405
+ };
1406
+ };
1407
+ 401: {
1408
+ headers: {
1409
+ [name: string]: unknown;
1410
+ };
1411
+ content: {
1412
+ "application/json": components["schemas"]["AllErrors"];
1413
+ };
1414
+ };
1415
+ 403: {
1416
+ headers: {
1417
+ [name: string]: unknown;
1418
+ };
1419
+ content: {
1420
+ "application/json": components["schemas"]["AllErrors"];
1421
+ };
1422
+ };
1423
+ 404: {
1424
+ headers: {
1425
+ [name: string]: unknown;
1426
+ };
1427
+ content: {
1428
+ "application/json": components["schemas"]["AllErrors"];
1429
+ };
1430
+ };
1431
+ 500: {
1432
+ headers: {
1433
+ [name: string]: unknown;
1434
+ };
1435
+ content: {
1436
+ "application/json": components["schemas"]["ErrorBody"];
1437
+ };
1438
+ };
1439
+ };
1440
+ };
1441
+ "getDraft-apiV1Drafts": {
1442
+ parameters: {
1443
+ query?: {
1444
+ /** @description Return only articles of specific type(s). To provide multiple types, separate by comma (,). */
1445
+ articleTypes?: string[];
1446
+ /** @description Return only articles with content matching the specified query. */
1447
+ query?: string;
1448
+ /** @description Return only articles that have one of the provided ids. To provide multiple ids, separate by comma (,). */
1449
+ ids?: number[];
1450
+ /** @description The ISO 639-1 language code describing language. */
1451
+ language?: string;
1452
+ /** @description Return only results with provided license. */
1453
+ license?: string;
1454
+ /** @description The page number of the search hits to display. */
1455
+ page?: number;
1456
+ /** @description The number of search hits to display for each page. */
1457
+ "page-size"?: number;
1458
+ /** @description The sorting used on results.
1459
+ * The following are supported: relevance, -relevance, title, -title, lastUpdated, -lastUpdated, id, -id.
1460
+ * Default is by -relevance (desc) when query is set, and title (asc) when query is empty. */
1461
+ sort?: string;
1462
+ /** @description A unique string obtained from a search you want to keep scrolling in. To obtain one from a search, provide one of the following values: [0,initial,start,first].
1463
+ * When scrolling, the parameters from the initial search is used, except in the case of 'language' and 'fallback'.
1464
+ * This value may change between scrolls. Always use the one in the latest scroll result (The context, if unused, dies after 1m).
1465
+ * If you are not paginating past 10000 hits, you can ignore this and use 'page' and 'page-size' instead.
1466
+ * */
1467
+ "search-context"?: string;
1468
+ /** @description A comma separated list of codes from GREP API the resources should be filtered by. */
1469
+ "grep-codes"?: string[];
1470
+ /** @description Fallback to existing language if language is specified. */
1471
+ fallback?: boolean;
1472
+ };
1473
+ header?: never;
1474
+ path?: never;
1475
+ cookie?: never;
1476
+ };
1477
+ requestBody?: never;
1478
+ responses: {
1479
+ 200: {
1480
+ headers: {
1481
+ [name: string]: unknown;
1482
+ };
1483
+ content: {
1484
+ "application/json": components["schemas"]["ArticleSearchResultDTO"];
1485
+ };
1486
+ };
1487
+ 400: {
1488
+ headers: {
1489
+ [name: string]: unknown;
1490
+ };
1491
+ content: {
1492
+ "application/json": components["schemas"]["AllErrors"];
1493
+ };
1494
+ };
1495
+ 401: {
1496
+ headers: {
1497
+ [name: string]: unknown;
1498
+ };
1499
+ content: {
1500
+ "application/json": components["schemas"]["AllErrors"];
1501
+ };
1502
+ };
1503
+ 403: {
1504
+ headers: {
1505
+ [name: string]: unknown;
1506
+ };
1507
+ content: {
1508
+ "application/json": components["schemas"]["AllErrors"];
1509
+ };
1510
+ };
1511
+ 404: {
1512
+ headers: {
1513
+ [name: string]: unknown;
1514
+ };
1515
+ content: {
1516
+ "application/json": components["schemas"]["AllErrors"];
1517
+ };
1518
+ };
1519
+ 500: {
1520
+ headers: {
1521
+ [name: string]: unknown;
1522
+ };
1523
+ content: {
1524
+ "application/json": components["schemas"]["ErrorBody"];
1525
+ };
1526
+ };
1527
+ };
1528
+ };
1529
+ "postDraft-apiV1Drafts": {
1530
+ parameters: {
1531
+ query?: {
1532
+ externalId?: string[];
1533
+ oldNdlaCreatedDate?: string;
1534
+ oldNdlaUpdatedDate?: string;
1535
+ externalSubjectIds?: string[];
1536
+ importId?: string;
1537
+ };
1538
+ header?: never;
1539
+ path?: never;
1540
+ cookie?: never;
1541
+ };
1542
+ requestBody: {
1543
+ content: {
1544
+ "application/json": components["schemas"]["NewArticleDTO"];
1545
+ };
1546
+ };
1547
+ responses: {
1548
+ 201: {
1549
+ headers: {
1550
+ [name: string]: unknown;
1551
+ };
1552
+ content: {
1553
+ "application/json": components["schemas"]["ArticleDTO"];
1554
+ };
1555
+ };
1556
+ 400: {
1557
+ headers: {
1558
+ [name: string]: unknown;
1559
+ };
1560
+ content: {
1561
+ "application/json": components["schemas"]["AllErrors"];
1562
+ };
1563
+ };
1564
+ 401: {
1565
+ headers: {
1566
+ [name: string]: unknown;
1567
+ };
1568
+ content: {
1569
+ "application/json": components["schemas"]["AllErrors"];
1570
+ };
1571
+ };
1572
+ 403: {
1573
+ headers: {
1574
+ [name: string]: unknown;
1575
+ };
1576
+ content: {
1577
+ "application/json": components["schemas"]["AllErrors"];
1578
+ };
1579
+ };
1580
+ 404: {
1581
+ headers: {
1582
+ [name: string]: unknown;
1583
+ };
1584
+ content: {
1585
+ "application/json": components["schemas"]["AllErrors"];
1586
+ };
1587
+ };
1588
+ 500: {
1589
+ headers: {
1590
+ [name: string]: unknown;
1591
+ };
1592
+ content: {
1593
+ "application/json": components["schemas"]["ErrorBody"];
1594
+ };
1595
+ };
1596
+ };
1597
+ };
1598
+ "postDraft-apiV1DraftsSearch": {
1599
+ parameters: {
1600
+ query?: never;
1601
+ header?: never;
1602
+ path?: never;
1603
+ cookie?: never;
1604
+ };
1605
+ requestBody: {
1606
+ content: {
1607
+ "application/json": components["schemas"]["ArticleSearchParamsDTO"];
1608
+ };
1609
+ };
1610
+ responses: {
1611
+ 200: {
1612
+ headers: {
1613
+ [name: string]: unknown;
1614
+ };
1615
+ content: {
1616
+ "application/json": components["schemas"]["ArticleSearchResultDTO"];
1617
+ };
1618
+ };
1619
+ 400: {
1620
+ headers: {
1621
+ [name: string]: unknown;
1622
+ };
1623
+ content: {
1624
+ "application/json": components["schemas"]["AllErrors"];
1625
+ };
1626
+ };
1627
+ 401: {
1628
+ headers: {
1629
+ [name: string]: unknown;
1630
+ };
1631
+ content: {
1632
+ "application/json": components["schemas"]["AllErrors"];
1633
+ };
1634
+ };
1635
+ 403: {
1636
+ headers: {
1637
+ [name: string]: unknown;
1638
+ };
1639
+ content: {
1640
+ "application/json": components["schemas"]["AllErrors"];
1641
+ };
1642
+ };
1643
+ 404: {
1644
+ headers: {
1645
+ [name: string]: unknown;
1646
+ };
1647
+ content: {
1648
+ "application/json": components["schemas"]["AllErrors"];
1649
+ };
1650
+ };
1651
+ 500: {
1652
+ headers: {
1653
+ [name: string]: unknown;
1654
+ };
1655
+ content: {
1656
+ "application/json": components["schemas"]["ErrorBody"];
1657
+ };
1658
+ };
1659
+ };
1660
+ };
1661
+ "getDraft-apiV1DraftsStatus-state-machine": {
1662
+ parameters: {
1663
+ query?: {
1664
+ /** @description The ID of the article to generate a status state machine for */
1665
+ articleId?: number;
1666
+ };
1667
+ header?: never;
1668
+ path?: never;
1669
+ cookie?: never;
1670
+ };
1671
+ requestBody?: never;
1672
+ responses: {
1673
+ 200: {
1674
+ headers: {
1675
+ [name: string]: unknown;
1676
+ };
1677
+ content: {
1678
+ "application/json": components["schemas"]["Map_List_String"];
1679
+ };
1680
+ };
1681
+ 400: {
1682
+ headers: {
1683
+ [name: string]: unknown;
1684
+ };
1685
+ content: {
1686
+ "application/json": components["schemas"]["AllErrors"];
1687
+ };
1688
+ };
1689
+ 401: {
1690
+ headers: {
1691
+ [name: string]: unknown;
1692
+ };
1693
+ content: {
1694
+ "application/json": components["schemas"]["AllErrors"];
1695
+ };
1696
+ };
1697
+ 403: {
1698
+ headers: {
1699
+ [name: string]: unknown;
1700
+ };
1701
+ content: {
1702
+ "application/json": components["schemas"]["AllErrors"];
1703
+ };
1704
+ };
1705
+ 404: {
1706
+ headers: {
1707
+ [name: string]: unknown;
1708
+ };
1709
+ content: {
1710
+ "application/json": components["schemas"]["AllErrors"];
1711
+ };
1712
+ };
1713
+ 500: {
1714
+ headers: {
1715
+ [name: string]: unknown;
1716
+ };
1717
+ content: {
1718
+ "application/json": components["schemas"]["ErrorBody"];
1719
+ };
1720
+ };
1721
+ };
1722
+ };
1723
+ "getDraft-apiV1DraftsIds": {
1724
+ parameters: {
1725
+ query?: {
1726
+ /** @description Return only articles that have one of the provided ids. To provide multiple ids, separate by comma (,). */
1727
+ ids?: number[];
1728
+ /** @description Fallback to existing language if language is specified. */
1729
+ fallback?: boolean;
1730
+ /** @description The ISO 639-1 language code describing language. */
1731
+ language?: string;
1732
+ /** @description The number of search hits to display for each page. */
1733
+ "page-size"?: number;
1734
+ /** @description The page number of the search hits to display. */
1735
+ page?: number;
1736
+ };
1737
+ header?: never;
1738
+ path?: never;
1739
+ cookie?: never;
1740
+ };
1741
+ requestBody?: never;
1742
+ responses: {
1743
+ 200: {
1744
+ headers: {
1745
+ [name: string]: unknown;
1746
+ };
1747
+ content: {
1748
+ "application/json": components["schemas"]["ArticleDTO"][];
1749
+ };
1750
+ };
1751
+ 400: {
1752
+ headers: {
1753
+ [name: string]: unknown;
1754
+ };
1755
+ content: {
1756
+ "application/json": components["schemas"]["AllErrors"];
1757
+ };
1758
+ };
1759
+ 401: {
1760
+ headers: {
1761
+ [name: string]: unknown;
1762
+ };
1763
+ content: {
1764
+ "application/json": components["schemas"]["AllErrors"];
1765
+ };
1766
+ };
1767
+ 403: {
1768
+ headers: {
1769
+ [name: string]: unknown;
1770
+ };
1771
+ content: {
1772
+ "application/json": components["schemas"]["AllErrors"];
1773
+ };
1774
+ };
1775
+ 404: {
1776
+ headers: {
1777
+ [name: string]: unknown;
1778
+ };
1779
+ content: {
1780
+ "application/json": components["schemas"]["AllErrors"];
1781
+ };
1782
+ };
1783
+ 500: {
1784
+ headers: {
1785
+ [name: string]: unknown;
1786
+ };
1787
+ content: {
1788
+ "application/json": components["schemas"]["ErrorBody"];
1789
+ };
1790
+ };
1791
+ };
1792
+ };
1793
+ "getDraft-apiV1DraftsArticle_id": {
1794
+ parameters: {
1795
+ query?: {
1796
+ /** @description The ISO 639-1 language code describing language. */
1797
+ language?: string;
1798
+ /** @description Fallback to existing language if language is specified. */
1799
+ fallback?: boolean;
1800
+ };
1801
+ header?: never;
1802
+ path: {
1803
+ /** @description Id of the article that is to be fetched */
1804
+ article_id: number;
1805
+ };
1806
+ cookie?: never;
1807
+ };
1808
+ requestBody?: never;
1809
+ responses: {
1810
+ 200: {
1811
+ headers: {
1812
+ [name: string]: unknown;
1813
+ };
1814
+ content: {
1815
+ "application/json": components["schemas"]["ArticleDTO"];
1816
+ };
1817
+ };
1818
+ 400: {
1819
+ headers: {
1820
+ [name: string]: unknown;
1821
+ };
1822
+ content: {
1823
+ "application/json": components["schemas"]["AllErrors"];
1824
+ };
1825
+ };
1826
+ 401: {
1827
+ headers: {
1828
+ [name: string]: unknown;
1829
+ };
1830
+ content: {
1831
+ "application/json": components["schemas"]["AllErrors"];
1832
+ };
1833
+ };
1834
+ 403: {
1835
+ headers: {
1836
+ [name: string]: unknown;
1837
+ };
1838
+ content: {
1839
+ "application/json": components["schemas"]["AllErrors"];
1840
+ };
1841
+ };
1842
+ 404: {
1843
+ headers: {
1844
+ [name: string]: unknown;
1845
+ };
1846
+ content: {
1847
+ "application/json": components["schemas"]["AllErrors"];
1848
+ };
1849
+ };
1850
+ 500: {
1851
+ headers: {
1852
+ [name: string]: unknown;
1853
+ };
1854
+ content: {
1855
+ "application/json": components["schemas"]["ErrorBody"];
1856
+ };
1857
+ };
1858
+ };
1859
+ };
1860
+ "patchDraft-apiV1DraftsArticle_id": {
1861
+ parameters: {
1862
+ query?: {
1863
+ externalId?: string[];
1864
+ oldNdlaCreatedDate?: string;
1865
+ oldNdlaUpdatedDate?: string;
1866
+ externalSubjectIds?: string[];
1867
+ importId?: string;
1868
+ };
1869
+ header?: never;
1870
+ path: {
1871
+ /** @description Id of the article that is to be fetched */
1872
+ article_id: number;
1873
+ };
1874
+ cookie?: never;
1875
+ };
1876
+ requestBody: {
1877
+ content: {
1878
+ "application/json": components["schemas"]["UpdatedArticleDTO"];
1879
+ };
1880
+ };
1881
+ responses: {
1882
+ 200: {
1883
+ headers: {
1884
+ [name: string]: unknown;
1885
+ };
1886
+ content: {
1887
+ "application/json": components["schemas"]["ArticleDTO"];
1888
+ };
1889
+ };
1890
+ 400: {
1891
+ headers: {
1892
+ [name: string]: unknown;
1893
+ };
1894
+ content: {
1895
+ "application/json": components["schemas"]["AllErrors"];
1896
+ };
1897
+ };
1898
+ 401: {
1899
+ headers: {
1900
+ [name: string]: unknown;
1901
+ };
1902
+ content: {
1903
+ "application/json": components["schemas"]["AllErrors"];
1904
+ };
1905
+ };
1906
+ 403: {
1907
+ headers: {
1908
+ [name: string]: unknown;
1909
+ };
1910
+ content: {
1911
+ "application/json": components["schemas"]["AllErrors"];
1912
+ };
1913
+ };
1914
+ 404: {
1915
+ headers: {
1916
+ [name: string]: unknown;
1917
+ };
1918
+ content: {
1919
+ "application/json": components["schemas"]["AllErrors"];
1920
+ };
1921
+ };
1922
+ 409: {
1923
+ headers: {
1924
+ [name: string]: unknown;
1925
+ };
1926
+ content: {
1927
+ "application/json": components["schemas"]["AllErrors"];
1928
+ };
1929
+ };
1930
+ 500: {
1931
+ headers: {
1932
+ [name: string]: unknown;
1933
+ };
1934
+ content: {
1935
+ "application/json": components["schemas"]["ErrorBody"];
1936
+ };
1937
+ };
1938
+ 502: {
1939
+ headers: {
1940
+ [name: string]: unknown;
1941
+ };
1942
+ content: {
1943
+ "application/json": components["schemas"]["AllErrors"];
1944
+ };
1945
+ };
1946
+ };
1947
+ };
1948
+ "getDraft-apiV1DraftsArticle_idHistory": {
1949
+ parameters: {
1950
+ query?: {
1951
+ /** @description The ISO 639-1 language code describing language. */
1952
+ language?: string;
1953
+ /** @description Fallback to existing language if language is specified. */
1954
+ fallback?: boolean;
1955
+ };
1956
+ header?: never;
1957
+ path: {
1958
+ /** @description Id of the article that is to be fetched */
1959
+ article_id: number;
1960
+ };
1961
+ cookie?: never;
1962
+ };
1963
+ requestBody?: never;
1964
+ responses: {
1965
+ 200: {
1966
+ headers: {
1967
+ [name: string]: unknown;
1968
+ };
1969
+ content: {
1970
+ "application/json": components["schemas"]["ArticleDTO"][];
1971
+ };
1972
+ };
1973
+ 400: {
1974
+ headers: {
1975
+ [name: string]: unknown;
1976
+ };
1977
+ content: {
1978
+ "application/json": components["schemas"]["AllErrors"];
1979
+ };
1980
+ };
1981
+ 401: {
1982
+ headers: {
1983
+ [name: string]: unknown;
1984
+ };
1985
+ content: {
1986
+ "application/json": components["schemas"]["AllErrors"];
1987
+ };
1988
+ };
1989
+ 403: {
1990
+ headers: {
1991
+ [name: string]: unknown;
1992
+ };
1993
+ content: {
1994
+ "application/json": components["schemas"]["AllErrors"];
1995
+ };
1996
+ };
1997
+ 404: {
1998
+ headers: {
1999
+ [name: string]: unknown;
2000
+ };
2001
+ content: {
2002
+ "application/json": components["schemas"]["AllErrors"];
2003
+ };
2004
+ };
2005
+ 500: {
2006
+ headers: {
2007
+ [name: string]: unknown;
2008
+ };
2009
+ content: {
2010
+ "application/json": components["schemas"]["ErrorBody"];
2011
+ };
2012
+ };
2013
+ };
2014
+ };
2015
+ "getDraft-apiV1DraftsExternal_idDeprecated_node_id": {
2016
+ parameters: {
2017
+ query?: never;
2018
+ header?: never;
2019
+ path: {
2020
+ deprecated_node_id: number;
2021
+ };
2022
+ cookie?: never;
2023
+ };
2024
+ requestBody?: never;
2025
+ responses: {
2026
+ 200: {
2027
+ headers: {
2028
+ [name: string]: unknown;
2029
+ };
2030
+ content: {
2031
+ "application/json": components["schemas"]["ContentIdDTO"];
2032
+ };
2033
+ };
2034
+ 400: {
2035
+ headers: {
2036
+ [name: string]: unknown;
2037
+ };
2038
+ content: {
2039
+ "application/json": components["schemas"]["AllErrors"];
2040
+ };
2041
+ };
2042
+ 401: {
2043
+ headers: {
2044
+ [name: string]: unknown;
2045
+ };
2046
+ content: {
2047
+ "application/json": components["schemas"]["AllErrors"];
2048
+ };
2049
+ };
2050
+ 403: {
2051
+ headers: {
2052
+ [name: string]: unknown;
2053
+ };
2054
+ content: {
2055
+ "application/json": components["schemas"]["AllErrors"];
2056
+ };
2057
+ };
2058
+ 404: {
2059
+ headers: {
2060
+ [name: string]: unknown;
2061
+ };
2062
+ content: {
2063
+ "application/json": components["schemas"]["AllErrors"];
2064
+ };
2065
+ };
2066
+ 500: {
2067
+ headers: {
2068
+ [name: string]: unknown;
2069
+ };
2070
+ content: {
2071
+ "application/json": components["schemas"]["ErrorBody"];
2072
+ };
2073
+ };
2074
+ };
2075
+ };
2076
+ "putDraft-apiV1DraftsArticle_idStatusStatus": {
2077
+ parameters: {
2078
+ query?: {
2079
+ import_publish?: boolean;
2080
+ };
2081
+ header?: never;
2082
+ path: {
2083
+ /** @description Id of the article that is to be fetched */
2084
+ article_id: number;
2085
+ /** @description An article status */
2086
+ STATUS: string;
2087
+ };
2088
+ cookie?: never;
2089
+ };
2090
+ requestBody?: never;
2091
+ responses: {
2092
+ 200: {
2093
+ headers: {
2094
+ [name: string]: unknown;
2095
+ };
2096
+ content: {
2097
+ "application/json": components["schemas"]["ArticleDTO"];
2098
+ };
2099
+ };
2100
+ 400: {
2101
+ headers: {
2102
+ [name: string]: unknown;
2103
+ };
2104
+ content: {
2105
+ "application/json": components["schemas"]["AllErrors"];
2106
+ };
2107
+ };
2108
+ 401: {
2109
+ headers: {
2110
+ [name: string]: unknown;
2111
+ };
2112
+ content: {
2113
+ "application/json": components["schemas"]["AllErrors"];
2114
+ };
2115
+ };
2116
+ 403: {
2117
+ headers: {
2118
+ [name: string]: unknown;
2119
+ };
2120
+ content: {
2121
+ "application/json": components["schemas"]["AllErrors"];
2122
+ };
2123
+ };
2124
+ 404: {
2125
+ headers: {
2126
+ [name: string]: unknown;
2127
+ };
2128
+ content: {
2129
+ "application/json": components["schemas"]["AllErrors"];
2130
+ };
2131
+ };
2132
+ 500: {
2133
+ headers: {
2134
+ [name: string]: unknown;
2135
+ };
2136
+ content: {
2137
+ "application/json": components["schemas"]["ErrorBody"];
2138
+ };
2139
+ };
2140
+ };
2141
+ };
2142
+ "putDraft-apiV1DraftsArticle_idValidate": {
2143
+ parameters: {
2144
+ query?: {
2145
+ import_validate?: boolean;
2146
+ };
2147
+ header?: never;
2148
+ path: {
2149
+ /** @description Id of the article that is to be fetched */
2150
+ article_id: number;
2151
+ };
2152
+ cookie?: never;
2153
+ };
2154
+ requestBody?: {
2155
+ content: {
2156
+ "application/json": components["schemas"]["UpdatedArticleDTO"];
2157
+ };
2158
+ };
2159
+ responses: {
2160
+ 200: {
2161
+ headers: {
2162
+ [name: string]: unknown;
2163
+ };
2164
+ content: {
2165
+ "application/json": components["schemas"]["ContentIdDTO"];
2166
+ };
2167
+ };
2168
+ 400: {
2169
+ headers: {
2170
+ [name: string]: unknown;
2171
+ };
2172
+ content: {
2173
+ "application/json": components["schemas"]["AllErrors"];
2174
+ };
2175
+ };
2176
+ 401: {
2177
+ headers: {
2178
+ [name: string]: unknown;
2179
+ };
2180
+ content: {
2181
+ "application/json": components["schemas"]["AllErrors"];
2182
+ };
2183
+ };
2184
+ 403: {
2185
+ headers: {
2186
+ [name: string]: unknown;
2187
+ };
2188
+ content: {
2189
+ "application/json": components["schemas"]["AllErrors"];
2190
+ };
2191
+ };
2192
+ 404: {
2193
+ headers: {
2194
+ [name: string]: unknown;
2195
+ };
2196
+ content: {
2197
+ "application/json": components["schemas"]["AllErrors"];
2198
+ };
2199
+ };
2200
+ 500: {
2201
+ headers: {
2202
+ [name: string]: unknown;
2203
+ };
2204
+ content: {
2205
+ "application/json": components["schemas"]["ErrorBody"];
2206
+ };
2207
+ };
2208
+ };
2209
+ };
2210
+ "deleteDraft-apiV1DraftsArticle_idLanguageLanguage": {
2211
+ parameters: {
2212
+ query?: never;
2213
+ header?: never;
2214
+ path: {
2215
+ /** @description Id of the article that is to be fetched */
2216
+ article_id: number;
2217
+ /** @description The ISO 639-1 language code describing language. */
2218
+ language: string;
2219
+ };
2220
+ cookie?: never;
2221
+ };
2222
+ requestBody?: never;
2223
+ responses: {
2224
+ 200: {
2225
+ headers: {
2226
+ [name: string]: unknown;
2227
+ };
2228
+ content: {
2229
+ "application/json": components["schemas"]["ArticleDTO"];
2230
+ };
2231
+ };
2232
+ 400: {
2233
+ headers: {
2234
+ [name: string]: unknown;
2235
+ };
2236
+ content: {
2237
+ "application/json": components["schemas"]["AllErrors"];
2238
+ };
2239
+ };
2240
+ 401: {
2241
+ headers: {
2242
+ [name: string]: unknown;
2243
+ };
2244
+ content: {
2245
+ "application/json": components["schemas"]["AllErrors"];
2246
+ };
2247
+ };
2248
+ 403: {
2249
+ headers: {
2250
+ [name: string]: unknown;
2251
+ };
2252
+ content: {
2253
+ "application/json": components["schemas"]["AllErrors"];
2254
+ };
2255
+ };
2256
+ 404: {
2257
+ headers: {
2258
+ [name: string]: unknown;
2259
+ };
2260
+ content: {
2261
+ "application/json": components["schemas"]["AllErrors"];
2262
+ };
2263
+ };
2264
+ 500: {
2265
+ headers: {
2266
+ [name: string]: unknown;
2267
+ };
2268
+ content: {
2269
+ "application/json": components["schemas"]["ErrorBody"];
2270
+ };
2271
+ };
2272
+ };
2273
+ };
2274
+ "postDraft-apiV1DraftsCloneArticle_id": {
2275
+ parameters: {
2276
+ query?: {
2277
+ /** @description The ISO 639-1 language code describing language. */
2278
+ language?: string;
2279
+ /** @description Fallback to existing language if language is specified. */
2280
+ fallback?: boolean;
2281
+ /** @description Add a string to the title marking this article as a copy, defaults to 'true'. */
2282
+ "copied-title-postfix"?: boolean;
2283
+ };
2284
+ header?: never;
2285
+ path: {
2286
+ /** @description Id of the article that is to be fetched */
2287
+ article_id: number;
2288
+ };
2289
+ cookie?: never;
2290
+ };
2291
+ requestBody?: never;
2292
+ responses: {
2293
+ 200: {
2294
+ headers: {
2295
+ [name: string]: unknown;
2296
+ };
2297
+ content: {
2298
+ "application/json": components["schemas"]["ArticleDTO"];
2299
+ };
2300
+ };
2301
+ 400: {
2302
+ headers: {
2303
+ [name: string]: unknown;
2304
+ };
2305
+ content: {
2306
+ "application/json": components["schemas"]["AllErrors"];
2307
+ };
2308
+ };
2309
+ 401: {
2310
+ headers: {
2311
+ [name: string]: unknown;
2312
+ };
2313
+ content: {
2314
+ "application/json": components["schemas"]["AllErrors"];
2315
+ };
2316
+ };
2317
+ 403: {
2318
+ headers: {
2319
+ [name: string]: unknown;
2320
+ };
2321
+ content: {
2322
+ "application/json": components["schemas"]["AllErrors"];
2323
+ };
2324
+ };
2325
+ 404: {
2326
+ headers: {
2327
+ [name: string]: unknown;
2328
+ };
2329
+ content: {
2330
+ "application/json": components["schemas"]["AllErrors"];
2331
+ };
2332
+ };
2333
+ 500: {
2334
+ headers: {
2335
+ [name: string]: unknown;
2336
+ };
2337
+ content: {
2338
+ "application/json": components["schemas"]["ErrorBody"];
2339
+ };
2340
+ };
2341
+ };
2342
+ };
2343
+ "postDraft-apiV1DraftsPartial-publishArticle_id": {
2344
+ parameters: {
2345
+ query?: {
2346
+ /** @description The ISO 639-1 language code describing language. */
2347
+ language?: string;
2348
+ /** @description Fallback to existing language if language is specified. */
2349
+ fallback?: boolean;
2350
+ };
2351
+ header?: never;
2352
+ path: {
2353
+ /** @description Id of the article that is to be fetched */
2354
+ article_id: number;
2355
+ };
2356
+ cookie?: never;
2357
+ };
2358
+ requestBody: {
2359
+ content: {
2360
+ "application/json": components["schemas"]["PartialArticleFieldsDTO"][];
2361
+ };
2362
+ };
2363
+ responses: {
2364
+ 200: {
2365
+ headers: {
2366
+ [name: string]: unknown;
2367
+ };
2368
+ content: {
2369
+ "application/json": components["schemas"]["ArticleDTO"];
2370
+ };
2371
+ };
2372
+ 400: {
2373
+ headers: {
2374
+ [name: string]: unknown;
2375
+ };
2376
+ content: {
2377
+ "application/json": components["schemas"]["AllErrors"];
2378
+ };
2379
+ };
2380
+ 401: {
2381
+ headers: {
2382
+ [name: string]: unknown;
2383
+ };
2384
+ content: {
2385
+ "application/json": components["schemas"]["AllErrors"];
2386
+ };
2387
+ };
2388
+ 403: {
2389
+ headers: {
2390
+ [name: string]: unknown;
2391
+ };
2392
+ content: {
2393
+ "application/json": components["schemas"]["AllErrors"];
2394
+ };
2395
+ };
2396
+ 404: {
2397
+ headers: {
2398
+ [name: string]: unknown;
2399
+ };
2400
+ content: {
2401
+ "application/json": components["schemas"]["AllErrors"];
2402
+ };
2403
+ };
2404
+ 500: {
2405
+ headers: {
2406
+ [name: string]: unknown;
2407
+ };
2408
+ content: {
2409
+ "application/json": components["schemas"]["ErrorBody"];
2410
+ };
2411
+ };
2412
+ };
2413
+ };
2414
+ "postDraft-apiV1DraftsPartial-publish": {
2415
+ parameters: {
2416
+ query?: {
2417
+ /** @description The ISO 639-1 language code describing language. */
2418
+ language?: string;
2419
+ };
2420
+ header?: never;
2421
+ path?: never;
2422
+ cookie?: never;
2423
+ };
2424
+ requestBody: {
2425
+ content: {
2426
+ "application/json": components["schemas"]["PartialBulkArticlesDTO"];
2427
+ };
2428
+ };
2429
+ responses: {
2430
+ 200: {
2431
+ headers: {
2432
+ [name: string]: unknown;
2433
+ };
2434
+ content: {
2435
+ "application/json": components["schemas"]["MultiPartialPublishResultDTO"];
2436
+ };
2437
+ };
2438
+ 400: {
2439
+ headers: {
2440
+ [name: string]: unknown;
2441
+ };
2442
+ content: {
2443
+ "application/json": components["schemas"]["AllErrors"];
2444
+ };
2445
+ };
2446
+ 401: {
2447
+ headers: {
2448
+ [name: string]: unknown;
2449
+ };
2450
+ content: {
2451
+ "application/json": components["schemas"]["AllErrors"];
2452
+ };
2453
+ };
2454
+ 403: {
2455
+ headers: {
2456
+ [name: string]: unknown;
2457
+ };
2458
+ content: {
2459
+ "application/json": components["schemas"]["AllErrors"];
2460
+ };
2461
+ };
2462
+ 404: {
2463
+ headers: {
2464
+ [name: string]: unknown;
2465
+ };
2466
+ content: {
2467
+ "application/json": components["schemas"]["AllErrors"];
2468
+ };
2469
+ };
2470
+ 500: {
2471
+ headers: {
2472
+ [name: string]: unknown;
2473
+ };
2474
+ content: {
2475
+ "application/json": components["schemas"]["ErrorBody"];
2476
+ };
2477
+ };
2478
+ };
2479
+ };
2480
+ "postDraft-apiV1DraftsCopyrevisiondatesNode_id": {
2481
+ parameters: {
2482
+ query?: never;
2483
+ header?: never;
2484
+ path: {
2485
+ /** @description Id of the taxonomy node to process */
2486
+ node_id: string;
2487
+ };
2488
+ cookie?: never;
2489
+ };
2490
+ requestBody?: never;
2491
+ responses: {
2492
+ 200: {
2493
+ headers: {
2494
+ [name: string]: unknown;
2495
+ };
2496
+ content?: never;
2497
+ };
2498
+ 400: {
2499
+ headers: {
2500
+ [name: string]: unknown;
2501
+ };
2502
+ content: {
2503
+ "application/json": components["schemas"]["AllErrors"];
2504
+ };
2505
+ };
2506
+ 401: {
2507
+ headers: {
2508
+ [name: string]: unknown;
2509
+ };
2510
+ content: {
2511
+ "application/json": components["schemas"]["AllErrors"];
2512
+ };
2513
+ };
2514
+ 403: {
2515
+ headers: {
2516
+ [name: string]: unknown;
2517
+ };
2518
+ content: {
2519
+ "application/json": components["schemas"]["AllErrors"];
2520
+ };
2521
+ };
2522
+ 404: {
2523
+ headers: {
2524
+ [name: string]: unknown;
2525
+ };
2526
+ content: {
2527
+ "application/json": components["schemas"]["AllErrors"];
2528
+ };
2529
+ };
2530
+ 500: {
2531
+ headers: {
2532
+ [name: string]: unknown;
2533
+ };
2534
+ content: {
2535
+ "application/json": components["schemas"]["ErrorBody"];
2536
+ };
2537
+ };
2538
+ };
2539
+ };
2540
+ "getDraft-apiV1DraftsSlugSlug": {
2541
+ parameters: {
2542
+ query?: {
2543
+ /** @description The ISO 639-1 language code describing language. */
2544
+ language?: string;
2545
+ /** @description Fallback to existing language if language is specified. */
2546
+ fallback?: boolean;
2547
+ };
2548
+ header?: never;
2549
+ path: {
2550
+ /** @description Slug of the article that is to be fecthed. */
2551
+ slug: string;
2552
+ };
2553
+ cookie?: never;
2554
+ };
2555
+ requestBody?: never;
2556
+ responses: {
2557
+ 200: {
2558
+ headers: {
2559
+ [name: string]: unknown;
2560
+ };
2561
+ content: {
2562
+ "application/json": components["schemas"]["ArticleDTO"];
2563
+ };
2564
+ };
2565
+ 400: {
2566
+ headers: {
2567
+ [name: string]: unknown;
2568
+ };
2569
+ content: {
2570
+ "application/json": components["schemas"]["AllErrors"];
2571
+ };
2572
+ };
2573
+ 401: {
2574
+ headers: {
2575
+ [name: string]: unknown;
2576
+ };
2577
+ content: {
2578
+ "application/json": components["schemas"]["AllErrors"];
2579
+ };
2580
+ };
2581
+ 403: {
2582
+ headers: {
2583
+ [name: string]: unknown;
2584
+ };
2585
+ content: {
2586
+ "application/json": components["schemas"]["AllErrors"];
2587
+ };
2588
+ };
2589
+ 404: {
2590
+ headers: {
2591
+ [name: string]: unknown;
2592
+ };
2593
+ content: {
2594
+ "application/json": components["schemas"]["AllErrors"];
2595
+ };
2596
+ };
2597
+ 500: {
2598
+ headers: {
2599
+ [name: string]: unknown;
2600
+ };
2601
+ content: {
2602
+ "application/json": components["schemas"]["ErrorBody"];
2603
+ };
2604
+ };
2605
+ };
2606
+ };
2607
+ "postDraft-apiV1DraftsMigrate-greps": {
2608
+ parameters: {
2609
+ query?: never;
2610
+ header?: never;
2611
+ path?: never;
2612
+ cookie?: never;
2613
+ };
2614
+ requestBody?: never;
2615
+ responses: {
2616
+ 200: {
2617
+ headers: {
2618
+ [name: string]: unknown;
2619
+ };
2620
+ content?: never;
2621
+ };
2622
+ 400: {
2623
+ headers: {
2624
+ [name: string]: unknown;
2625
+ };
2626
+ content: {
2627
+ "application/json": components["schemas"]["AllErrors"];
2628
+ };
2629
+ };
2630
+ 404: {
2631
+ headers: {
2632
+ [name: string]: unknown;
2633
+ };
2634
+ content: {
2635
+ "application/json": components["schemas"]["AllErrors"];
2636
+ };
2637
+ };
2638
+ 500: {
2639
+ headers: {
2640
+ [name: string]: unknown;
2641
+ };
2642
+ content: {
2643
+ "application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
2644
+ };
2645
+ };
2646
+ };
2647
+ };
2648
+ "postDraft-apiV1Files": {
2649
+ parameters: {
2650
+ query?: never;
2651
+ header?: never;
2652
+ path?: never;
2653
+ cookie?: never;
2654
+ };
2655
+ requestBody: {
2656
+ content: {
2657
+ "multipart/form-data": components["schemas"]["FileForm"];
2658
+ };
2659
+ };
2660
+ responses: {
2661
+ 200: {
2662
+ headers: {
2663
+ [name: string]: unknown;
2664
+ };
2665
+ content: {
2666
+ "application/json": components["schemas"]["UploadedFileDTO"];
2667
+ };
2668
+ };
2669
+ 400: {
2670
+ headers: {
2671
+ [name: string]: unknown;
2672
+ };
2673
+ content: {
2674
+ "application/json": components["schemas"]["AllErrors"];
2675
+ };
2676
+ };
2677
+ 401: {
2678
+ headers: {
2679
+ [name: string]: unknown;
2680
+ };
2681
+ content: {
2682
+ "application/json": components["schemas"]["AllErrors"];
2683
+ };
2684
+ };
2685
+ 403: {
2686
+ headers: {
2687
+ [name: string]: unknown;
2688
+ };
2689
+ content: {
2690
+ "application/json": components["schemas"]["AllErrors"];
2691
+ };
2692
+ };
2693
+ 404: {
2694
+ headers: {
2695
+ [name: string]: unknown;
2696
+ };
2697
+ content: {
2698
+ "application/json": components["schemas"]["AllErrors"];
2699
+ };
2700
+ };
2701
+ 500: {
2702
+ headers: {
2703
+ [name: string]: unknown;
2704
+ };
2705
+ content: {
2706
+ "application/json": components["schemas"]["ErrorBody"];
2707
+ };
2708
+ };
2709
+ };
2710
+ };
2711
+ "deleteDraft-apiV1Files": {
2712
+ parameters: {
2713
+ query?: {
2714
+ /** @description Path to file. Eg: resources/awdW2CaX.png */
2715
+ path?: string;
2716
+ };
2717
+ header?: never;
2718
+ path?: never;
2719
+ cookie?: never;
2720
+ };
2721
+ requestBody?: never;
2722
+ responses: {
2723
+ 204: {
2724
+ headers: {
2725
+ [name: string]: unknown;
2726
+ };
2727
+ content?: never;
2728
+ };
2729
+ 400: {
2730
+ headers: {
2731
+ [name: string]: unknown;
2732
+ };
2733
+ content: {
2734
+ "application/json": components["schemas"]["AllErrors"];
2735
+ };
2736
+ };
2737
+ 401: {
2738
+ headers: {
2739
+ [name: string]: unknown;
2740
+ };
2741
+ content: {
2742
+ "application/json": components["schemas"]["AllErrors"];
2743
+ };
2744
+ };
2745
+ 403: {
2746
+ headers: {
2747
+ [name: string]: unknown;
2748
+ };
2749
+ content: {
2750
+ "application/json": components["schemas"]["AllErrors"];
2751
+ };
2752
+ };
2753
+ 404: {
2754
+ headers: {
2755
+ [name: string]: unknown;
2756
+ };
2757
+ content: {
2758
+ "application/json": components["schemas"]["AllErrors"];
2759
+ };
2760
+ };
2761
+ 500: {
2762
+ headers: {
2763
+ [name: string]: unknown;
2764
+ };
2765
+ content: {
2766
+ "application/json": components["schemas"]["ErrorBody"];
2767
+ };
2768
+ };
2769
+ };
2770
+ };
2771
+ "getDraft-apiV1User-data": {
2772
+ parameters: {
2773
+ query?: never;
2774
+ header?: never;
2775
+ path?: never;
2776
+ cookie?: never;
2777
+ };
2778
+ requestBody?: never;
2779
+ responses: {
2780
+ 200: {
2781
+ headers: {
2782
+ [name: string]: unknown;
2783
+ };
2784
+ content: {
2785
+ "application/json": components["schemas"]["UserDataDTO"];
2786
+ };
2787
+ };
2788
+ 400: {
2789
+ headers: {
2790
+ [name: string]: unknown;
2791
+ };
2792
+ content: {
2793
+ "application/json": components["schemas"]["AllErrors"];
2794
+ };
2795
+ };
2796
+ 401: {
2797
+ headers: {
2798
+ [name: string]: unknown;
2799
+ };
2800
+ content: {
2801
+ "application/json": components["schemas"]["AllErrors"];
2802
+ };
2803
+ };
2804
+ 403: {
2805
+ headers: {
2806
+ [name: string]: unknown;
2807
+ };
2808
+ content: {
2809
+ "application/json": components["schemas"]["AllErrors"];
2810
+ };
2811
+ };
2812
+ 404: {
2813
+ headers: {
2814
+ [name: string]: unknown;
2815
+ };
2816
+ content: {
2817
+ "application/json": components["schemas"]["AllErrors"];
2818
+ };
2819
+ };
2820
+ 500: {
2821
+ headers: {
2822
+ [name: string]: unknown;
2823
+ };
2824
+ content: {
2825
+ "application/json": components["schemas"]["ErrorBody"];
2826
+ };
2827
+ };
2828
+ };
2829
+ };
2830
+ "patchDraft-apiV1User-data": {
2831
+ parameters: {
2832
+ query?: never;
2833
+ header?: never;
2834
+ path?: never;
2835
+ cookie?: never;
2836
+ };
2837
+ requestBody: {
2838
+ content: {
2839
+ "application/json": components["schemas"]["UpdatedUserDataDTO"];
2840
+ };
2841
+ };
2842
+ responses: {
2843
+ 200: {
2844
+ headers: {
2845
+ [name: string]: unknown;
2846
+ };
2847
+ content: {
2848
+ "application/json": components["schemas"]["UserDataDTO"];
2849
+ };
2850
+ };
2851
+ 400: {
2852
+ headers: {
2853
+ [name: string]: unknown;
2854
+ };
2855
+ content: {
2856
+ "application/json": components["schemas"]["AllErrors"];
2857
+ };
2858
+ };
2859
+ 401: {
2860
+ headers: {
2861
+ [name: string]: unknown;
2862
+ };
2863
+ content: {
2864
+ "application/json": components["schemas"]["AllErrors"];
2865
+ };
2866
+ };
2867
+ 403: {
2868
+ headers: {
2869
+ [name: string]: unknown;
2870
+ };
2871
+ content: {
2872
+ "application/json": components["schemas"]["AllErrors"];
2873
+ };
2874
+ };
2875
+ 404: {
2876
+ headers: {
2877
+ [name: string]: unknown;
2878
+ };
2879
+ content: {
2880
+ "application/json": components["schemas"]["AllErrors"];
2881
+ };
2882
+ };
2883
+ 500: {
2884
+ headers: {
2885
+ [name: string]: unknown;
2886
+ };
2887
+ content: {
2888
+ "application/json": components["schemas"]["ErrorBody"];
2889
+ };
2890
+ };
2891
+ };
2892
+ };
2893
+ }