@ndla/types-backend 1.0.34 → 1.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/build/article-api-openapi.d.ts +1092 -0
  2. package/build/article-api-openapi.js +7 -0
  3. package/build/article-api-openapi.js.map +1 -0
  4. package/build/article-api.d.ts +57 -156
  5. package/build/article-api.js +27 -13
  6. package/build/article-api.js.map +1 -1
  7. package/build/audio-api-openapi.d.ts +2153 -0
  8. package/build/audio-api-openapi.js +7 -0
  9. package/build/audio-api-openapi.js.map +1 -0
  10. package/build/audio-api.d.ts +69 -190
  11. package/build/audio-api.js +27 -13
  12. package/build/audio-api.js.map +1 -1
  13. package/build/concept-api-openapi.d.ts +1682 -0
  14. package/build/concept-api-openapi.js +7 -0
  15. package/build/concept-api-openapi.js.map +1 -0
  16. package/build/concept-api.d.ts +69 -221
  17. package/build/concept-api.js +27 -21
  18. package/build/concept-api.js.map +1 -1
  19. package/build/draft-api-openapi.d.ts +2893 -0
  20. package/build/draft-api-openapi.js +7 -0
  21. package/build/draft-api-openapi.js.map +1 -0
  22. package/build/draft-api.d.ts +117 -292
  23. package/build/draft-api.js +27 -13
  24. package/build/draft-api.js.map +1 -1
  25. package/build/frontpage-api-openapi.d.ts +800 -0
  26. package/build/frontpage-api-openapi.js +7 -0
  27. package/build/frontpage-api-openapi.js.map +1 -0
  28. package/build/frontpage-api.d.ts +53 -121
  29. package/build/frontpage-api.js +27 -1
  30. package/build/frontpage-api.js.map +1 -1
  31. package/build/image-api-openapi.d.ts +2192 -0
  32. package/build/image-api-openapi.js +7 -0
  33. package/build/image-api-openapi.js.map +1 -0
  34. package/build/image-api.d.ts +61 -174
  35. package/build/image-api.js +27 -13
  36. package/build/image-api.js.map +1 -1
  37. package/build/learningpath-api-openapi.d.ts +2671 -0
  38. package/build/learningpath-api-openapi.js +7 -0
  39. package/build/learningpath-api-openapi.js.map +1 -0
  40. package/build/learningpath-api.d.ts +71 -143
  41. package/build/learningpath-api.js +27 -1
  42. package/build/learningpath-api.js.map +1 -1
  43. package/build/myndla-api-openapi.d.ts +2718 -0
  44. package/build/myndla-api-openapi.js +7 -0
  45. package/build/myndla-api-openapi.js.map +1 -0
  46. package/build/myndla-api.d.ts +69 -125
  47. package/build/myndla-api.js +27 -1
  48. package/build/myndla-api.js.map +1 -1
  49. package/build/oembed-proxy-openapi.d.ts +249 -0
  50. package/build/oembed-proxy-openapi.js +7 -0
  51. package/build/oembed-proxy-openapi.js.map +1 -0
  52. package/build/oembed-proxy.d.ts +15 -0
  53. package/build/oembed-proxy.js +30 -0
  54. package/build/oembed-proxy.js.map +1 -0
  55. package/build/search-api-openapi.d.ts +1525 -0
  56. package/build/search-api-openapi.js +7 -0
  57. package/build/search-api-openapi.js.map +1 -0
  58. package/build/search-api.d.ts +121 -422
  59. package/build/search-api.js +27 -33
  60. package/build/search-api.js.map +1 -1
  61. package/package.json +2 -1
@@ -0,0 +1,1682 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export type paths = {
6
+ "/concept-api/v1/drafts/status-state-machine": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * Get status state machine
15
+ * @description Get status state machine
16
+ */
17
+ get: operations["getConcept-apiV1DraftsStatus-state-machine"];
18
+ put?: never;
19
+ post?: never;
20
+ delete?: never;
21
+ options?: never;
22
+ head?: never;
23
+ patch?: never;
24
+ trace?: never;
25
+ };
26
+ "/concept-api/v1/drafts/tags": {
27
+ parameters: {
28
+ query?: never;
29
+ header?: never;
30
+ path?: never;
31
+ cookie?: never;
32
+ };
33
+ /**
34
+ * Returns a list of all tags in the specified subjects
35
+ * @description Returns a list of all tags in the specified subjects
36
+ */
37
+ get: operations["getConcept-apiV1DraftsTags"];
38
+ put?: never;
39
+ post?: never;
40
+ delete?: never;
41
+ options?: never;
42
+ head?: never;
43
+ patch?: never;
44
+ trace?: never;
45
+ };
46
+ "/concept-api/v1/drafts/search": {
47
+ parameters: {
48
+ query?: never;
49
+ header?: never;
50
+ path?: never;
51
+ cookie?: never;
52
+ };
53
+ get?: never;
54
+ put?: never;
55
+ /**
56
+ * Show all concepts
57
+ * @description Shows all concepts. You can search it too.
58
+ */
59
+ post: operations["postConcept-apiV1DraftsSearch"];
60
+ delete?: never;
61
+ options?: never;
62
+ head?: never;
63
+ patch?: never;
64
+ trace?: never;
65
+ };
66
+ "/concept-api/v1/drafts/{concept_id}": {
67
+ parameters: {
68
+ query?: never;
69
+ header?: never;
70
+ path?: never;
71
+ cookie?: never;
72
+ };
73
+ /**
74
+ * Show concept with a specified id
75
+ * @description Shows the concept for the specified id.
76
+ */
77
+ get: operations["getConcept-apiV1DraftsConcept_id"];
78
+ put?: never;
79
+ post?: never;
80
+ /**
81
+ * Delete language from concept
82
+ * @description Delete language from concept
83
+ */
84
+ delete: operations["deleteConcept-apiV1DraftsConcept_id"];
85
+ options?: never;
86
+ head?: never;
87
+ /**
88
+ * Update a concept
89
+ * @description Update a concept
90
+ */
91
+ patch: operations["patchConcept-apiV1DraftsConcept_id"];
92
+ trace?: never;
93
+ };
94
+ "/concept-api/v1/drafts/{concept_id}/status/{STATUS}": {
95
+ parameters: {
96
+ query?: never;
97
+ header?: never;
98
+ path?: never;
99
+ cookie?: never;
100
+ };
101
+ get?: never;
102
+ /**
103
+ * Update status of a concept
104
+ * @description Update status of a concept
105
+ */
106
+ put: operations["putConcept-apiV1DraftsConcept_idStatusStatus"];
107
+ post?: never;
108
+ delete?: never;
109
+ options?: never;
110
+ head?: never;
111
+ patch?: never;
112
+ trace?: never;
113
+ };
114
+ "/concept-api/v1/drafts/tag-search": {
115
+ parameters: {
116
+ query?: never;
117
+ header?: never;
118
+ path?: never;
119
+ cookie?: never;
120
+ };
121
+ /**
122
+ * Retrieves a list of all previously used tags in concepts
123
+ * @description Retrieves a list of all previously used tags in concepts
124
+ */
125
+ get: operations["getConcept-apiV1DraftsTag-search"];
126
+ put?: never;
127
+ post?: never;
128
+ delete?: never;
129
+ options?: never;
130
+ head?: never;
131
+ patch?: never;
132
+ trace?: never;
133
+ };
134
+ "/concept-api/v1/drafts": {
135
+ parameters: {
136
+ query?: never;
137
+ header?: never;
138
+ path?: never;
139
+ cookie?: never;
140
+ };
141
+ /**
142
+ * Show all concepts
143
+ * @description Shows all concepts. You can search it too.
144
+ */
145
+ get: operations["getConcept-apiV1Drafts"];
146
+ put?: never;
147
+ /**
148
+ * Create new concept
149
+ * @description Create new concept
150
+ */
151
+ post: operations["postConcept-apiV1Drafts"];
152
+ delete?: never;
153
+ options?: never;
154
+ head?: never;
155
+ patch?: never;
156
+ trace?: never;
157
+ };
158
+ "/concept-api/v1/concepts/tags": {
159
+ parameters: {
160
+ query?: never;
161
+ header?: never;
162
+ path?: never;
163
+ cookie?: never;
164
+ };
165
+ /**
166
+ * Returns a list of all tags in the specified subjects
167
+ * @description Returns a list of all tags in the specified subjects
168
+ */
169
+ get: operations["getConcept-apiV1ConceptsTags"];
170
+ put?: never;
171
+ post?: never;
172
+ delete?: never;
173
+ options?: never;
174
+ head?: never;
175
+ patch?: never;
176
+ trace?: never;
177
+ };
178
+ "/concept-api/v1/concepts/{concept_id}": {
179
+ parameters: {
180
+ query?: never;
181
+ header?: never;
182
+ path?: never;
183
+ cookie?: never;
184
+ };
185
+ /**
186
+ * Show concept with a specified id
187
+ * @description Shows the concept for the specified id.
188
+ */
189
+ get: operations["getConcept-apiV1ConceptsConcept_id"];
190
+ put?: never;
191
+ post?: never;
192
+ delete?: never;
193
+ options?: never;
194
+ head?: never;
195
+ patch?: never;
196
+ trace?: never;
197
+ };
198
+ "/concept-api/v1/concepts": {
199
+ parameters: {
200
+ query?: never;
201
+ header?: never;
202
+ path?: never;
203
+ cookie?: never;
204
+ };
205
+ /**
206
+ * Show all concepts
207
+ * @description Shows all concepts. You can search it too.
208
+ */
209
+ get: operations["getConcept-apiV1Concepts"];
210
+ put?: never;
211
+ post?: never;
212
+ delete?: never;
213
+ options?: never;
214
+ head?: never;
215
+ patch?: never;
216
+ trace?: never;
217
+ };
218
+ "/concept-api/v1/concepts/search": {
219
+ parameters: {
220
+ query?: never;
221
+ header?: never;
222
+ path?: never;
223
+ cookie?: never;
224
+ };
225
+ get?: never;
226
+ put?: never;
227
+ /**
228
+ * Show all concepts
229
+ * @description Shows all concepts. You can search it too.
230
+ */
231
+ post: operations["postConcept-apiV1ConceptsSearch"];
232
+ delete?: never;
233
+ options?: never;
234
+ head?: never;
235
+ patch?: never;
236
+ trace?: never;
237
+ };
238
+ };
239
+ export type webhooks = Record<string, never>;
240
+ export type components = {
241
+ schemas: {
242
+ /** AllErrors */
243
+ AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
244
+ /**
245
+ * AuthorDTO
246
+ * @description Information about an author
247
+ */
248
+ AuthorDTO: {
249
+ type: components["schemas"]["ContributorType"];
250
+ /** @description The name of the of the author */
251
+ name: string;
252
+ };
253
+ /** ConceptContent */
254
+ ConceptContent: {
255
+ /** @description The content of this concept */
256
+ content: string;
257
+ /** @description The html content of this concept */
258
+ htmlContent: string;
259
+ /** @description The language of this concept */
260
+ language: string;
261
+ };
262
+ /**
263
+ * ConceptDTO
264
+ * @description Information about the concept
265
+ */
266
+ ConceptDTO: {
267
+ /**
268
+ * Format: int64
269
+ * @description The unique id of the concept
270
+ */
271
+ id: number;
272
+ /**
273
+ * Format: int32
274
+ * @description The revision of the concept
275
+ */
276
+ revision: number;
277
+ title: components["schemas"]["ConceptTitleDTO"];
278
+ /** @description The content of the concept */
279
+ content?: components["schemas"]["ConceptContent"];
280
+ /** @description Describes the copyright information for the concept */
281
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
282
+ /** @description URL for the source of the concept */
283
+ source?: string;
284
+ /** @description A meta image for the concept */
285
+ metaImage?: components["schemas"]["ConceptMetaImageDTO"];
286
+ tags?: components["schemas"]["ConceptTagsDTO"];
287
+ /** @description When the concept was created */
288
+ created: string;
289
+ /** @description When the concept was last updated */
290
+ updated: string;
291
+ /** @description List of people that updated this concept */
292
+ updatedBy?: string[];
293
+ /** @description All available languages of the current concept */
294
+ supportedLanguages: string[];
295
+ /** @description Status information of the concept */
296
+ status: components["schemas"]["StatusDTO"];
297
+ visualElement?: components["schemas"]["VisualElementDTO"];
298
+ responsible?: components["schemas"]["ConceptResponsibleDTO"];
299
+ /** @description Type of concept. 'concept', or 'gloss' */
300
+ conceptType: string;
301
+ glossData?: components["schemas"]["GlossDataDTO"];
302
+ /** @description Describes the changes made to the concept, only visible to editors */
303
+ editorNotes?: components["schemas"]["EditorNoteDTO"][];
304
+ };
305
+ /** ConceptMetaImageDTO */
306
+ ConceptMetaImageDTO: {
307
+ /** @description The meta image url */
308
+ url: string;
309
+ /** @description The alt text for the meta image */
310
+ alt: string;
311
+ /** @description The ISO 639-1 language code describing which concept translation this meta image belongs to */
312
+ language: string;
313
+ };
314
+ /**
315
+ * ConceptResponsibleDTO
316
+ * @description Object with data representing the editor responsible for this concept
317
+ */
318
+ ConceptResponsibleDTO: {
319
+ /** @description NDLA ID of responsible editor */
320
+ responsibleId: string;
321
+ /** @description Date of when the responsible editor was last updated */
322
+ lastUpdated: string;
323
+ };
324
+ /**
325
+ * ConceptSearchParamsDTO
326
+ * @description The search parameters
327
+ */
328
+ ConceptSearchParamsDTO: {
329
+ /** @description The search query. */
330
+ query?: string;
331
+ /** @description The ISO 639-1 language code describing language used in query-params. */
332
+ language?: string;
333
+ /**
334
+ * Format: int32
335
+ * @description The page number of the search hits to display.
336
+ */
337
+ page?: number;
338
+ /**
339
+ * Format: int32
340
+ * @description The number of search hits to display for each page.
341
+ */
342
+ pageSize?: number;
343
+ /** @description Return only articles that have one of the provided ids. */
344
+ ids?: number[];
345
+ sort?: components["schemas"]["Sort"];
346
+ /** @description Whether to fallback to existing language if not found in selected language. */
347
+ fallback?: boolean;
348
+ /** @description A search context retrieved from the response header of a previous search. */
349
+ scrollId?: string;
350
+ /** @description A comma-separated list of tags to filter the search by. */
351
+ tags?: string[];
352
+ /** @description If provided, only return concept where query matches title exactly. */
353
+ exactMatch?: boolean;
354
+ /** @description Embed resource type that should exist in the concepts. */
355
+ embedResource?: string[];
356
+ /** @description Embed id attribute that should exist in the concepts. */
357
+ embedId?: string;
358
+ /** @description The type of concepts to return. */
359
+ conceptType?: string;
360
+ /** @description A list of index paths to aggregate over */
361
+ aggregatePaths?: string[];
362
+ };
363
+ /**
364
+ * ConceptSearchResultDTO
365
+ * @description Information about search-results
366
+ */
367
+ ConceptSearchResultDTO: {
368
+ /**
369
+ * Format: int64
370
+ * @description The total number of articles matching this query
371
+ */
372
+ totalCount: number;
373
+ /**
374
+ * Format: int32
375
+ * @description For which page results are shown from
376
+ */
377
+ page?: number;
378
+ /**
379
+ * Format: int32
380
+ * @description The number of results per page
381
+ */
382
+ pageSize: number;
383
+ /** @description The chosen search language */
384
+ language: string;
385
+ /** @description The search results */
386
+ results: components["schemas"]["ConceptSummaryDTO"][];
387
+ /** @description The aggregated fields if specified in query */
388
+ aggregations: components["schemas"]["MultiSearchTermsAggregationDTO"][];
389
+ };
390
+ /**
391
+ * ConceptSummaryDTO
392
+ * @description Information about the concept
393
+ */
394
+ ConceptSummaryDTO: {
395
+ /**
396
+ * Format: int64
397
+ * @description The unique id of the concept
398
+ */
399
+ id: number;
400
+ title: components["schemas"]["ConceptTitleDTO"];
401
+ /** @description The content of the concept in available languages */
402
+ content: components["schemas"]["ConceptContent"];
403
+ /** @description The metaImage of the concept */
404
+ metaImage: components["schemas"]["ConceptMetaImageDTO"];
405
+ tags?: components["schemas"]["ConceptTagsDTO"];
406
+ /** @description All available languages of the current concept */
407
+ supportedLanguages: string[];
408
+ /** @description The time when the article was last updated */
409
+ lastUpdated: string;
410
+ /** @description When the concept was created */
411
+ created: string;
412
+ /** @description Status information of the concept */
413
+ status: components["schemas"]["StatusDTO"];
414
+ /** @description List of people that edited the concept */
415
+ updatedBy: string[];
416
+ /** @description Describes the license of the concept */
417
+ license?: string;
418
+ /** @description Describes the copyright of the concept */
419
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
420
+ visualElement?: components["schemas"]["VisualElementDTO"];
421
+ /** @description URL for the source of the concept */
422
+ source?: string;
423
+ responsible?: components["schemas"]["ConceptResponsibleDTO"];
424
+ /** @description Type of concept. 'concept', or 'gloss' */
425
+ conceptType: string;
426
+ glossData?: components["schemas"]["GlossDataDTO"];
427
+ /** @description A translated name of the concept type */
428
+ conceptTypeName: string;
429
+ };
430
+ /**
431
+ * ConceptTagsDTO
432
+ * @description Search tags the concept is tagged with
433
+ */
434
+ ConceptTagsDTO: {
435
+ /** @description Searchable tags */
436
+ tags: string[];
437
+ /** @description The ISO 639-1 language code describing which concept translation these tags belongs to */
438
+ language: string;
439
+ };
440
+ /**
441
+ * ConceptTitleDTO
442
+ * @description Available titles for the concept
443
+ */
444
+ ConceptTitleDTO: {
445
+ /** @description The title of this concept */
446
+ title: string;
447
+ /** @description The language of this concept */
448
+ language: string;
449
+ };
450
+ /**
451
+ * ContributorType
452
+ * @description The description of the author. Eg. Photographer or Supplier
453
+ * @enum {string}
454
+ */
455
+ ContributorType: "artist" | "cowriter" | "compiler" | "composer" | "correction" | "director" | "distributor" | "editorial" | "facilitator" | "idea" | "illustrator" | "linguistic" | "originator" | "photographer" | "processor" | "publisher" | "reader" | "rightsholder" | "scriptwriter" | "supplier" | "translator" | "writer";
456
+ /**
457
+ * DraftConceptSearchParamsDTO
458
+ * @description The search parameters
459
+ */
460
+ DraftConceptSearchParamsDTO: {
461
+ /** @description The search query. */
462
+ query?: string;
463
+ /** @description The ISO 639-1 language code describing language used in query-params. */
464
+ language?: string;
465
+ /**
466
+ * Format: int32
467
+ * @description The page number of the search hits to display.
468
+ */
469
+ page?: number;
470
+ /**
471
+ * Format: int32
472
+ * @description The number of search hits to display for each page.
473
+ */
474
+ pageSize?: number;
475
+ /** @description Return only articles that have one of the provided ids. */
476
+ ids?: number[];
477
+ sort?: components["schemas"]["Sort"];
478
+ /** @description Whether to fallback to existing language if not found in selected language. */
479
+ fallback?: boolean;
480
+ /** @description A search context retrieved from the response header of a previous search. */
481
+ scrollId?: string;
482
+ /** @description A comma-separated list of tags to filter the search by. */
483
+ tags?: string[];
484
+ /** @description A comma-separated list of statuses that should appear in the search. */
485
+ status?: string[];
486
+ /** @description A comma-separated list of users to filter the search by. */
487
+ users?: string[];
488
+ /** @description Embed resource type that should exist in the concepts. */
489
+ embedResource?: string[];
490
+ /** @description Embed id attribute that should exist in the concepts. */
491
+ embedId?: string;
492
+ /** @description A comma-separated list of NDLA IDs to filter the search by. */
493
+ responsibleIds?: string[];
494
+ /** @description The type of concepts to return. */
495
+ conceptType?: string;
496
+ /** @description A list of index paths to aggregate over */
497
+ aggregatePaths?: string[];
498
+ };
499
+ /** DraftCopyrightDTO */
500
+ DraftCopyrightDTO: {
501
+ license?: components["schemas"]["LicenseDTO"];
502
+ /** @description Reference to where the article is procured */
503
+ origin?: string;
504
+ /** @description List of creators */
505
+ creators: components["schemas"]["AuthorDTO"][];
506
+ /** @description List of processors */
507
+ processors: components["schemas"]["AuthorDTO"][];
508
+ /** @description List of rightsholders */
509
+ rightsholders: components["schemas"]["AuthorDTO"][];
510
+ /** @description Date from which the copyright is valid */
511
+ validFrom?: string;
512
+ /** @description Date to which the copyright is valid */
513
+ validTo?: string;
514
+ /** @description Whether or not the content has been processed */
515
+ processed: boolean;
516
+ };
517
+ /**
518
+ * EditorNoteDTO
519
+ * @description Information about the editorial notes
520
+ */
521
+ EditorNoteDTO: {
522
+ /** @description Editorial note */
523
+ note: string;
524
+ /** @description User which saved the note */
525
+ updatedBy: string;
526
+ /** @description Status of concept at saved time */
527
+ status: components["schemas"]["StatusDTO"];
528
+ /** @description Timestamp of when note was saved */
529
+ timestamp: string;
530
+ };
531
+ /**
532
+ * ErrorBody
533
+ * @description Information about an error
534
+ */
535
+ ErrorBody: {
536
+ /** @description Code stating the type of error */
537
+ code: string;
538
+ /** @description Description of the error */
539
+ description: string;
540
+ /** @description When the error occurred */
541
+ occurredAt: string;
542
+ /**
543
+ * Format: int32
544
+ * @description Numeric http status code
545
+ */
546
+ statusCode: number;
547
+ };
548
+ /**
549
+ * GlossDataDTO
550
+ * @description Information about the gloss
551
+ */
552
+ GlossDataDTO: {
553
+ /** @description The gloss itself */
554
+ gloss: string;
555
+ /** @description Word class / part of speech, ex. noun, adjective, verb, adverb, ... */
556
+ wordClass: string;
557
+ /** @description Original language of the gloss */
558
+ originalLanguage: string;
559
+ /** @description Alternative writing of the gloss */
560
+ transcriptions: components["schemas"]["Map_String"];
561
+ /** @description List of examples of how the gloss can be used */
562
+ examples: components["schemas"]["GlossExampleDTO"][][];
563
+ };
564
+ /**
565
+ * GlossExampleDTO
566
+ * @description Information about the gloss example
567
+ */
568
+ GlossExampleDTO: {
569
+ /** @description Example use of the gloss */
570
+ example: string;
571
+ /** @description Language of the example */
572
+ language: string;
573
+ /** @description Alternative writing of the example */
574
+ transcriptions: components["schemas"]["Map_String"];
575
+ };
576
+ /**
577
+ * LicenseDTO
578
+ * @description Describes the license of the article
579
+ */
580
+ LicenseDTO: {
581
+ /** @description The name of the license */
582
+ license: string;
583
+ /** @description Description of the license */
584
+ description?: string;
585
+ /** @description Url to where the license can be found */
586
+ url?: string;
587
+ };
588
+ /** Map_List_String */
589
+ Map_List_String: {
590
+ [key: string]: string[];
591
+ };
592
+ /** Map_String */
593
+ Map_String: {
594
+ [key: string]: string;
595
+ };
596
+ /**
597
+ * MultiSearchTermsAggregationDTO
598
+ * @description Information about search aggregation on `field`
599
+ */
600
+ MultiSearchTermsAggregationDTO: {
601
+ /** @description The field the specific aggregation is matching */
602
+ field: string;
603
+ /**
604
+ * Format: int32
605
+ * @description Number of documents with values that didn't appear in the aggregation. (Will only happen if there are more than 50 different values)
606
+ */
607
+ sumOtherDocCount: number;
608
+ /**
609
+ * Format: int32
610
+ * @description The result is approximate, this gives an approximation of potential errors. (Specifics here: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-approximate-counts)
611
+ */
612
+ docCountErrorUpperBound: number;
613
+ /** @description Values appearing in the field */
614
+ values: components["schemas"]["TermValueDTO"][];
615
+ };
616
+ /**
617
+ * NewConceptDTO
618
+ * @description Information about the concept
619
+ */
620
+ NewConceptDTO: {
621
+ /** @description The language of this concept */
622
+ language: string;
623
+ /** @description Available titles for the concept */
624
+ title: string;
625
+ /** @description The content of the concept */
626
+ content?: string;
627
+ /** @description Describes the copyright information for the concept */
628
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
629
+ /** @description An image-api ID for the concept meta image */
630
+ metaImage?: components["schemas"]["NewConceptMetaImageDTO"];
631
+ /** @description A list of searchable tags */
632
+ tags?: string[];
633
+ /** @description A visual element for the concept. May be anything from an image to a video or H5P */
634
+ visualElement?: string;
635
+ /** @description NDLA ID representing the editor responsible for this article */
636
+ responsibleId?: string;
637
+ /** @description Type of concept. 'concept', or 'gloss' */
638
+ conceptType: string;
639
+ glossData?: components["schemas"]["GlossDataDTO"];
640
+ };
641
+ /** NewConceptMetaImageDTO */
642
+ NewConceptMetaImageDTO: {
643
+ /** @description The image-api id of the meta image */
644
+ id: string;
645
+ /** @description The alt text of the meta image */
646
+ alt: string;
647
+ };
648
+ /**
649
+ * NotFoundWithSupportedLanguages
650
+ * @description Information about an error
651
+ */
652
+ NotFoundWithSupportedLanguages: {
653
+ /** @description Code stating the type of error */
654
+ code: string;
655
+ /** @description Description of the error */
656
+ description: string;
657
+ /** @description When the error occurred */
658
+ occurredAt: string;
659
+ /** @description List of supported languages */
660
+ supportedLanguages?: string[];
661
+ /**
662
+ * Format: int32
663
+ * @description Numeric http status code
664
+ */
665
+ statusCode: number;
666
+ };
667
+ /**
668
+ * Sort
669
+ * @description The sorting used on results. Default is by -relevance.
670
+ * @enum {string}
671
+ */
672
+ Sort: "-relevance" | "relevance" | "-title" | "title" | "-lastUpdated" | "lastUpdated" | "-id" | "id" | "-responsibleLastUpdated" | "responsibleLastUpdated" | "status" | "-status" | "subject" | "-subject" | "conceptType" | "-conceptType";
673
+ /** StatusDTO */
674
+ StatusDTO: {
675
+ /** @description The current status of the concept */
676
+ current: string;
677
+ /** @description Previous statuses this concept has been in */
678
+ other: string[];
679
+ };
680
+ /**
681
+ * TagsSearchResultDTO
682
+ * @description Information about tags-search-results
683
+ */
684
+ TagsSearchResultDTO: {
685
+ /**
686
+ * Format: int32
687
+ * @description The total number of tags matching this query
688
+ */
689
+ totalCount: number;
690
+ /**
691
+ * Format: int32
692
+ * @description For which page results are shown from
693
+ */
694
+ page: number;
695
+ /**
696
+ * Format: int32
697
+ * @description The number of results per page
698
+ */
699
+ pageSize: number;
700
+ /** @description The chosen search language */
701
+ language: string;
702
+ /** @description The search results */
703
+ results: string[];
704
+ };
705
+ /**
706
+ * TermValueDTO
707
+ * @description Value that appears in the search aggregation
708
+ */
709
+ TermValueDTO: {
710
+ /** @description Value that appeared in result */
711
+ value: string;
712
+ /**
713
+ * Format: int32
714
+ * @description Number of times the value appeared in result
715
+ */
716
+ count: number;
717
+ };
718
+ /**
719
+ * UpdatedConceptDTO
720
+ * @description Information about the concept
721
+ */
722
+ UpdatedConceptDTO: {
723
+ /** @description The language of this concept */
724
+ language: string;
725
+ /** @description Available titles for the concept */
726
+ title?: string;
727
+ /** @description The content of the concept */
728
+ content?: string;
729
+ metaImage?: components["schemas"]["NewConceptMetaImageDTO"] | null;
730
+ /** @description Describes the copyright information for the concept */
731
+ copyright?: components["schemas"]["DraftCopyrightDTO"];
732
+ /** @description A list of searchable tags */
733
+ tags?: string[];
734
+ /** @description The new status of the concept */
735
+ status?: string;
736
+ /** @description A visual element for the concept. May be anything from an image to a video or H5P */
737
+ visualElement?: string;
738
+ /** @description NDLA ID representing the editor responsible for this article */
739
+ responsibleId?: string | null;
740
+ /** @description Type of concept. 'concept', or 'gloss' */
741
+ conceptType?: string;
742
+ glossData?: components["schemas"]["GlossDataDTO"];
743
+ };
744
+ /**
745
+ * ValidationErrorBody
746
+ * @description Information about an error
747
+ */
748
+ ValidationErrorBody: {
749
+ /** @description Code stating the type of error */
750
+ code: string;
751
+ /** @description Description of the error */
752
+ description: string;
753
+ /** @description When the error occurred */
754
+ occurredAt: string;
755
+ /** @description List of validation messages */
756
+ messages?: components["schemas"]["ValidationMessage"][];
757
+ /**
758
+ * Format: int32
759
+ * @description Numeric http status code
760
+ */
761
+ statusCode: number;
762
+ };
763
+ /**
764
+ * ValidationMessage
765
+ * @description A message describing a validation error on a specific field
766
+ */
767
+ ValidationMessage: {
768
+ /** @description The field the error occured in */
769
+ field: string;
770
+ /** @description The validation message */
771
+ message: string;
772
+ };
773
+ /**
774
+ * VisualElementDTO
775
+ * @description A visual element for the concept
776
+ */
777
+ VisualElementDTO: {
778
+ /** @description Html containing the visual element. May contain any legal html element, including the embed-tag */
779
+ visualElement: string;
780
+ /** @description The ISO 639-1 language code describing which article translation this visual element belongs to */
781
+ language: string;
782
+ };
783
+ };
784
+ responses: never;
785
+ parameters: never;
786
+ requestBodies: never;
787
+ headers: never;
788
+ pathItems: never;
789
+ };
790
+ export type $defs = Record<string, never>;
791
+ export interface operations {
792
+ "getConcept-apiV1DraftsStatus-state-machine": {
793
+ parameters: {
794
+ query?: never;
795
+ header?: never;
796
+ path?: never;
797
+ cookie?: never;
798
+ };
799
+ requestBody?: never;
800
+ responses: {
801
+ 200: {
802
+ headers: {
803
+ /**
804
+ * @description null
805
+ * @example null
806
+ */
807
+ "Cache-Control": string;
808
+ [name: string]: unknown;
809
+ };
810
+ content: {
811
+ "application/json": components["schemas"]["Map_List_String"];
812
+ };
813
+ };
814
+ 400: {
815
+ headers: {
816
+ [name: string]: unknown;
817
+ };
818
+ content: {
819
+ "application/json": components["schemas"]["AllErrors"];
820
+ };
821
+ };
822
+ 401: {
823
+ headers: {
824
+ [name: string]: unknown;
825
+ };
826
+ content: {
827
+ "application/json": components["schemas"]["AllErrors"];
828
+ };
829
+ };
830
+ 403: {
831
+ headers: {
832
+ [name: string]: unknown;
833
+ };
834
+ content: {
835
+ "application/json": components["schemas"]["AllErrors"];
836
+ };
837
+ };
838
+ 404: {
839
+ headers: {
840
+ [name: string]: unknown;
841
+ };
842
+ content: {
843
+ "application/json": components["schemas"]["AllErrors"];
844
+ };
845
+ };
846
+ 500: {
847
+ headers: {
848
+ [name: string]: unknown;
849
+ };
850
+ content: {
851
+ "application/json": components["schemas"]["ErrorBody"];
852
+ };
853
+ };
854
+ };
855
+ };
856
+ "getConcept-apiV1DraftsTags": {
857
+ parameters: {
858
+ query?: {
859
+ /** @description The ISO 639-1 language code describing language. */
860
+ language?: string;
861
+ /** @description Fallback to existing language if language is specified. */
862
+ fallback?: boolean;
863
+ };
864
+ header?: never;
865
+ path?: never;
866
+ cookie?: never;
867
+ };
868
+ requestBody?: never;
869
+ responses: {
870
+ 200: {
871
+ headers: {
872
+ /**
873
+ * @description null
874
+ * @example null
875
+ */
876
+ "Cache-Control": string;
877
+ [name: string]: unknown;
878
+ };
879
+ content: {
880
+ "application/json": string[];
881
+ };
882
+ };
883
+ 400: {
884
+ headers: {
885
+ [name: string]: unknown;
886
+ };
887
+ content: {
888
+ "application/json": components["schemas"]["AllErrors"];
889
+ };
890
+ };
891
+ 403: {
892
+ headers: {
893
+ [name: string]: unknown;
894
+ };
895
+ content: {
896
+ "application/json": components["schemas"]["AllErrors"];
897
+ };
898
+ };
899
+ 404: {
900
+ headers: {
901
+ [name: string]: unknown;
902
+ };
903
+ content: {
904
+ "application/json": components["schemas"]["AllErrors"];
905
+ };
906
+ };
907
+ 500: {
908
+ headers: {
909
+ [name: string]: unknown;
910
+ };
911
+ content: {
912
+ "application/json": components["schemas"]["ErrorBody"];
913
+ };
914
+ };
915
+ };
916
+ };
917
+ "postConcept-apiV1DraftsSearch": {
918
+ parameters: {
919
+ query?: never;
920
+ header?: never;
921
+ path?: never;
922
+ cookie?: never;
923
+ };
924
+ requestBody: {
925
+ content: {
926
+ "application/json": components["schemas"]["DraftConceptSearchParamsDTO"];
927
+ };
928
+ };
929
+ responses: {
930
+ 200: {
931
+ headers: {
932
+ /**
933
+ * @description null
934
+ * @example null
935
+ */
936
+ "Cache-Control": string;
937
+ [name: string]: unknown;
938
+ };
939
+ content: {
940
+ "application/json": components["schemas"]["ConceptSearchResultDTO"];
941
+ };
942
+ };
943
+ 400: {
944
+ headers: {
945
+ [name: string]: unknown;
946
+ };
947
+ content: {
948
+ "application/json": components["schemas"]["AllErrors"];
949
+ };
950
+ };
951
+ 403: {
952
+ headers: {
953
+ [name: string]: unknown;
954
+ };
955
+ content: {
956
+ "application/json": components["schemas"]["AllErrors"];
957
+ };
958
+ };
959
+ 404: {
960
+ headers: {
961
+ [name: string]: unknown;
962
+ };
963
+ content: {
964
+ "application/json": components["schemas"]["AllErrors"];
965
+ };
966
+ };
967
+ 500: {
968
+ headers: {
969
+ [name: string]: unknown;
970
+ };
971
+ content: {
972
+ "application/json": components["schemas"]["ErrorBody"];
973
+ };
974
+ };
975
+ };
976
+ };
977
+ "getConcept-apiV1DraftsConcept_id": {
978
+ parameters: {
979
+ query?: {
980
+ /** @description The ISO 639-1 language code describing language. */
981
+ language?: string;
982
+ /** @description Fallback to existing language if language is specified. */
983
+ fallback?: boolean;
984
+ };
985
+ header?: never;
986
+ path: {
987
+ /** @description Id of the concept that is to be returned */
988
+ concept_id: number;
989
+ };
990
+ cookie?: never;
991
+ };
992
+ requestBody?: never;
993
+ responses: {
994
+ 200: {
995
+ headers: {
996
+ /**
997
+ * @description null
998
+ * @example null
999
+ */
1000
+ "Cache-Control": string;
1001
+ [name: string]: unknown;
1002
+ };
1003
+ content: {
1004
+ "application/json": components["schemas"]["ConceptDTO"];
1005
+ };
1006
+ };
1007
+ 400: {
1008
+ headers: {
1009
+ [name: string]: unknown;
1010
+ };
1011
+ content: {
1012
+ "application/json": components["schemas"]["AllErrors"];
1013
+ };
1014
+ };
1015
+ 404: {
1016
+ headers: {
1017
+ [name: string]: unknown;
1018
+ };
1019
+ content: {
1020
+ "application/json": components["schemas"]["AllErrors"];
1021
+ };
1022
+ };
1023
+ 500: {
1024
+ headers: {
1025
+ [name: string]: unknown;
1026
+ };
1027
+ content: {
1028
+ "application/json": components["schemas"]["ErrorBody"];
1029
+ };
1030
+ };
1031
+ };
1032
+ };
1033
+ "deleteConcept-apiV1DraftsConcept_id": {
1034
+ parameters: {
1035
+ query?: {
1036
+ /** @description The ISO 639-1 language code describing language. */
1037
+ language?: string;
1038
+ };
1039
+ header?: never;
1040
+ path: {
1041
+ /** @description Id of the concept that is to be returned */
1042
+ concept_id: number;
1043
+ };
1044
+ cookie?: never;
1045
+ };
1046
+ requestBody?: never;
1047
+ responses: {
1048
+ 200: {
1049
+ headers: {
1050
+ /**
1051
+ * @description null
1052
+ * @example null
1053
+ */
1054
+ "Cache-Control": string;
1055
+ [name: string]: unknown;
1056
+ };
1057
+ content: {
1058
+ "application/json": components["schemas"]["ConceptDTO"];
1059
+ };
1060
+ };
1061
+ 400: {
1062
+ headers: {
1063
+ [name: string]: unknown;
1064
+ };
1065
+ content: {
1066
+ "application/json": components["schemas"]["AllErrors"];
1067
+ };
1068
+ };
1069
+ 403: {
1070
+ headers: {
1071
+ [name: string]: unknown;
1072
+ };
1073
+ content: {
1074
+ "application/json": components["schemas"]["AllErrors"];
1075
+ };
1076
+ };
1077
+ 404: {
1078
+ headers: {
1079
+ [name: string]: unknown;
1080
+ };
1081
+ content: {
1082
+ "application/json": components["schemas"]["AllErrors"];
1083
+ };
1084
+ };
1085
+ 500: {
1086
+ headers: {
1087
+ [name: string]: unknown;
1088
+ };
1089
+ content: {
1090
+ "application/json": components["schemas"]["ErrorBody"];
1091
+ };
1092
+ };
1093
+ };
1094
+ };
1095
+ "patchConcept-apiV1DraftsConcept_id": {
1096
+ parameters: {
1097
+ query?: never;
1098
+ header?: never;
1099
+ path: {
1100
+ /** @description Id of the concept that is to be returned */
1101
+ concept_id: number;
1102
+ };
1103
+ cookie?: never;
1104
+ };
1105
+ requestBody: {
1106
+ content: {
1107
+ "application/json": components["schemas"]["UpdatedConceptDTO"];
1108
+ };
1109
+ };
1110
+ responses: {
1111
+ 200: {
1112
+ headers: {
1113
+ /**
1114
+ * @description null
1115
+ * @example null
1116
+ */
1117
+ "Cache-Control": string;
1118
+ [name: string]: unknown;
1119
+ };
1120
+ content: {
1121
+ "application/json": components["schemas"]["ConceptDTO"];
1122
+ };
1123
+ };
1124
+ 400: {
1125
+ headers: {
1126
+ [name: string]: unknown;
1127
+ };
1128
+ content: {
1129
+ "application/json": components["schemas"]["AllErrors"];
1130
+ };
1131
+ };
1132
+ 403: {
1133
+ headers: {
1134
+ [name: string]: unknown;
1135
+ };
1136
+ content: {
1137
+ "application/json": components["schemas"]["AllErrors"];
1138
+ };
1139
+ };
1140
+ 404: {
1141
+ headers: {
1142
+ [name: string]: unknown;
1143
+ };
1144
+ content: {
1145
+ "application/json": components["schemas"]["AllErrors"];
1146
+ };
1147
+ };
1148
+ 500: {
1149
+ headers: {
1150
+ [name: string]: unknown;
1151
+ };
1152
+ content: {
1153
+ "application/json": components["schemas"]["ErrorBody"];
1154
+ };
1155
+ };
1156
+ };
1157
+ };
1158
+ "putConcept-apiV1DraftsConcept_idStatusStatus": {
1159
+ parameters: {
1160
+ query?: never;
1161
+ header?: never;
1162
+ path: {
1163
+ /** @description Id of the concept that is to be returned */
1164
+ concept_id: number;
1165
+ /** @description Concept status */
1166
+ STATUS: string;
1167
+ };
1168
+ cookie?: never;
1169
+ };
1170
+ requestBody?: never;
1171
+ responses: {
1172
+ 200: {
1173
+ headers: {
1174
+ /**
1175
+ * @description null
1176
+ * @example null
1177
+ */
1178
+ "Cache-Control": string;
1179
+ [name: string]: unknown;
1180
+ };
1181
+ content: {
1182
+ "application/json": components["schemas"]["ConceptDTO"];
1183
+ };
1184
+ };
1185
+ 400: {
1186
+ headers: {
1187
+ [name: string]: unknown;
1188
+ };
1189
+ content: {
1190
+ "application/json": components["schemas"]["AllErrors"];
1191
+ };
1192
+ };
1193
+ 401: {
1194
+ headers: {
1195
+ [name: string]: unknown;
1196
+ };
1197
+ content: {
1198
+ "application/json": components["schemas"]["AllErrors"];
1199
+ };
1200
+ };
1201
+ 403: {
1202
+ headers: {
1203
+ [name: string]: unknown;
1204
+ };
1205
+ content: {
1206
+ "application/json": components["schemas"]["AllErrors"];
1207
+ };
1208
+ };
1209
+ 404: {
1210
+ headers: {
1211
+ [name: string]: unknown;
1212
+ };
1213
+ content: {
1214
+ "application/json": components["schemas"]["AllErrors"];
1215
+ };
1216
+ };
1217
+ 500: {
1218
+ headers: {
1219
+ [name: string]: unknown;
1220
+ };
1221
+ content: {
1222
+ "application/json": components["schemas"]["ErrorBody"];
1223
+ };
1224
+ };
1225
+ };
1226
+ };
1227
+ "getConcept-apiV1DraftsTag-search": {
1228
+ parameters: {
1229
+ query?: {
1230
+ /** @description Return only concepts with content matching the specified query. */
1231
+ query?: string;
1232
+ /** @description The number of search hits to display for each page. */
1233
+ "page-size"?: number;
1234
+ /** @description The page number of the search hits to display. */
1235
+ page?: number;
1236
+ /** @description The ISO 639-1 language code describing language. */
1237
+ language?: string;
1238
+ };
1239
+ header?: never;
1240
+ path?: never;
1241
+ cookie?: never;
1242
+ };
1243
+ requestBody?: never;
1244
+ responses: {
1245
+ 200: {
1246
+ headers: {
1247
+ /**
1248
+ * @description null
1249
+ * @example null
1250
+ */
1251
+ "Cache-Control": string;
1252
+ [name: string]: unknown;
1253
+ };
1254
+ content: {
1255
+ "application/json": components["schemas"]["TagsSearchResultDTO"];
1256
+ };
1257
+ };
1258
+ 400: {
1259
+ headers: {
1260
+ [name: string]: unknown;
1261
+ };
1262
+ content: {
1263
+ "application/json": components["schemas"]["AllErrors"];
1264
+ };
1265
+ };
1266
+ 403: {
1267
+ headers: {
1268
+ [name: string]: unknown;
1269
+ };
1270
+ content: {
1271
+ "application/json": components["schemas"]["AllErrors"];
1272
+ };
1273
+ };
1274
+ 404: {
1275
+ headers: {
1276
+ [name: string]: unknown;
1277
+ };
1278
+ content: {
1279
+ "application/json": components["schemas"]["AllErrors"];
1280
+ };
1281
+ };
1282
+ 500: {
1283
+ headers: {
1284
+ [name: string]: unknown;
1285
+ };
1286
+ content: {
1287
+ "application/json": components["schemas"]["ErrorBody"];
1288
+ };
1289
+ };
1290
+ };
1291
+ };
1292
+ "getConcept-apiV1Drafts": {
1293
+ parameters: {
1294
+ query?: {
1295
+ /** @description Return only concepts with content matching the specified query. */
1296
+ query?: string;
1297
+ /** @description Return only concepts that have one of the provided ids. To provide multiple ids, separate by comma (,). */
1298
+ ids?: number[];
1299
+ /** @description The ISO 639-1 language code describing language. */
1300
+ language?: string;
1301
+ /** @description The page number of the search hits to display. */
1302
+ page?: number;
1303
+ /** @description The number of search hits to display for each page. */
1304
+ "page-size"?: number;
1305
+ /** @description The sorting used on results.
1306
+ * The following are supported: ByRelevanceDesc,ByRelevanceAsc,ByTitleDesc,ByTitleAsc,ByLastUpdatedDesc,ByLastUpdatedAsc,ByIdDesc,ByIdAsc,ByResponsibleLastUpdatedDesc,ByResponsibleLastUpdatedAsc,ByStatusAsc,ByStatusDesc,BySubjectAsc,BySubjectDesc,ByConceptTypeAsc,ByConceptTypeDesc
1307
+ * Default is by -relevance (desc) when query is set, and title (asc) when query is empty. */
1308
+ sort?: string;
1309
+ /** @description Fallback to existing language if language is specified. */
1310
+ fallback?: boolean;
1311
+ /** @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].
1312
+ * When scrolling, the parameters from the initial search is used, except in the case of 'language' and 'fallback'.
1313
+ * This value may change between scrolls. Always use the one in the latest scroll result.
1314
+ * If you are not paginating very far, you can ignore this and use 'page' and 'page-size' instead.
1315
+ * */
1316
+ "search-context"?: string;
1317
+ /** @description A comma-separated list of tags to filter the search by. */
1318
+ tags?: string[];
1319
+ /** @description List of statuses to filter by.
1320
+ * A draft only needs to have one of the available statuses to appear in result (OR).
1321
+ * */
1322
+ status?: string[];
1323
+ /** @description List of users to filter by.
1324
+ * The value to search for is the user-id from Auth0. */
1325
+ users?: string[];
1326
+ /** @description Return concepts with matching embed type. */
1327
+ "embed-resource"?: string[];
1328
+ /** @description Return concepts with matching embed id. */
1329
+ "embed-id"?: string;
1330
+ /** @description List of responsible ids to filter by (OR filter) */
1331
+ "responsible-ids"?: string[];
1332
+ /** @description Return only concepts of given type. Allowed values are concept,gloss */
1333
+ "concept-type"?: string;
1334
+ /** @description List of index-paths that should be term-aggregated and returned in result. */
1335
+ "aggregate-paths"?: string[];
1336
+ };
1337
+ header?: never;
1338
+ path?: never;
1339
+ cookie?: never;
1340
+ };
1341
+ requestBody?: never;
1342
+ responses: {
1343
+ 200: {
1344
+ headers: {
1345
+ /**
1346
+ * @description null
1347
+ * @example null
1348
+ */
1349
+ "Cache-Control": string;
1350
+ [name: string]: unknown;
1351
+ };
1352
+ content: {
1353
+ "application/json": components["schemas"]["ConceptSearchResultDTO"];
1354
+ };
1355
+ };
1356
+ 400: {
1357
+ headers: {
1358
+ [name: string]: unknown;
1359
+ };
1360
+ content: {
1361
+ "application/json": components["schemas"]["AllErrors"];
1362
+ };
1363
+ };
1364
+ 404: {
1365
+ headers: {
1366
+ [name: string]: unknown;
1367
+ };
1368
+ content: {
1369
+ "application/json": components["schemas"]["AllErrors"];
1370
+ };
1371
+ };
1372
+ 500: {
1373
+ headers: {
1374
+ [name: string]: unknown;
1375
+ };
1376
+ content: {
1377
+ "application/json": components["schemas"]["ErrorBody"];
1378
+ };
1379
+ };
1380
+ };
1381
+ };
1382
+ "postConcept-apiV1Drafts": {
1383
+ parameters: {
1384
+ query?: never;
1385
+ header?: never;
1386
+ path?: never;
1387
+ cookie?: never;
1388
+ };
1389
+ requestBody: {
1390
+ content: {
1391
+ "application/json": components["schemas"]["NewConceptDTO"];
1392
+ };
1393
+ };
1394
+ responses: {
1395
+ 201: {
1396
+ headers: {
1397
+ /**
1398
+ * @description null
1399
+ * @example null
1400
+ */
1401
+ "Cache-Control": string;
1402
+ [name: string]: unknown;
1403
+ };
1404
+ content: {
1405
+ "application/json": components["schemas"]["ConceptDTO"];
1406
+ };
1407
+ };
1408
+ 400: {
1409
+ headers: {
1410
+ [name: string]: unknown;
1411
+ };
1412
+ content: {
1413
+ "application/json": components["schemas"]["AllErrors"];
1414
+ };
1415
+ };
1416
+ 403: {
1417
+ headers: {
1418
+ [name: string]: unknown;
1419
+ };
1420
+ content: {
1421
+ "application/json": components["schemas"]["AllErrors"];
1422
+ };
1423
+ };
1424
+ 404: {
1425
+ headers: {
1426
+ [name: string]: unknown;
1427
+ };
1428
+ content: {
1429
+ "application/json": components["schemas"]["AllErrors"];
1430
+ };
1431
+ };
1432
+ 500: {
1433
+ headers: {
1434
+ [name: string]: unknown;
1435
+ };
1436
+ content: {
1437
+ "application/json": components["schemas"]["ErrorBody"];
1438
+ };
1439
+ };
1440
+ };
1441
+ };
1442
+ "getConcept-apiV1ConceptsTags": {
1443
+ parameters: {
1444
+ query?: {
1445
+ /** @description The ISO 639-1 language code describing language. */
1446
+ language?: string;
1447
+ /** @description Fallback to existing language if language is specified. */
1448
+ fallback?: boolean;
1449
+ };
1450
+ header?: never;
1451
+ path?: never;
1452
+ cookie?: never;
1453
+ };
1454
+ requestBody?: never;
1455
+ responses: {
1456
+ 200: {
1457
+ headers: {
1458
+ [name: string]: unknown;
1459
+ };
1460
+ content: {
1461
+ "application/json": string[];
1462
+ };
1463
+ };
1464
+ 400: {
1465
+ headers: {
1466
+ [name: string]: unknown;
1467
+ };
1468
+ content: {
1469
+ "application/json": components["schemas"]["AllErrors"];
1470
+ };
1471
+ };
1472
+ 403: {
1473
+ headers: {
1474
+ [name: string]: unknown;
1475
+ };
1476
+ content: {
1477
+ "application/json": components["schemas"]["AllErrors"];
1478
+ };
1479
+ };
1480
+ 404: {
1481
+ headers: {
1482
+ [name: string]: unknown;
1483
+ };
1484
+ content: {
1485
+ "application/json": components["schemas"]["AllErrors"];
1486
+ };
1487
+ };
1488
+ 500: {
1489
+ headers: {
1490
+ [name: string]: unknown;
1491
+ };
1492
+ content: {
1493
+ "application/json": components["schemas"]["ErrorBody"];
1494
+ };
1495
+ };
1496
+ };
1497
+ };
1498
+ "getConcept-apiV1ConceptsConcept_id": {
1499
+ parameters: {
1500
+ query?: {
1501
+ /** @description The ISO 639-1 language code describing language. */
1502
+ language?: string;
1503
+ /** @description Fallback to existing language if language is specified. */
1504
+ fallback?: boolean;
1505
+ };
1506
+ header?: never;
1507
+ path: {
1508
+ /** @description Id of the concept that is to be returned */
1509
+ concept_id: number;
1510
+ };
1511
+ cookie?: never;
1512
+ };
1513
+ requestBody?: never;
1514
+ responses: {
1515
+ 200: {
1516
+ headers: {
1517
+ [name: string]: unknown;
1518
+ };
1519
+ content: {
1520
+ "application/json": components["schemas"]["ConceptDTO"];
1521
+ };
1522
+ };
1523
+ 400: {
1524
+ headers: {
1525
+ [name: string]: unknown;
1526
+ };
1527
+ content: {
1528
+ "application/json": components["schemas"]["AllErrors"];
1529
+ };
1530
+ };
1531
+ 404: {
1532
+ headers: {
1533
+ [name: string]: unknown;
1534
+ };
1535
+ content: {
1536
+ "application/json": components["schemas"]["AllErrors"];
1537
+ };
1538
+ };
1539
+ 500: {
1540
+ headers: {
1541
+ [name: string]: unknown;
1542
+ };
1543
+ content: {
1544
+ "application/json": components["schemas"]["ErrorBody"];
1545
+ };
1546
+ };
1547
+ };
1548
+ };
1549
+ "getConcept-apiV1Concepts": {
1550
+ parameters: {
1551
+ query?: {
1552
+ /** @description Return only concepts with content matching the specified query. */
1553
+ query?: string;
1554
+ /** @description Return only concepts that have one of the provided ids. To provide multiple ids, separate by comma (,). */
1555
+ ids?: number[];
1556
+ /** @description The ISO 639-1 language code describing language. */
1557
+ language?: string;
1558
+ /** @description The page number of the search hits to display. */
1559
+ page?: number;
1560
+ /** @description The number of search hits to display for each page. */
1561
+ "page-size"?: number;
1562
+ /** @description The sorting used on results.
1563
+ * The following are supported: ByRelevanceDesc,ByRelevanceAsc,ByTitleDesc,ByTitleAsc,ByLastUpdatedDesc,ByLastUpdatedAsc,ByIdDesc,ByIdAsc,ByResponsibleLastUpdatedDesc,ByResponsibleLastUpdatedAsc,ByStatusAsc,ByStatusDesc,BySubjectAsc,BySubjectDesc,ByConceptTypeAsc,ByConceptTypeDesc
1564
+ * Default is by -relevance (desc) when query is set, and title (asc) when query is empty. */
1565
+ sort?: string;
1566
+ /** @description Fallback to existing language if language is specified. */
1567
+ fallback?: boolean;
1568
+ /** @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].
1569
+ * When scrolling, the parameters from the initial search is used, except in the case of 'language' and 'fallback'.
1570
+ * This value may change between scrolls. Always use the one in the latest scroll result.
1571
+ * If you are not paginating very far, you can ignore this and use 'page' and 'page-size' instead.
1572
+ * */
1573
+ "search-context"?: string;
1574
+ /** @description A comma-separated list of tags to filter the search by. */
1575
+ tags?: string[];
1576
+ /** @description If provided, only return concept where query matches title exactly. */
1577
+ "exact-match"?: boolean;
1578
+ /** @description Return concepts with matching embed type. */
1579
+ "embed-resource"?: string[];
1580
+ /** @description Return concepts with matching embed id. */
1581
+ "embed-id"?: string;
1582
+ /** @description Return only concepts of given type. Allowed values are concept,gloss */
1583
+ "concept-type"?: string;
1584
+ /** @description List of index-paths that should be term-aggregated and returned in result. */
1585
+ "aggregate-paths"?: string[];
1586
+ };
1587
+ header?: never;
1588
+ path?: never;
1589
+ cookie?: never;
1590
+ };
1591
+ requestBody?: never;
1592
+ responses: {
1593
+ 200: {
1594
+ headers: {
1595
+ [name: string]: unknown;
1596
+ };
1597
+ content: {
1598
+ "application/json": components["schemas"]["ConceptSearchResultDTO"];
1599
+ };
1600
+ };
1601
+ 400: {
1602
+ headers: {
1603
+ [name: string]: unknown;
1604
+ };
1605
+ content: {
1606
+ "application/json": components["schemas"]["AllErrors"];
1607
+ };
1608
+ };
1609
+ 404: {
1610
+ headers: {
1611
+ [name: string]: unknown;
1612
+ };
1613
+ content: {
1614
+ "application/json": components["schemas"]["AllErrors"];
1615
+ };
1616
+ };
1617
+ 500: {
1618
+ headers: {
1619
+ [name: string]: unknown;
1620
+ };
1621
+ content: {
1622
+ "application/json": components["schemas"]["ErrorBody"];
1623
+ };
1624
+ };
1625
+ };
1626
+ };
1627
+ "postConcept-apiV1ConceptsSearch": {
1628
+ parameters: {
1629
+ query?: never;
1630
+ header?: never;
1631
+ path?: never;
1632
+ cookie?: never;
1633
+ };
1634
+ requestBody: {
1635
+ content: {
1636
+ "application/json": components["schemas"]["ConceptSearchParamsDTO"];
1637
+ };
1638
+ };
1639
+ responses: {
1640
+ 200: {
1641
+ headers: {
1642
+ [name: string]: unknown;
1643
+ };
1644
+ content: {
1645
+ "application/json": components["schemas"]["ConceptSearchResultDTO"];
1646
+ };
1647
+ };
1648
+ 400: {
1649
+ headers: {
1650
+ [name: string]: unknown;
1651
+ };
1652
+ content: {
1653
+ "application/json": components["schemas"]["AllErrors"];
1654
+ };
1655
+ };
1656
+ 403: {
1657
+ headers: {
1658
+ [name: string]: unknown;
1659
+ };
1660
+ content: {
1661
+ "application/json": components["schemas"]["AllErrors"];
1662
+ };
1663
+ };
1664
+ 404: {
1665
+ headers: {
1666
+ [name: string]: unknown;
1667
+ };
1668
+ content: {
1669
+ "application/json": components["schemas"]["AllErrors"];
1670
+ };
1671
+ };
1672
+ 500: {
1673
+ headers: {
1674
+ [name: string]: unknown;
1675
+ };
1676
+ content: {
1677
+ "application/json": components["schemas"]["ErrorBody"];
1678
+ };
1679
+ };
1680
+ };
1681
+ };
1682
+ }