@ndla/types-backend 1.0.103 → 1.0.105

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