@ndla/types-backend 1.0.103 → 1.0.104

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