@ndla/types-backend 1.0.103 → 1.0.104
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/article-api.d.ts +1132 -31
- package/build/article-api.js +0 -37
- package/build/article-api.js.map +1 -1
- package/build/audio-api.d.ts +2178 -36
- package/build/audio-api.js +0 -37
- package/build/audio-api.js.map +1 -1
- package/build/concept-api.d.ts +1657 -34
- package/build/concept-api.js +0 -37
- package/build/concept-api.js.map +1 -1
- package/build/draft-api.d.ts +3193 -57
- package/build/draft-api.js +0 -37
- package/build/draft-api.js.map +1 -1
- package/build/frontpage-api.d.ts +998 -27
- package/build/frontpage-api.js +0 -37
- package/build/frontpage-api.js.map +1 -1
- package/build/image-api.d.ts +2293 -34
- package/build/image-api.js +0 -37
- package/build/image-api.js.map +1 -1
- package/build/learningpath-api.d.ts +3092 -43
- package/build/learningpath-api.js +0 -37
- package/build/learningpath-api.js.map +1 -1
- package/build/myndla-api.d.ts +3880 -43
- package/build/myndla-api.js +0 -37
- package/build/myndla-api.js.map +1 -1
- package/build/oembed-proxy.d.ts +251 -9
- package/build/oembed-proxy.js +0 -37
- package/build/oembed-proxy.js.map +1 -1
- package/build/scripts/generate-openapi.js +5 -12
- package/build/scripts/generate-openapi.js.map +1 -1
- package/build/search-api.d.ts +1645 -66
- package/build/search-api.js +0 -37
- package/build/search-api.js.map +1 -1
- package/package.json +2 -2
- package/build/article-api-openapi.d.ts +0 -1104
- package/build/article-api-openapi.js +0 -3
- package/build/article-api-openapi.js.map +0 -1
- package/build/audio-api-openapi.d.ts +0 -2145
- package/build/audio-api-openapi.js +0 -3
- package/build/audio-api-openapi.js.map +0 -1
- package/build/concept-api-openapi.d.ts +0 -1626
- package/build/concept-api-openapi.js +0 -3
- package/build/concept-api-openapi.js.map +0 -1
- package/build/draft-api-openapi.d.ts +0 -3139
- package/build/draft-api-openapi.js +0 -3
- package/build/draft-api-openapi.js.map +0 -1
- package/build/frontpage-api-openapi.d.ts +0 -974
- package/build/frontpage-api-openapi.js +0 -3
- package/build/frontpage-api-openapi.js.map +0 -1
- package/build/learningpath-api-openapi.d.ts +0 -3052
- package/build/learningpath-api-openapi.js +0 -3
- package/build/learningpath-api-openapi.js.map +0 -1
- package/build/oembed-proxy-openapi.d.ts +0 -245
- package/build/oembed-proxy-openapi.js +0 -3
- package/build/oembed-proxy-openapi.js.map +0 -1
- package/build/search-api-openapi.d.ts +0 -1582
- package/build/search-api-openapi.js +0 -3
- package/build/search-api-openapi.js.map +0 -1
package/build/search-api.d.ts
CHANGED
|
@@ -1,66 +1,1645 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
1
|
+
export type paths = {
|
|
2
|
+
"/search-api/v1/search/group": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Search across multiple groups of learning resources
|
|
11
|
+
* @description Search across multiple groups of learning resources
|
|
12
|
+
*/
|
|
13
|
+
get: operations["getSearch-apiV1SearchGroup"];
|
|
14
|
+
put?: never;
|
|
15
|
+
post?: never;
|
|
16
|
+
delete?: never;
|
|
17
|
+
options?: never;
|
|
18
|
+
head?: never;
|
|
19
|
+
patch?: never;
|
|
20
|
+
trace?: never;
|
|
21
|
+
};
|
|
22
|
+
"/search-api/v1/search": {
|
|
23
|
+
parameters: {
|
|
24
|
+
query?: never;
|
|
25
|
+
header?: never;
|
|
26
|
+
path?: never;
|
|
27
|
+
cookie?: never;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Find learning resources
|
|
31
|
+
* @description Shows all learning resources. You can search too.
|
|
32
|
+
*/
|
|
33
|
+
get: operations["getSearch-apiV1Search"];
|
|
34
|
+
put?: never;
|
|
35
|
+
/**
|
|
36
|
+
* Find learning resources
|
|
37
|
+
* @description Shows all learning resources. You can search too.
|
|
38
|
+
*/
|
|
39
|
+
post: operations["postSearch-apiV1Search"];
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/search-api/v1/search/editorial": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Find draft learning resources
|
|
55
|
+
* @description Shows all draft learning resources. You can search too.
|
|
56
|
+
* Query parameters are undocumented, but are the same as the body for the POST endpoint, except `kebab-case`.
|
|
57
|
+
*/
|
|
58
|
+
get: operations["getSearch-apiV1SearchEditorial"];
|
|
59
|
+
put?: never;
|
|
60
|
+
/**
|
|
61
|
+
* Find draft learning resources
|
|
62
|
+
* @description Shows all draft learning resources. You can search too.
|
|
63
|
+
*/
|
|
64
|
+
post: operations["postSearch-apiV1SearchEditorial"];
|
|
65
|
+
delete?: never;
|
|
66
|
+
options?: never;
|
|
67
|
+
head?: never;
|
|
68
|
+
patch?: never;
|
|
69
|
+
trace?: never;
|
|
70
|
+
};
|
|
71
|
+
"/search-api/v1/search/subjects": {
|
|
72
|
+
parameters: {
|
|
73
|
+
query?: never;
|
|
74
|
+
header?: never;
|
|
75
|
+
path?: never;
|
|
76
|
+
cookie?: never;
|
|
77
|
+
};
|
|
78
|
+
get?: never;
|
|
79
|
+
put?: never;
|
|
80
|
+
/**
|
|
81
|
+
* List subjects with aggregated data about their contents
|
|
82
|
+
* @description List subjects with aggregated data about their contents
|
|
83
|
+
*/
|
|
84
|
+
post: operations["postSearch-apiV1SearchSubjects"];
|
|
85
|
+
delete?: never;
|
|
86
|
+
options?: never;
|
|
87
|
+
head?: never;
|
|
88
|
+
patch?: never;
|
|
89
|
+
trace?: never;
|
|
90
|
+
};
|
|
91
|
+
"/search-api/v1/search/grep": {
|
|
92
|
+
parameters: {
|
|
93
|
+
query?: never;
|
|
94
|
+
header?: never;
|
|
95
|
+
path?: never;
|
|
96
|
+
cookie?: never;
|
|
97
|
+
};
|
|
98
|
+
get?: never;
|
|
99
|
+
put?: never;
|
|
100
|
+
/**
|
|
101
|
+
* Search for grep codes
|
|
102
|
+
* @description Search for grep codes
|
|
103
|
+
*/
|
|
104
|
+
post: operations["postSearch-apiV1SearchGrep"];
|
|
105
|
+
delete?: never;
|
|
106
|
+
options?: never;
|
|
107
|
+
head?: never;
|
|
108
|
+
patch?: never;
|
|
109
|
+
trace?: never;
|
|
110
|
+
};
|
|
111
|
+
"/search-api/v1/search/grep/replacements": {
|
|
112
|
+
parameters: {
|
|
113
|
+
query?: never;
|
|
114
|
+
header?: never;
|
|
115
|
+
path?: never;
|
|
116
|
+
cookie?: never;
|
|
117
|
+
};
|
|
118
|
+
/** Get grep replacements */
|
|
119
|
+
get: operations["getSearch-apiV1SearchGrepReplacements"];
|
|
120
|
+
put?: never;
|
|
121
|
+
post?: never;
|
|
122
|
+
delete?: never;
|
|
123
|
+
options?: never;
|
|
124
|
+
head?: never;
|
|
125
|
+
patch?: never;
|
|
126
|
+
trace?: never;
|
|
127
|
+
};
|
|
128
|
+
};
|
|
129
|
+
export type webhooks = Record<string, never>;
|
|
130
|
+
export type components = {
|
|
131
|
+
schemas: {
|
|
132
|
+
/** AllErrors */
|
|
133
|
+
AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
|
|
134
|
+
/** ApiTaxonomyContextDTO */
|
|
135
|
+
ApiTaxonomyContextDTO: {
|
|
136
|
+
/** @description Id of the taxonomy object. */
|
|
137
|
+
publicId: string;
|
|
138
|
+
/** @description Name of the root node this context is in. */
|
|
139
|
+
root: string;
|
|
140
|
+
/** @description Id of the root node this context is in. */
|
|
141
|
+
rootId: string;
|
|
142
|
+
/** @description The relevance for this context. */
|
|
143
|
+
relevance: string;
|
|
144
|
+
/** @description The relevanceId for this context. */
|
|
145
|
+
relevanceId: string;
|
|
146
|
+
/** @description Path to the resource in this context. */
|
|
147
|
+
path: string;
|
|
148
|
+
/** @description Breadcrumbs of path to the resource in this context. */
|
|
149
|
+
breadcrumbs: string[];
|
|
150
|
+
/** @description Unique id of this context. */
|
|
151
|
+
contextId: string;
|
|
152
|
+
/** @description Type in this context. */
|
|
153
|
+
contextType: string;
|
|
154
|
+
/** @description Resource-types of this context. */
|
|
155
|
+
resourceTypes: components["schemas"]["TaxonomyResourceTypeDTO"][];
|
|
156
|
+
/** @description Language for this context. */
|
|
157
|
+
language: string;
|
|
158
|
+
/** @description Whether this context is the primary connection */
|
|
159
|
+
isPrimary: boolean;
|
|
160
|
+
/** @description Whether this context is active */
|
|
161
|
+
isActive: boolean;
|
|
162
|
+
/** @description Whether this context is in archived subject */
|
|
163
|
+
isArchived: boolean;
|
|
164
|
+
/** @description Unique url for this context. */
|
|
165
|
+
url: string;
|
|
166
|
+
};
|
|
167
|
+
/**
|
|
168
|
+
* ArticleTrait
|
|
169
|
+
* @enum {string}
|
|
170
|
+
*/
|
|
171
|
+
ArticleTrait: "AUDIO" | "H5P" | "INTERACTIVE" | "PODCAST" | "VIDEO";
|
|
172
|
+
/**
|
|
173
|
+
* CommentDTO
|
|
174
|
+
* @description Information about a comment attached to an article
|
|
175
|
+
*/
|
|
176
|
+
CommentDTO: {
|
|
177
|
+
/** @description Id of the comment */
|
|
178
|
+
id: string;
|
|
179
|
+
/** @description Content of the comment */
|
|
180
|
+
content: string;
|
|
181
|
+
/** @description When the comment was created */
|
|
182
|
+
created: string;
|
|
183
|
+
/** @description When the comment was last updated */
|
|
184
|
+
updated: string;
|
|
185
|
+
/** @description If the comment is open or closed */
|
|
186
|
+
isOpen: boolean;
|
|
187
|
+
/** @description If the comment is solved or not */
|
|
188
|
+
solved: boolean;
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* DescriptionDTO
|
|
192
|
+
* @description Title of resource
|
|
193
|
+
*/
|
|
194
|
+
DescriptionDTO: {
|
|
195
|
+
/** @description The freetext description of the resource */
|
|
196
|
+
description: string;
|
|
197
|
+
/** @description ISO 639-1 code that represents the language used in title */
|
|
198
|
+
language: string;
|
|
199
|
+
};
|
|
200
|
+
/** DraftSearchParamsDTO */
|
|
201
|
+
DraftSearchParamsDTO: {
|
|
202
|
+
/**
|
|
203
|
+
* Format: int32
|
|
204
|
+
* @description The page number of the search hits to display.
|
|
205
|
+
*/
|
|
206
|
+
page?: number;
|
|
207
|
+
/**
|
|
208
|
+
* Format: int32
|
|
209
|
+
* @description The number of search hits to display for each page.
|
|
210
|
+
*/
|
|
211
|
+
pageSize?: number;
|
|
212
|
+
/** @description A list of article-types the search should be filtered by. */
|
|
213
|
+
articleTypes?: string[];
|
|
214
|
+
/** @description A list of context-types the learning resources should be filtered by. */
|
|
215
|
+
contextTypes?: string[];
|
|
216
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
217
|
+
language?: string;
|
|
218
|
+
/** @description Return only learning resources that have one of the provided ids. */
|
|
219
|
+
ids?: number[];
|
|
220
|
+
/** @description Return only learning resources of specific type(s). */
|
|
221
|
+
resourceTypes?: string[];
|
|
222
|
+
/** @description Return only results with provided license. */
|
|
223
|
+
license?: string;
|
|
224
|
+
/** @description Return only results with content matching the specified query. */
|
|
225
|
+
query?: string;
|
|
226
|
+
/** @description Return only results with notes matching the specified note-query. */
|
|
227
|
+
noteQuery?: string;
|
|
228
|
+
sort?: components["schemas"]["Sort"];
|
|
229
|
+
/** @description Fallback to existing language if language is specified. */
|
|
230
|
+
fallback?: boolean;
|
|
231
|
+
/** @description A comma separated list of subjects the learning resources should be filtered by. */
|
|
232
|
+
subjects?: string[];
|
|
233
|
+
/** @description A list of ISO 639-1 language codes that the learning resource can be available in. */
|
|
234
|
+
languageFilter?: string[];
|
|
235
|
+
/**
|
|
236
|
+
* @description A list of relevances the learning resources should be filtered by.
|
|
237
|
+
* If subjects are specified the learning resource must have specified relevances in relation to a specified subject.
|
|
238
|
+
* If levels are specified the learning resource must have specified relevances in relation to a specified level.
|
|
239
|
+
*/
|
|
240
|
+
relevance?: string[];
|
|
241
|
+
/**
|
|
242
|
+
* @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"].
|
|
243
|
+
* When scrolling, the parameters from the initial search is used, except in the case of 'language' and 'fallback'.
|
|
244
|
+
* This value may change between scrolls. Always use the one in the latest scroll result.
|
|
245
|
+
*/
|
|
246
|
+
scrollId?: string;
|
|
247
|
+
/** @description List of statuses to filter by. A draft only needs to have one of the available statuses to be included in result (OR). */
|
|
248
|
+
draftStatus?: string[];
|
|
249
|
+
/**
|
|
250
|
+
* @description List of users to filter by.
|
|
251
|
+
* The value to search for is the user-id from Auth0.
|
|
252
|
+
* UpdatedBy on article and user in editorial-notes are searched.
|
|
253
|
+
*/
|
|
254
|
+
users?: string[];
|
|
255
|
+
/** @description A list of codes from GREP API the resources should be filtered by. */
|
|
256
|
+
grepCodes?: string[];
|
|
257
|
+
/** @description A comma separated list of traits the resources should be filtered by. */
|
|
258
|
+
traits?: components["schemas"]["ArticleTrait"][];
|
|
259
|
+
/** @description List of index-paths that should be term-aggregated and returned in result. */
|
|
260
|
+
aggregatePaths?: string[];
|
|
261
|
+
/** @description Return only results with embed data-resource the specified resource. Can specify multiple with a comma separated list to filter for one of the embed types. */
|
|
262
|
+
embedResource?: string[];
|
|
263
|
+
/** @description Return only results with embed data-resource_id, data-videoid or data-url with the specified id. */
|
|
264
|
+
embedId?: string;
|
|
265
|
+
/** @description Whether or not to include the 'other' status field when filtering with 'status' param. */
|
|
266
|
+
includeOtherStatuses?: boolean;
|
|
267
|
+
/** @description Return only results having next revision after this date. */
|
|
268
|
+
revisionDateFrom?: string;
|
|
269
|
+
/** @description Return only results having next revision before this date. */
|
|
270
|
+
revisionDateTo?: string;
|
|
271
|
+
/** @description Set to true to avoid including hits from the revision history log. */
|
|
272
|
+
excludeRevisionLog?: boolean;
|
|
273
|
+
/** @description List of responsible ids to filter by (OR filter). */
|
|
274
|
+
responsibleIds?: string[];
|
|
275
|
+
/** @description Filter out inactive taxonomy contexts. */
|
|
276
|
+
filterInactive?: boolean;
|
|
277
|
+
/** @description List of priority-levels to filter by. */
|
|
278
|
+
priority?: components["schemas"]["Priority"][];
|
|
279
|
+
/** @description A list of parent topics the learning resources should be filtered by. */
|
|
280
|
+
topics?: string[];
|
|
281
|
+
/** @description Return only results having published date after this date. */
|
|
282
|
+
publishedDateFrom?: string;
|
|
283
|
+
/** @description Return only results having published date before this date. */
|
|
284
|
+
publishedDateTo?: string;
|
|
285
|
+
/** @description Types of hits to appear in the result */
|
|
286
|
+
resultTypes?: components["schemas"]["SearchType"][];
|
|
287
|
+
/** @description Only return results that have one of the specified tags. */
|
|
288
|
+
tags?: string[];
|
|
289
|
+
};
|
|
290
|
+
/**
|
|
291
|
+
* ErrorBody
|
|
292
|
+
* @description Information about an error
|
|
293
|
+
*/
|
|
294
|
+
ErrorBody: {
|
|
295
|
+
/** @description Code stating the type of error */
|
|
296
|
+
code: string;
|
|
297
|
+
/** @description Description of the error */
|
|
298
|
+
description: string;
|
|
299
|
+
/** @description When the error occurred */
|
|
300
|
+
occurredAt: string;
|
|
301
|
+
/**
|
|
302
|
+
* Format: int32
|
|
303
|
+
* @description Numeric http status code
|
|
304
|
+
*/
|
|
305
|
+
statusCode: number;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* GrepFagkodeDTO
|
|
309
|
+
* @description Information about a single grep search result entry
|
|
310
|
+
*/
|
|
311
|
+
GrepFagkodeDTO: {
|
|
312
|
+
/** @description The grep code */
|
|
313
|
+
code: string;
|
|
314
|
+
/** @description The grep uri */
|
|
315
|
+
uri: string;
|
|
316
|
+
/** @description The grep status */
|
|
317
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
318
|
+
/** @description The greps title */
|
|
319
|
+
title: components["schemas"]["TitleDTO"];
|
|
320
|
+
/** @description Title of resource */
|
|
321
|
+
kortform: components["schemas"]["TitleDTO"];
|
|
322
|
+
typename: components["schemas"]["GrepFagkodeDTO1"];
|
|
323
|
+
};
|
|
324
|
+
/**
|
|
325
|
+
* GrepFagkodeDTO
|
|
326
|
+
* @enum {string}
|
|
327
|
+
*/
|
|
328
|
+
GrepFagkodeDTO1: "GrepFagkodeDTO";
|
|
329
|
+
/**
|
|
330
|
+
* GrepKjerneelementDTO
|
|
331
|
+
* @description Information about a single grep search result entry
|
|
332
|
+
*/
|
|
333
|
+
GrepKjerneelementDTO: {
|
|
334
|
+
/** @description The grep code */
|
|
335
|
+
code: string;
|
|
336
|
+
/** @description The grep uri */
|
|
337
|
+
uri: string;
|
|
338
|
+
/** @description The grep status */
|
|
339
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
340
|
+
/** @description The greps title */
|
|
341
|
+
title: components["schemas"]["TitleDTO"];
|
|
342
|
+
description: components["schemas"]["DescriptionDTO"];
|
|
343
|
+
laereplan: components["schemas"]["GrepReferencedLaereplanDTO"];
|
|
344
|
+
typename: components["schemas"]["GrepKjerneelementDTO1"];
|
|
345
|
+
};
|
|
346
|
+
/**
|
|
347
|
+
* GrepKjerneelementDTO
|
|
348
|
+
* @enum {string}
|
|
349
|
+
*/
|
|
350
|
+
GrepKjerneelementDTO1: "GrepKjerneelementDTO";
|
|
351
|
+
/**
|
|
352
|
+
* GrepKompetansemaalDTO
|
|
353
|
+
* @description Information about a single grep search result entry
|
|
354
|
+
*/
|
|
355
|
+
GrepKompetansemaalDTO: {
|
|
356
|
+
/** @description The grep code */
|
|
357
|
+
code: string;
|
|
358
|
+
/** @description The grep uri */
|
|
359
|
+
uri: string;
|
|
360
|
+
/** @description The grep status */
|
|
361
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
362
|
+
/** @description The greps title */
|
|
363
|
+
title: components["schemas"]["TitleDTO"];
|
|
364
|
+
laereplan: components["schemas"]["GrepReferencedLaereplanDTO"];
|
|
365
|
+
kompetansemaalSett: components["schemas"]["GrepReferencedKompetansemaalSettDTO"];
|
|
366
|
+
tverrfagligeTemaer: components["schemas"]["GrepTverrfagligTemaDTO"][];
|
|
367
|
+
kjerneelementer: components["schemas"]["GrepReferencedKjerneelementDTO"][];
|
|
368
|
+
reuseOf?: components["schemas"]["GrepReferencedKompetansemaalDTO"];
|
|
369
|
+
typename: components["schemas"]["GrepKompetansemaalDTO1"];
|
|
370
|
+
};
|
|
371
|
+
/**
|
|
372
|
+
* GrepKompetansemaalDTO
|
|
373
|
+
* @enum {string}
|
|
374
|
+
*/
|
|
375
|
+
GrepKompetansemaalDTO1: "GrepKompetansemaalDTO";
|
|
376
|
+
/**
|
|
377
|
+
* GrepKompetansemaalSettDTO
|
|
378
|
+
* @description Information about a single grep search result entry
|
|
379
|
+
*/
|
|
380
|
+
GrepKompetansemaalSettDTO: {
|
|
381
|
+
/** @description The grep code */
|
|
382
|
+
code: string;
|
|
383
|
+
/** @description The grep uri */
|
|
384
|
+
uri: string;
|
|
385
|
+
/** @description The grep status */
|
|
386
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
387
|
+
/** @description The greps title */
|
|
388
|
+
title: components["schemas"]["TitleDTO"];
|
|
389
|
+
kompetansemaal: components["schemas"]["GrepReferencedKompetansemaalDTO"][];
|
|
390
|
+
typename: components["schemas"]["GrepKompetansemaalSettDTO1"];
|
|
391
|
+
};
|
|
392
|
+
/**
|
|
393
|
+
* GrepKompetansemaalSettDTO
|
|
394
|
+
* @enum {string}
|
|
395
|
+
*/
|
|
396
|
+
GrepKompetansemaalSettDTO1: "GrepKompetansemaalSettDTO";
|
|
397
|
+
/**
|
|
398
|
+
* GrepLaererplanDTO
|
|
399
|
+
* @description Information about a single grep search result entry
|
|
400
|
+
*/
|
|
401
|
+
GrepLaererplanDTO: {
|
|
402
|
+
/** @description The grep code */
|
|
403
|
+
code: string;
|
|
404
|
+
/** @description The grep uri */
|
|
405
|
+
uri: string;
|
|
406
|
+
/** @description The grep status */
|
|
407
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
408
|
+
/** @description The greps title */
|
|
409
|
+
title: components["schemas"]["TitleDTO"];
|
|
410
|
+
replacedBy: components["schemas"]["GrepReferencedLaereplanDTO"][];
|
|
411
|
+
typename: components["schemas"]["GrepLaererplanDTO1"];
|
|
412
|
+
};
|
|
413
|
+
/**
|
|
414
|
+
* GrepLaererplanDTO
|
|
415
|
+
* @enum {string}
|
|
416
|
+
*/
|
|
417
|
+
GrepLaererplanDTO1: "GrepLaererplanDTO";
|
|
418
|
+
/** GrepReferencedKjerneelementDTO */
|
|
419
|
+
GrepReferencedKjerneelementDTO: {
|
|
420
|
+
code: string;
|
|
421
|
+
uri: string;
|
|
422
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
423
|
+
title: string;
|
|
424
|
+
};
|
|
425
|
+
/** GrepReferencedKompetansemaalDTO */
|
|
426
|
+
GrepReferencedKompetansemaalDTO: {
|
|
427
|
+
code: string;
|
|
428
|
+
uri: string;
|
|
429
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
430
|
+
title: string;
|
|
431
|
+
};
|
|
432
|
+
/** GrepReferencedKompetansemaalSettDTO */
|
|
433
|
+
GrepReferencedKompetansemaalSettDTO: {
|
|
434
|
+
code: string;
|
|
435
|
+
uri: string;
|
|
436
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
437
|
+
title: string;
|
|
438
|
+
};
|
|
439
|
+
/** GrepReferencedLaereplanDTO */
|
|
440
|
+
GrepReferencedLaereplanDTO: {
|
|
441
|
+
code: string;
|
|
442
|
+
uri: string;
|
|
443
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
444
|
+
title: string;
|
|
445
|
+
};
|
|
446
|
+
/** GrepResultDTO */
|
|
447
|
+
GrepResultDTO: components["schemas"]["GrepFagkodeDTO"] | components["schemas"]["GrepKjerneelementDTO"] | components["schemas"]["GrepKompetansemaalDTO"] | components["schemas"]["GrepKompetansemaalSettDTO"] | components["schemas"]["GrepLaererplanDTO"] | components["schemas"]["GrepTverrfagligTemaDTO"];
|
|
448
|
+
/**
|
|
449
|
+
* GrepSearchInputDTO
|
|
450
|
+
* @description Input parameters to subject aggregations endpoint
|
|
451
|
+
*/
|
|
452
|
+
GrepSearchInputDTO: {
|
|
453
|
+
/** @description A comma separated list of prefixes that should be returned in the search. */
|
|
454
|
+
prefixFilter?: string[];
|
|
455
|
+
/** @description A comma separated list of codes that should be returned in the search. */
|
|
456
|
+
codes?: string[];
|
|
457
|
+
/** @description A query to filter the query by. */
|
|
458
|
+
query?: string;
|
|
459
|
+
/**
|
|
460
|
+
* Format: int32
|
|
461
|
+
* @description The page number of the search hits to display.
|
|
462
|
+
*/
|
|
463
|
+
page?: number;
|
|
464
|
+
/**
|
|
465
|
+
* Format: int32
|
|
466
|
+
* @description The number of search hits to display for each page.
|
|
467
|
+
*/
|
|
468
|
+
pageSize?: number;
|
|
469
|
+
sort?: components["schemas"]["GrepSortDTO"];
|
|
470
|
+
/** @description The ISO 639-1 language code describing language used in query-params */
|
|
471
|
+
language?: string;
|
|
472
|
+
};
|
|
473
|
+
/**
|
|
474
|
+
* GrepSearchResultsDTO
|
|
475
|
+
* @description Information about search-results
|
|
476
|
+
*/
|
|
477
|
+
GrepSearchResultsDTO: {
|
|
478
|
+
/**
|
|
479
|
+
* Format: int64
|
|
480
|
+
* @description The total number of resources matching this query
|
|
481
|
+
*/
|
|
482
|
+
totalCount: number;
|
|
483
|
+
/**
|
|
484
|
+
* Format: int32
|
|
485
|
+
* @description For which page results are shown from
|
|
486
|
+
*/
|
|
487
|
+
page: number;
|
|
488
|
+
/**
|
|
489
|
+
* Format: int32
|
|
490
|
+
* @description The number of results per page
|
|
491
|
+
*/
|
|
492
|
+
pageSize: number;
|
|
493
|
+
/** @description The chosen search language */
|
|
494
|
+
language: string;
|
|
495
|
+
/** @description The search results */
|
|
496
|
+
results: components["schemas"]["GrepResultDTO"][];
|
|
497
|
+
};
|
|
498
|
+
/**
|
|
499
|
+
* GrepSortDTO
|
|
500
|
+
* @description The sort order of the search hits.
|
|
501
|
+
* @enum {string}
|
|
502
|
+
*/
|
|
503
|
+
GrepSortDTO: "-relevance" | "relevance" | "-title" | "title" | "-code" | "code" | "-status" | "status";
|
|
504
|
+
/**
|
|
505
|
+
* GrepStatusDTO
|
|
506
|
+
* @enum {string}
|
|
507
|
+
*/
|
|
508
|
+
GrepStatusDTO: "Published" | "InProgress" | "ToRevision" | "Expired" | "Invalid";
|
|
509
|
+
/**
|
|
510
|
+
* GrepTverrfagligTemaDTO
|
|
511
|
+
* @description Information about a single grep search result entry
|
|
512
|
+
*/
|
|
513
|
+
GrepTverrfagligTemaDTO: {
|
|
514
|
+
/** @description The grep code */
|
|
515
|
+
code: string;
|
|
516
|
+
/** @description The grep uri */
|
|
517
|
+
uri: string;
|
|
518
|
+
/** @description The grep status */
|
|
519
|
+
status: components["schemas"]["GrepStatusDTO"];
|
|
520
|
+
/** @description The greps title */
|
|
521
|
+
title: components["schemas"]["TitleDTO"];
|
|
522
|
+
typename: components["schemas"]["GrepTverrfagligTemaDTO1"];
|
|
523
|
+
};
|
|
524
|
+
/**
|
|
525
|
+
* GrepTverrfagligTemaDTO
|
|
526
|
+
* @enum {string}
|
|
527
|
+
*/
|
|
528
|
+
GrepTverrfagligTemaDTO1: "GrepTverrfagligTemaDTO";
|
|
529
|
+
/**
|
|
530
|
+
* GroupSearchResultDTO
|
|
531
|
+
* @description Search result for group search
|
|
532
|
+
*/
|
|
533
|
+
GroupSearchResultDTO: {
|
|
534
|
+
/**
|
|
535
|
+
* Format: int64
|
|
536
|
+
* @description The total number of resources matching this query
|
|
537
|
+
*/
|
|
538
|
+
totalCount: number;
|
|
539
|
+
/**
|
|
540
|
+
* Format: int32
|
|
541
|
+
* @description For which page results are shown from
|
|
542
|
+
*/
|
|
543
|
+
page?: number;
|
|
544
|
+
/**
|
|
545
|
+
* Format: int32
|
|
546
|
+
* @description The number of results per page
|
|
547
|
+
*/
|
|
548
|
+
pageSize: number;
|
|
549
|
+
/** @description The chosen search language */
|
|
550
|
+
language: string;
|
|
551
|
+
/** @description The search results */
|
|
552
|
+
results: components["schemas"]["MultiSummaryBaseDTO"][];
|
|
553
|
+
/** @description The suggestions for other searches */
|
|
554
|
+
suggestions: components["schemas"]["MultiSearchSuggestionDTO"][];
|
|
555
|
+
/** @description The aggregated fields if specified in query */
|
|
556
|
+
aggregations: components["schemas"]["MultiSearchTermsAggregationDTO"][];
|
|
557
|
+
/** @description Type of resources in this object */
|
|
558
|
+
resourceType: string;
|
|
559
|
+
};
|
|
560
|
+
/**
|
|
561
|
+
* HighlightedFieldDTO
|
|
562
|
+
* @description Object describing matched field with matching words emphasized
|
|
563
|
+
*/
|
|
564
|
+
HighlightedFieldDTO: {
|
|
565
|
+
/** @description Field that matched */
|
|
566
|
+
field: string;
|
|
567
|
+
/** @description List of segments that matched in `field` */
|
|
568
|
+
matches: string[];
|
|
569
|
+
};
|
|
570
|
+
/**
|
|
571
|
+
* LearningResourceType
|
|
572
|
+
* @description Learning resource type
|
|
573
|
+
* @enum {string}
|
|
574
|
+
*/
|
|
575
|
+
LearningResourceType: "standard" | "topic-article" | "frontpage-article" | "learningpath" | "concept" | "gloss";
|
|
576
|
+
/** Map_String */
|
|
577
|
+
Map_String: {
|
|
578
|
+
[key: string]: string;
|
|
579
|
+
};
|
|
580
|
+
/** MetaDescriptionDTO */
|
|
581
|
+
MetaDescriptionDTO: {
|
|
582
|
+
/** @description The meta description */
|
|
583
|
+
metaDescription: string;
|
|
584
|
+
/** @description The ISO 639-1 language code describing which article translation this meta description belongs to */
|
|
585
|
+
language: string;
|
|
586
|
+
};
|
|
587
|
+
/**
|
|
588
|
+
* MetaImageDTO
|
|
589
|
+
* @description The meta image for the resource
|
|
590
|
+
*/
|
|
591
|
+
MetaImageDTO: {
|
|
592
|
+
/** @description The meta image id */
|
|
593
|
+
url: string;
|
|
594
|
+
/** @description The meta image alt text */
|
|
595
|
+
alt: string;
|
|
596
|
+
/** @description The ISO 639-1 language code describing which translation this meta image belongs to */
|
|
597
|
+
language: string;
|
|
598
|
+
};
|
|
599
|
+
/**
|
|
600
|
+
* MultiSearchResultDTO
|
|
601
|
+
* @description Information about search-results
|
|
602
|
+
*/
|
|
603
|
+
MultiSearchResultDTO: {
|
|
604
|
+
/**
|
|
605
|
+
* Format: int64
|
|
606
|
+
* @description The total number of resources matching this query
|
|
607
|
+
*/
|
|
608
|
+
totalCount: number;
|
|
609
|
+
/**
|
|
610
|
+
* Format: int32
|
|
611
|
+
* @description For which page results are shown from
|
|
612
|
+
*/
|
|
613
|
+
page?: number;
|
|
614
|
+
/**
|
|
615
|
+
* Format: int32
|
|
616
|
+
* @description The number of results per page
|
|
617
|
+
*/
|
|
618
|
+
pageSize: number;
|
|
619
|
+
/** @description The chosen search language */
|
|
620
|
+
language: string;
|
|
621
|
+
/** @description The search results */
|
|
622
|
+
results: components["schemas"]["MultiSummaryBaseDTO"][];
|
|
623
|
+
/** @description The suggestions for other searches */
|
|
624
|
+
suggestions: components["schemas"]["MultiSearchSuggestionDTO"][];
|
|
625
|
+
/** @description The aggregated fields if specified in query */
|
|
626
|
+
aggregations: components["schemas"]["MultiSearchTermsAggregationDTO"][];
|
|
627
|
+
};
|
|
628
|
+
/**
|
|
629
|
+
* MultiSearchSuggestionDTO
|
|
630
|
+
* @description Information about search-suggestions
|
|
631
|
+
*/
|
|
632
|
+
MultiSearchSuggestionDTO: {
|
|
633
|
+
/** @description The name of the field suggested for */
|
|
634
|
+
name: string;
|
|
635
|
+
/** @description The list of suggestions for given field */
|
|
636
|
+
suggestions: components["schemas"]["SearchSuggestionDTO"][];
|
|
637
|
+
};
|
|
638
|
+
/**
|
|
639
|
+
* MultiSearchSummaryDTO
|
|
640
|
+
* @description Short summary of information about the resource
|
|
641
|
+
*/
|
|
642
|
+
MultiSearchSummaryDTO: {
|
|
643
|
+
/**
|
|
644
|
+
* Format: int64
|
|
645
|
+
* @description The unique id of the resource
|
|
646
|
+
*/
|
|
647
|
+
id: number;
|
|
648
|
+
title: components["schemas"]["TitleWithHtmlDTO"];
|
|
649
|
+
/** @description The meta description of the resource */
|
|
650
|
+
metaDescription: components["schemas"]["MetaDescriptionDTO"];
|
|
651
|
+
metaImage?: components["schemas"]["MetaImageDTO"];
|
|
652
|
+
/** @description Url pointing to the resource */
|
|
653
|
+
url: string;
|
|
654
|
+
/** @description List of nodeIds the resource is connected to */
|
|
655
|
+
nodeIds: string[];
|
|
656
|
+
/** @description Resource-types of this resource, independent of contexts */
|
|
657
|
+
resourceTypes: components["schemas"]["TaxonomyResourceTypeDTO"][];
|
|
658
|
+
/** @description Primary context of the resource */
|
|
659
|
+
context?: components["schemas"]["ApiTaxonomyContextDTO"];
|
|
660
|
+
/** @description Contexts of the resource */
|
|
661
|
+
contexts: components["schemas"]["ApiTaxonomyContextDTO"][];
|
|
662
|
+
/** @description Languages the resource exists in */
|
|
663
|
+
supportedLanguages: string[];
|
|
664
|
+
learningResourceType: components["schemas"]["LearningResourceType"];
|
|
665
|
+
status?: components["schemas"]["StatusDTO"];
|
|
666
|
+
/** @description Traits for the resource */
|
|
667
|
+
traits: components["schemas"]["ArticleTrait"][];
|
|
668
|
+
/**
|
|
669
|
+
* Format: float
|
|
670
|
+
* @description Relevance score. The higher the score, the better the document matches your search criteria.
|
|
671
|
+
*/
|
|
672
|
+
score: number;
|
|
673
|
+
/** @description List of objects describing matched field with matching words emphasized */
|
|
674
|
+
highlights: components["schemas"]["HighlightedFieldDTO"][];
|
|
675
|
+
/** @description The taxonomy paths for the resource */
|
|
676
|
+
paths: string[];
|
|
677
|
+
/** @description The time and date of last update */
|
|
678
|
+
lastUpdated: string;
|
|
679
|
+
/** @description Describes the license of the resource */
|
|
680
|
+
license?: string;
|
|
681
|
+
/**
|
|
682
|
+
* Format: int32
|
|
683
|
+
* @description The revision number of the article
|
|
684
|
+
*/
|
|
685
|
+
revision?: number;
|
|
686
|
+
/** @description If the article has been edited after last status or responsible change */
|
|
687
|
+
started: boolean;
|
|
688
|
+
/** @description A list of revisions planned for the article */
|
|
689
|
+
revisions: components["schemas"]["RevisionMetaDTO"][];
|
|
690
|
+
responsible?: components["schemas"]["ResponsibleDTO"];
|
|
691
|
+
/** @description Information about comments attached to the article */
|
|
692
|
+
comments?: components["schemas"]["CommentDTO"][];
|
|
693
|
+
/** @description If the article should be prioritized. Possible values are prioritized, on-hold, unspecified */
|
|
694
|
+
priority?: components["schemas"]["Priority"];
|
|
695
|
+
/** @description A combined resource type name if a standard article, otherwise the article type name */
|
|
696
|
+
resourceTypeName?: string;
|
|
697
|
+
/** @description Name of the parent topic if exists */
|
|
698
|
+
parentTopicName?: string;
|
|
699
|
+
/** @description Name of the primary context root if exists */
|
|
700
|
+
primaryRootName?: string;
|
|
701
|
+
/** @description When the article was last published */
|
|
702
|
+
published?: string;
|
|
703
|
+
/**
|
|
704
|
+
* Format: int64
|
|
705
|
+
* @description Number of times favorited in MyNDLA
|
|
706
|
+
*/
|
|
707
|
+
favorited?: number;
|
|
708
|
+
/** @description Type of the resource */
|
|
709
|
+
resultType: components["schemas"]["SearchType"];
|
|
710
|
+
/** @description List of codes the resource is tagged with */
|
|
711
|
+
grepCodes: string[];
|
|
712
|
+
typename: components["schemas"]["MultiSearchSummaryDTO1"];
|
|
713
|
+
};
|
|
714
|
+
/**
|
|
715
|
+
* MultiSearchSummaryDTO
|
|
716
|
+
* @enum {string}
|
|
717
|
+
*/
|
|
718
|
+
MultiSearchSummaryDTO1: "MultiSearchSummaryDTO";
|
|
719
|
+
/**
|
|
720
|
+
* MultiSearchTermsAggregationDTO
|
|
721
|
+
* @description Information about search aggregation on `field`
|
|
722
|
+
*/
|
|
723
|
+
MultiSearchTermsAggregationDTO: {
|
|
724
|
+
/** @description The field the specific aggregation is matching */
|
|
725
|
+
field: string;
|
|
726
|
+
/**
|
|
727
|
+
* Format: int32
|
|
728
|
+
* @description Number of documents with values that didn't appear in the aggregation. (Will only happen if there are more than 50 different values)
|
|
729
|
+
*/
|
|
730
|
+
sumOtherDocCount: number;
|
|
731
|
+
/**
|
|
732
|
+
* Format: int32
|
|
733
|
+
* @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)
|
|
734
|
+
*/
|
|
735
|
+
docCountErrorUpperBound: number;
|
|
736
|
+
/** @description Values appearing in the field */
|
|
737
|
+
values: components["schemas"]["TermValueDTO"][];
|
|
738
|
+
};
|
|
739
|
+
/** MultiSummaryBaseDTO */
|
|
740
|
+
MultiSummaryBaseDTO: components["schemas"]["MultiSearchSummaryDTO"] | components["schemas"]["NodeHitDTO"];
|
|
741
|
+
/** NodeHitDTO */
|
|
742
|
+
NodeHitDTO: {
|
|
743
|
+
/** @description The unique id of the taxonomy node */
|
|
744
|
+
id: string;
|
|
745
|
+
/** @description The title of the taxonomy node */
|
|
746
|
+
title: string;
|
|
747
|
+
/** @description The url to the frontend page of the taxonomy node */
|
|
748
|
+
url?: string;
|
|
749
|
+
subjectPage?: components["schemas"]["SubjectPageSummaryDTO"];
|
|
750
|
+
/** @description Primary context of the resource */
|
|
751
|
+
context?: components["schemas"]["ApiTaxonomyContextDTO"];
|
|
752
|
+
/** @description Contexts of the resource */
|
|
753
|
+
contexts: components["schemas"]["ApiTaxonomyContextDTO"][];
|
|
754
|
+
typename: components["schemas"]["NodeHitDTO1"];
|
|
755
|
+
};
|
|
756
|
+
/**
|
|
757
|
+
* NodeHitDTO
|
|
758
|
+
* @enum {string}
|
|
759
|
+
*/
|
|
760
|
+
NodeHitDTO1: "NodeHitDTO";
|
|
761
|
+
/**
|
|
762
|
+
* NodeType
|
|
763
|
+
* @enum {string}
|
|
764
|
+
*/
|
|
765
|
+
NodeType: "NODE" | "SUBJECT" | "TOPIC" | "CASE" | "RESOURCE" | "PROGRAMME";
|
|
766
|
+
/**
|
|
767
|
+
* NotFoundWithSupportedLanguages
|
|
768
|
+
* @description Information about an error
|
|
769
|
+
*/
|
|
770
|
+
NotFoundWithSupportedLanguages: {
|
|
771
|
+
/** @description Code stating the type of error */
|
|
772
|
+
code: string;
|
|
773
|
+
/** @description Description of the error */
|
|
774
|
+
description: string;
|
|
775
|
+
/** @description When the error occurred */
|
|
776
|
+
occurredAt: string;
|
|
777
|
+
/** @description List of supported languages */
|
|
778
|
+
supportedLanguages?: string[];
|
|
779
|
+
/**
|
|
780
|
+
* Format: int32
|
|
781
|
+
* @description Numeric http status code
|
|
782
|
+
*/
|
|
783
|
+
statusCode: number;
|
|
784
|
+
};
|
|
785
|
+
/**
|
|
786
|
+
* Priority
|
|
787
|
+
* @enum {string}
|
|
788
|
+
*/
|
|
789
|
+
Priority: "prioritized" | "on-hold" | "unspecified";
|
|
790
|
+
/**
|
|
791
|
+
* ResponsibleDTO
|
|
792
|
+
* @description Responsible field
|
|
793
|
+
*/
|
|
794
|
+
ResponsibleDTO: {
|
|
795
|
+
/** @description NDLA ID of responsible editor */
|
|
796
|
+
responsibleId: string;
|
|
797
|
+
/** @description Date of when the responsible editor was last updated */
|
|
798
|
+
lastUpdated: string;
|
|
799
|
+
};
|
|
800
|
+
/**
|
|
801
|
+
* RevisionMetaDTO
|
|
802
|
+
* @description Information about the editorial notes
|
|
803
|
+
*/
|
|
804
|
+
RevisionMetaDTO: {
|
|
805
|
+
/** @description A date on which the article would need to be revised */
|
|
806
|
+
revisionDate: string;
|
|
807
|
+
/** @description Notes to keep track of what needs to happen before revision */
|
|
808
|
+
note: string;
|
|
809
|
+
/** @description Status of a revision, either 'revised' or 'needs-revision' */
|
|
810
|
+
status: string;
|
|
811
|
+
};
|
|
812
|
+
/** SearchParamsDTO */
|
|
813
|
+
SearchParamsDTO: {
|
|
814
|
+
/**
|
|
815
|
+
* Format: int32
|
|
816
|
+
* @description The page number of the search hits to display.
|
|
817
|
+
*/
|
|
818
|
+
page?: number;
|
|
819
|
+
/**
|
|
820
|
+
* Format: int32
|
|
821
|
+
* @description The number of search hits to display for each page.
|
|
822
|
+
*/
|
|
823
|
+
pageSize?: number;
|
|
824
|
+
/** @description A list of article-types the search should be filtered by. */
|
|
825
|
+
articleTypes?: string[];
|
|
826
|
+
/**
|
|
827
|
+
* @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"].
|
|
828
|
+
* When scrolling, the parameters from the initial search is used, except in the case of 'language' and 'fallback'.
|
|
829
|
+
* This value may change between scrolls. Always use the one in the latest scroll result.
|
|
830
|
+
*/
|
|
831
|
+
scrollId?: string;
|
|
832
|
+
/** @description Return only results with content matching the specified query. */
|
|
833
|
+
query?: string;
|
|
834
|
+
/** @description Fallback to existing language if language is specified. */
|
|
835
|
+
fallback?: boolean;
|
|
836
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
837
|
+
language?: string;
|
|
838
|
+
/** @description Return only results with provided license. */
|
|
839
|
+
license?: string;
|
|
840
|
+
sort?: components["schemas"]["Sort"];
|
|
841
|
+
/** @description Return only learning resources that have one of the provided ids. */
|
|
842
|
+
ids?: number[];
|
|
843
|
+
/** @description A comma separated list of subjects the learning resources should be filtered by. */
|
|
844
|
+
subjects?: string[];
|
|
845
|
+
/** @description Return only learning resources of specific type(s). */
|
|
846
|
+
resourceTypes?: string[];
|
|
847
|
+
/** @description A list of context-types the learning resources should be filtered by. */
|
|
848
|
+
contextTypes?: string[];
|
|
849
|
+
/**
|
|
850
|
+
* @description A list of relevances the learning resources should be filtered by.
|
|
851
|
+
* If subjects are specified the learning resource must have specified relevances in relation to a specified subject.
|
|
852
|
+
* If levels are specified the learning resource must have specified relevances in relation to a specified level.
|
|
853
|
+
*/
|
|
854
|
+
relevance?: string[];
|
|
855
|
+
/** @description A list of ISO 639-1 language codes that the learning resource can be available in. */
|
|
856
|
+
languageFilter?: string[];
|
|
857
|
+
/** @description A list of codes from GREP API the resources should be filtered by. */
|
|
858
|
+
grepCodes?: string[];
|
|
859
|
+
/** @description A comma separated list of traits the resources should be filtered by. */
|
|
860
|
+
traits?: components["schemas"]["ArticleTrait"][];
|
|
861
|
+
/** @description List of index-paths that should be term-aggregated and returned in result. */
|
|
862
|
+
aggregatePaths?: string[];
|
|
863
|
+
/** @description Return only results with embed data-resource the specified resource. Can specify multiple with a comma separated list to filter for one of the embed types. */
|
|
864
|
+
embedResource?: string[];
|
|
865
|
+
/** @description Return only results with embed data-resource_id, data-videoid or data-url with the specified id. */
|
|
866
|
+
embedId?: string;
|
|
867
|
+
/** @description Filter out inactive taxonomy contexts. */
|
|
868
|
+
filterInactive?: boolean;
|
|
869
|
+
/** @description Which types the search request should return */
|
|
870
|
+
resultTypes?: components["schemas"]["SearchType"][];
|
|
871
|
+
/** @description Which node types the search request should return */
|
|
872
|
+
nodeTypeFilter?: components["schemas"]["NodeType"][];
|
|
873
|
+
/** @description Only return results that have one of the specified tags. */
|
|
874
|
+
tags?: string[];
|
|
875
|
+
};
|
|
876
|
+
/**
|
|
877
|
+
* SearchSuggestionDTO
|
|
878
|
+
* @description Search suggestion for query-text
|
|
879
|
+
*/
|
|
880
|
+
SearchSuggestionDTO: {
|
|
881
|
+
/** @description The search query suggestions are made for */
|
|
882
|
+
text: string;
|
|
883
|
+
/**
|
|
884
|
+
* Format: int32
|
|
885
|
+
* @description The offset in the search query
|
|
886
|
+
*/
|
|
887
|
+
offset: number;
|
|
888
|
+
/**
|
|
889
|
+
* Format: int32
|
|
890
|
+
* @description The position index in the search query
|
|
891
|
+
*/
|
|
892
|
+
length: number;
|
|
893
|
+
/** @description The list of suggest options for the field */
|
|
894
|
+
options: components["schemas"]["SuggestOptionDTO"][];
|
|
895
|
+
};
|
|
896
|
+
/**
|
|
897
|
+
* SearchType
|
|
898
|
+
* @enum {string}
|
|
899
|
+
*/
|
|
900
|
+
SearchType: "article" | "draft" | "learningpath" | "concept" | "grep" | "node";
|
|
901
|
+
/**
|
|
902
|
+
* Sort
|
|
903
|
+
* @description The sorting used on results.
|
|
904
|
+
* @enum {string}
|
|
905
|
+
*/
|
|
906
|
+
Sort: "-relevance" | "relevance" | "-title" | "title" | "-lastUpdated" | "lastUpdated" | "-id" | "id" | "-duration" | "duration" | "revisionDate" | "-revisionDate" | "responsibleLastUpdated" | "-responsibleLastUpdated" | "status" | "-status" | "-prioritized" | "prioritized" | "-parentTopicName" | "parentTopicName" | "-primaryRoot" | "primaryRoot" | "-resourceType" | "resourceType" | "-published" | "published" | "-favorited" | "favorited";
|
|
907
|
+
/**
|
|
908
|
+
* StatusDTO
|
|
909
|
+
* @description Status information of the resource
|
|
910
|
+
*/
|
|
911
|
+
StatusDTO: {
|
|
912
|
+
/** @description The current status of the resource */
|
|
913
|
+
current: string;
|
|
914
|
+
/** @description Previous statuses this resource has been in */
|
|
915
|
+
other: string[];
|
|
916
|
+
};
|
|
917
|
+
/**
|
|
918
|
+
* SubjectAggregationDTO
|
|
919
|
+
* @description Aggregations for a single subject'
|
|
920
|
+
*/
|
|
921
|
+
SubjectAggregationDTO: {
|
|
922
|
+
/** @description Id of the aggregated subject */
|
|
923
|
+
subjectId: string;
|
|
924
|
+
/**
|
|
925
|
+
* Format: int64
|
|
926
|
+
* @description Number of resources in subject
|
|
927
|
+
*/
|
|
928
|
+
publishedArticleCount: number;
|
|
929
|
+
/**
|
|
930
|
+
* Format: int64
|
|
931
|
+
* @description Number of resources in subject with published older than 5 years
|
|
932
|
+
*/
|
|
933
|
+
oldArticleCount: number;
|
|
934
|
+
/**
|
|
935
|
+
* Format: int64
|
|
936
|
+
* @description Number of resources in subject with a revision date expiration in one year
|
|
937
|
+
*/
|
|
938
|
+
revisionCount: number;
|
|
939
|
+
/**
|
|
940
|
+
* Format: int64
|
|
941
|
+
* @description Number of resources in 'flow' (Articles not in `PUBLISHED`, `UNPUBLISHED` or `ARCHIVED` status
|
|
942
|
+
*/
|
|
943
|
+
flowCount: number;
|
|
944
|
+
/**
|
|
945
|
+
* Format: int64
|
|
946
|
+
* @description Number of favorited resources
|
|
947
|
+
*/
|
|
948
|
+
favoritedCount: number;
|
|
949
|
+
};
|
|
950
|
+
/**
|
|
951
|
+
* SubjectAggregationsDTO
|
|
952
|
+
* @description Result of subject aggregations
|
|
953
|
+
*/
|
|
954
|
+
SubjectAggregationsDTO: {
|
|
955
|
+
subjects: components["schemas"]["SubjectAggregationDTO"][];
|
|
956
|
+
};
|
|
957
|
+
/**
|
|
958
|
+
* SubjectAggsInputDTO
|
|
959
|
+
* @description Input parameters to subject aggregations endpoint
|
|
960
|
+
*/
|
|
961
|
+
SubjectAggsInputDTO: {
|
|
962
|
+
/** @description A comma separated list of subjects the learning resources should be filtered by. */
|
|
963
|
+
subjects?: string[];
|
|
964
|
+
};
|
|
965
|
+
/**
|
|
966
|
+
* SubjectPageSummaryDTO
|
|
967
|
+
* @description Subject page summary if the node is connected to a subject page
|
|
968
|
+
*/
|
|
969
|
+
SubjectPageSummaryDTO: {
|
|
970
|
+
/** Format: int64 */
|
|
971
|
+
id: number;
|
|
972
|
+
name: string;
|
|
973
|
+
/** @description Meta description of the resource */
|
|
974
|
+
metaDescription: components["schemas"]["MetaDescriptionDTO"];
|
|
975
|
+
};
|
|
976
|
+
/**
|
|
977
|
+
* SuggestOptionDTO
|
|
978
|
+
* @description Search suggestion options for the terms in the query
|
|
979
|
+
*/
|
|
980
|
+
SuggestOptionDTO: {
|
|
981
|
+
/** @description The suggested text */
|
|
982
|
+
text: string;
|
|
983
|
+
/**
|
|
984
|
+
* Format: double
|
|
985
|
+
* @description The score of the suggestion
|
|
986
|
+
*/
|
|
987
|
+
score: number;
|
|
988
|
+
};
|
|
989
|
+
/**
|
|
990
|
+
* TaxonomyResourceTypeDTO
|
|
991
|
+
* @description Taxonomy resource type
|
|
992
|
+
*/
|
|
993
|
+
TaxonomyResourceTypeDTO: {
|
|
994
|
+
/** @description Id of the taoxonomy resource type */
|
|
995
|
+
id: string;
|
|
996
|
+
/** @description Name of the taoxonomy resource type */
|
|
997
|
+
name: string;
|
|
998
|
+
/** @description The ISO 639-1 language code for the resource type */
|
|
999
|
+
language: string;
|
|
1000
|
+
};
|
|
1001
|
+
/**
|
|
1002
|
+
* TermValueDTO
|
|
1003
|
+
* @description Value that appears in the search aggregation
|
|
1004
|
+
*/
|
|
1005
|
+
TermValueDTO: {
|
|
1006
|
+
/** @description Value that appeared in result */
|
|
1007
|
+
value: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* Format: int32
|
|
1010
|
+
* @description Number of times the value appeared in result
|
|
1011
|
+
*/
|
|
1012
|
+
count: number;
|
|
1013
|
+
};
|
|
1014
|
+
/** TitleDTO */
|
|
1015
|
+
TitleDTO: {
|
|
1016
|
+
/** @description The freetext title of the resource */
|
|
1017
|
+
title: string;
|
|
1018
|
+
/** @description ISO 639-1 code that represents the language used in title */
|
|
1019
|
+
language: string;
|
|
1020
|
+
};
|
|
1021
|
+
/**
|
|
1022
|
+
* TitleWithHtmlDTO
|
|
1023
|
+
* @description The title of the resource
|
|
1024
|
+
*/
|
|
1025
|
+
TitleWithHtmlDTO: {
|
|
1026
|
+
/** @description The freetext title of the resource */
|
|
1027
|
+
title: string;
|
|
1028
|
+
/** @description The freetext html-version title of the article */
|
|
1029
|
+
htmlTitle: string;
|
|
1030
|
+
/** @description ISO 639-1 code that represents the language used in title */
|
|
1031
|
+
language: string;
|
|
1032
|
+
};
|
|
1033
|
+
/**
|
|
1034
|
+
* ValidationErrorBody
|
|
1035
|
+
* @description Information about an error
|
|
1036
|
+
*/
|
|
1037
|
+
ValidationErrorBody: {
|
|
1038
|
+
/** @description Code stating the type of error */
|
|
1039
|
+
code: string;
|
|
1040
|
+
/** @description Description of the error */
|
|
1041
|
+
description: string;
|
|
1042
|
+
/** @description When the error occurred */
|
|
1043
|
+
occurredAt: string;
|
|
1044
|
+
/** @description List of validation messages */
|
|
1045
|
+
messages?: components["schemas"]["ValidationMessage"][];
|
|
1046
|
+
/**
|
|
1047
|
+
* Format: int32
|
|
1048
|
+
* @description Numeric http status code
|
|
1049
|
+
*/
|
|
1050
|
+
statusCode: number;
|
|
1051
|
+
};
|
|
1052
|
+
/**
|
|
1053
|
+
* ValidationMessage
|
|
1054
|
+
* @description A message describing a validation error on a specific field
|
|
1055
|
+
*/
|
|
1056
|
+
ValidationMessage: {
|
|
1057
|
+
/** @description The field the error occured in */
|
|
1058
|
+
field: string;
|
|
1059
|
+
/** @description The validation message */
|
|
1060
|
+
message: string;
|
|
1061
|
+
};
|
|
1062
|
+
};
|
|
1063
|
+
responses: never;
|
|
1064
|
+
parameters: never;
|
|
1065
|
+
requestBodies: never;
|
|
1066
|
+
headers: never;
|
|
1067
|
+
pathItems: never;
|
|
1068
|
+
};
|
|
1069
|
+
export type AllErrors = components['schemas']['AllErrors'];
|
|
1070
|
+
export type ApiTaxonomyContextDTO = components['schemas']['ApiTaxonomyContextDTO'];
|
|
1071
|
+
export type ArticleTrait = components['schemas']['ArticleTrait'];
|
|
1072
|
+
export type CommentDTO = components['schemas']['CommentDTO'];
|
|
1073
|
+
export type DescriptionDTO = components['schemas']['DescriptionDTO'];
|
|
1074
|
+
export type DraftSearchParamsDTO = components['schemas']['DraftSearchParamsDTO'];
|
|
1075
|
+
export type ErrorBody = components['schemas']['ErrorBody'];
|
|
1076
|
+
export type GrepFagkodeDTO = components['schemas']['GrepFagkodeDTO'];
|
|
1077
|
+
export type GrepFagkodeDTO1 = components['schemas']['GrepFagkodeDTO1'];
|
|
1078
|
+
export type GrepKjerneelementDTO = components['schemas']['GrepKjerneelementDTO'];
|
|
1079
|
+
export type GrepKjerneelementDTO1 = components['schemas']['GrepKjerneelementDTO1'];
|
|
1080
|
+
export type GrepKompetansemaalDTO = components['schemas']['GrepKompetansemaalDTO'];
|
|
1081
|
+
export type GrepKompetansemaalDTO1 = components['schemas']['GrepKompetansemaalDTO1'];
|
|
1082
|
+
export type GrepKompetansemaalSettDTO = components['schemas']['GrepKompetansemaalSettDTO'];
|
|
1083
|
+
export type GrepKompetansemaalSettDTO1 = components['schemas']['GrepKompetansemaalSettDTO1'];
|
|
1084
|
+
export type GrepLaererplanDTO = components['schemas']['GrepLaererplanDTO'];
|
|
1085
|
+
export type GrepLaererplanDTO1 = components['schemas']['GrepLaererplanDTO1'];
|
|
1086
|
+
export type GrepReferencedKjerneelementDTO = components['schemas']['GrepReferencedKjerneelementDTO'];
|
|
1087
|
+
export type GrepReferencedKompetansemaalDTO = components['schemas']['GrepReferencedKompetansemaalDTO'];
|
|
1088
|
+
export type GrepReferencedKompetansemaalSettDTO = components['schemas']['GrepReferencedKompetansemaalSettDTO'];
|
|
1089
|
+
export type GrepReferencedLaereplanDTO = components['schemas']['GrepReferencedLaereplanDTO'];
|
|
1090
|
+
export type GrepResultDTO = components['schemas']['GrepResultDTO'];
|
|
1091
|
+
export type GrepSearchInputDTO = components['schemas']['GrepSearchInputDTO'];
|
|
1092
|
+
export type GrepSearchResultsDTO = components['schemas']['GrepSearchResultsDTO'];
|
|
1093
|
+
export type GrepSortDTO = components['schemas']['GrepSortDTO'];
|
|
1094
|
+
export type GrepStatusDTO = components['schemas']['GrepStatusDTO'];
|
|
1095
|
+
export type GrepTverrfagligTemaDTO = components['schemas']['GrepTverrfagligTemaDTO'];
|
|
1096
|
+
export type GrepTverrfagligTemaDTO1 = components['schemas']['GrepTverrfagligTemaDTO1'];
|
|
1097
|
+
export type GroupSearchResultDTO = components['schemas']['GroupSearchResultDTO'];
|
|
1098
|
+
export type HighlightedFieldDTO = components['schemas']['HighlightedFieldDTO'];
|
|
1099
|
+
export type LearningResourceType = components['schemas']['LearningResourceType'];
|
|
1100
|
+
export type Map_String = components['schemas']['Map_String'];
|
|
1101
|
+
export type MetaDescriptionDTO = components['schemas']['MetaDescriptionDTO'];
|
|
1102
|
+
export type MetaImageDTO = components['schemas']['MetaImageDTO'];
|
|
1103
|
+
export type MultiSearchResultDTO = components['schemas']['MultiSearchResultDTO'];
|
|
1104
|
+
export type MultiSearchSuggestionDTO = components['schemas']['MultiSearchSuggestionDTO'];
|
|
1105
|
+
export type MultiSearchSummaryDTO = components['schemas']['MultiSearchSummaryDTO'];
|
|
1106
|
+
export type MultiSearchSummaryDTO1 = components['schemas']['MultiSearchSummaryDTO1'];
|
|
1107
|
+
export type MultiSearchTermsAggregationDTO = components['schemas']['MultiSearchTermsAggregationDTO'];
|
|
1108
|
+
export type MultiSummaryBaseDTO = components['schemas']['MultiSummaryBaseDTO'];
|
|
1109
|
+
export type NodeHitDTO = components['schemas']['NodeHitDTO'];
|
|
1110
|
+
export type NodeHitDTO1 = components['schemas']['NodeHitDTO1'];
|
|
1111
|
+
export type NodeType = components['schemas']['NodeType'];
|
|
1112
|
+
export type NotFoundWithSupportedLanguages = components['schemas']['NotFoundWithSupportedLanguages'];
|
|
1113
|
+
export type Priority = components['schemas']['Priority'];
|
|
1114
|
+
export type ResponsibleDTO = components['schemas']['ResponsibleDTO'];
|
|
1115
|
+
export type RevisionMetaDTO = components['schemas']['RevisionMetaDTO'];
|
|
1116
|
+
export type SearchParamsDTO = components['schemas']['SearchParamsDTO'];
|
|
1117
|
+
export type SearchSuggestionDTO = components['schemas']['SearchSuggestionDTO'];
|
|
1118
|
+
export type SearchType = components['schemas']['SearchType'];
|
|
1119
|
+
export type Sort = components['schemas']['Sort'];
|
|
1120
|
+
export type StatusDTO = components['schemas']['StatusDTO'];
|
|
1121
|
+
export type SubjectAggregationDTO = components['schemas']['SubjectAggregationDTO'];
|
|
1122
|
+
export type SubjectAggregationsDTO = components['schemas']['SubjectAggregationsDTO'];
|
|
1123
|
+
export type SubjectAggsInputDTO = components['schemas']['SubjectAggsInputDTO'];
|
|
1124
|
+
export type SubjectPageSummaryDTO = components['schemas']['SubjectPageSummaryDTO'];
|
|
1125
|
+
export type SuggestOptionDTO = components['schemas']['SuggestOptionDTO'];
|
|
1126
|
+
export type TaxonomyResourceTypeDTO = components['schemas']['TaxonomyResourceTypeDTO'];
|
|
1127
|
+
export type TermValueDTO = components['schemas']['TermValueDTO'];
|
|
1128
|
+
export type TitleDTO = components['schemas']['TitleDTO'];
|
|
1129
|
+
export type TitleWithHtmlDTO = components['schemas']['TitleWithHtmlDTO'];
|
|
1130
|
+
export type ValidationErrorBody = components['schemas']['ValidationErrorBody'];
|
|
1131
|
+
export type ValidationMessage = components['schemas']['ValidationMessage'];
|
|
1132
|
+
export type $defs = Record<string, never>;
|
|
1133
|
+
export interface operations {
|
|
1134
|
+
"getSearch-apiV1SearchGroup": {
|
|
1135
|
+
parameters: {
|
|
1136
|
+
query?: {
|
|
1137
|
+
page?: number;
|
|
1138
|
+
"page-size"?: number;
|
|
1139
|
+
"article-types"?: string[];
|
|
1140
|
+
"context-types"?: string[];
|
|
1141
|
+
language?: string;
|
|
1142
|
+
ids?: number[];
|
|
1143
|
+
"resource-types"?: string[];
|
|
1144
|
+
license?: string;
|
|
1145
|
+
query?: string;
|
|
1146
|
+
sort?: string;
|
|
1147
|
+
fallback?: boolean;
|
|
1148
|
+
subjects?: string[];
|
|
1149
|
+
"language-filter"?: string[];
|
|
1150
|
+
relevance?: string[];
|
|
1151
|
+
"search-context"?: string;
|
|
1152
|
+
"grep-codes"?: string[];
|
|
1153
|
+
"aggregate-paths"?: string[];
|
|
1154
|
+
"embed-resource"?: string[];
|
|
1155
|
+
"embed-id"?: string;
|
|
1156
|
+
"filter-inactive"?: boolean;
|
|
1157
|
+
traits?: string[];
|
|
1158
|
+
"result-types"?: string[];
|
|
1159
|
+
"node-types"?: string[];
|
|
1160
|
+
tags?: string[];
|
|
1161
|
+
/** @description Whether to include group without resource-types for group-search. Defaults to false. */
|
|
1162
|
+
"missing-group"?: boolean;
|
|
1163
|
+
};
|
|
1164
|
+
header?: never;
|
|
1165
|
+
path?: never;
|
|
1166
|
+
cookie?: never;
|
|
1167
|
+
};
|
|
1168
|
+
requestBody?: never;
|
|
1169
|
+
responses: {
|
|
1170
|
+
200: {
|
|
1171
|
+
headers: {
|
|
1172
|
+
[name: string]: unknown;
|
|
1173
|
+
};
|
|
1174
|
+
content: {
|
|
1175
|
+
"application/json": components["schemas"]["GroupSearchResultDTO"][];
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
400: {
|
|
1179
|
+
headers: {
|
|
1180
|
+
[name: string]: unknown;
|
|
1181
|
+
};
|
|
1182
|
+
content: {
|
|
1183
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1184
|
+
};
|
|
1185
|
+
};
|
|
1186
|
+
401: {
|
|
1187
|
+
headers: {
|
|
1188
|
+
[name: string]: unknown;
|
|
1189
|
+
};
|
|
1190
|
+
content: {
|
|
1191
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
403: {
|
|
1195
|
+
headers: {
|
|
1196
|
+
[name: string]: unknown;
|
|
1197
|
+
};
|
|
1198
|
+
content: {
|
|
1199
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
404: {
|
|
1203
|
+
headers: {
|
|
1204
|
+
[name: string]: unknown;
|
|
1205
|
+
};
|
|
1206
|
+
content: {
|
|
1207
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1208
|
+
};
|
|
1209
|
+
};
|
|
1210
|
+
500: {
|
|
1211
|
+
headers: {
|
|
1212
|
+
[name: string]: unknown;
|
|
1213
|
+
};
|
|
1214
|
+
content: {
|
|
1215
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1216
|
+
};
|
|
1217
|
+
};
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
"getSearch-apiV1Search": {
|
|
1221
|
+
parameters: {
|
|
1222
|
+
query?: {
|
|
1223
|
+
page?: number;
|
|
1224
|
+
"page-size"?: number;
|
|
1225
|
+
"article-types"?: string[];
|
|
1226
|
+
"context-types"?: string[];
|
|
1227
|
+
language?: string;
|
|
1228
|
+
ids?: number[];
|
|
1229
|
+
"resource-types"?: string[];
|
|
1230
|
+
license?: string;
|
|
1231
|
+
query?: string;
|
|
1232
|
+
sort?: string;
|
|
1233
|
+
fallback?: boolean;
|
|
1234
|
+
subjects?: string[];
|
|
1235
|
+
"language-filter"?: string[];
|
|
1236
|
+
relevance?: string[];
|
|
1237
|
+
"search-context"?: string;
|
|
1238
|
+
"grep-codes"?: string[];
|
|
1239
|
+
"aggregate-paths"?: string[];
|
|
1240
|
+
"embed-resource"?: string[];
|
|
1241
|
+
"embed-id"?: string;
|
|
1242
|
+
"filter-inactive"?: boolean;
|
|
1243
|
+
traits?: string[];
|
|
1244
|
+
"result-types"?: string[];
|
|
1245
|
+
"node-types"?: string[];
|
|
1246
|
+
tags?: string[];
|
|
1247
|
+
};
|
|
1248
|
+
header?: never;
|
|
1249
|
+
path?: never;
|
|
1250
|
+
cookie?: never;
|
|
1251
|
+
};
|
|
1252
|
+
requestBody?: never;
|
|
1253
|
+
responses: {
|
|
1254
|
+
200: {
|
|
1255
|
+
headers: {
|
|
1256
|
+
[name: string]: unknown;
|
|
1257
|
+
};
|
|
1258
|
+
content: {
|
|
1259
|
+
"application/json": components["schemas"]["MultiSearchResultDTO"];
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
400: {
|
|
1263
|
+
headers: {
|
|
1264
|
+
[name: string]: unknown;
|
|
1265
|
+
};
|
|
1266
|
+
content: {
|
|
1267
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1268
|
+
};
|
|
1269
|
+
};
|
|
1270
|
+
401: {
|
|
1271
|
+
headers: {
|
|
1272
|
+
[name: string]: unknown;
|
|
1273
|
+
};
|
|
1274
|
+
content: {
|
|
1275
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
403: {
|
|
1279
|
+
headers: {
|
|
1280
|
+
[name: string]: unknown;
|
|
1281
|
+
};
|
|
1282
|
+
content: {
|
|
1283
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1284
|
+
};
|
|
1285
|
+
};
|
|
1286
|
+
404: {
|
|
1287
|
+
headers: {
|
|
1288
|
+
[name: string]: unknown;
|
|
1289
|
+
};
|
|
1290
|
+
content: {
|
|
1291
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1292
|
+
};
|
|
1293
|
+
};
|
|
1294
|
+
500: {
|
|
1295
|
+
headers: {
|
|
1296
|
+
[name: string]: unknown;
|
|
1297
|
+
};
|
|
1298
|
+
content: {
|
|
1299
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1300
|
+
};
|
|
1301
|
+
};
|
|
1302
|
+
};
|
|
1303
|
+
};
|
|
1304
|
+
"postSearch-apiV1Search": {
|
|
1305
|
+
parameters: {
|
|
1306
|
+
query?: never;
|
|
1307
|
+
header?: never;
|
|
1308
|
+
path?: never;
|
|
1309
|
+
cookie?: never;
|
|
1310
|
+
};
|
|
1311
|
+
requestBody?: {
|
|
1312
|
+
content: {
|
|
1313
|
+
"application/json": components["schemas"]["SearchParamsDTO"];
|
|
1314
|
+
};
|
|
1315
|
+
};
|
|
1316
|
+
responses: {
|
|
1317
|
+
200: {
|
|
1318
|
+
headers: {
|
|
1319
|
+
[name: string]: unknown;
|
|
1320
|
+
};
|
|
1321
|
+
content: {
|
|
1322
|
+
"application/json": components["schemas"]["MultiSearchResultDTO"];
|
|
1323
|
+
};
|
|
1324
|
+
};
|
|
1325
|
+
400: {
|
|
1326
|
+
headers: {
|
|
1327
|
+
[name: string]: unknown;
|
|
1328
|
+
};
|
|
1329
|
+
content: {
|
|
1330
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
404: {
|
|
1334
|
+
headers: {
|
|
1335
|
+
[name: string]: unknown;
|
|
1336
|
+
};
|
|
1337
|
+
content: {
|
|
1338
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
500: {
|
|
1342
|
+
headers: {
|
|
1343
|
+
[name: string]: unknown;
|
|
1344
|
+
};
|
|
1345
|
+
content: {
|
|
1346
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1347
|
+
};
|
|
1348
|
+
};
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
"getSearch-apiV1SearchEditorial": {
|
|
1352
|
+
parameters: {
|
|
1353
|
+
query?: never;
|
|
1354
|
+
header?: never;
|
|
1355
|
+
path?: never;
|
|
1356
|
+
cookie?: never;
|
|
1357
|
+
};
|
|
1358
|
+
requestBody?: never;
|
|
1359
|
+
responses: {
|
|
1360
|
+
200: {
|
|
1361
|
+
headers: {
|
|
1362
|
+
[name: string]: unknown;
|
|
1363
|
+
};
|
|
1364
|
+
content: {
|
|
1365
|
+
"application/json": components["schemas"]["MultiSearchResultDTO"];
|
|
1366
|
+
};
|
|
1367
|
+
};
|
|
1368
|
+
400: {
|
|
1369
|
+
headers: {
|
|
1370
|
+
[name: string]: unknown;
|
|
1371
|
+
};
|
|
1372
|
+
content: {
|
|
1373
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1374
|
+
};
|
|
1375
|
+
};
|
|
1376
|
+
401: {
|
|
1377
|
+
headers: {
|
|
1378
|
+
[name: string]: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
content: {
|
|
1381
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1382
|
+
};
|
|
1383
|
+
};
|
|
1384
|
+
403: {
|
|
1385
|
+
headers: {
|
|
1386
|
+
[name: string]: unknown;
|
|
1387
|
+
};
|
|
1388
|
+
content: {
|
|
1389
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
404: {
|
|
1393
|
+
headers: {
|
|
1394
|
+
[name: string]: unknown;
|
|
1395
|
+
};
|
|
1396
|
+
content: {
|
|
1397
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
500: {
|
|
1401
|
+
headers: {
|
|
1402
|
+
[name: string]: unknown;
|
|
1403
|
+
};
|
|
1404
|
+
content: {
|
|
1405
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1406
|
+
};
|
|
1407
|
+
};
|
|
1408
|
+
};
|
|
1409
|
+
};
|
|
1410
|
+
"postSearch-apiV1SearchEditorial": {
|
|
1411
|
+
parameters: {
|
|
1412
|
+
query?: never;
|
|
1413
|
+
header?: never;
|
|
1414
|
+
path?: never;
|
|
1415
|
+
cookie?: never;
|
|
1416
|
+
};
|
|
1417
|
+
requestBody?: {
|
|
1418
|
+
content: {
|
|
1419
|
+
"application/json": components["schemas"]["DraftSearchParamsDTO"];
|
|
1420
|
+
};
|
|
1421
|
+
};
|
|
1422
|
+
responses: {
|
|
1423
|
+
200: {
|
|
1424
|
+
headers: {
|
|
1425
|
+
[name: string]: unknown;
|
|
1426
|
+
};
|
|
1427
|
+
content: {
|
|
1428
|
+
"application/json": components["schemas"]["MultiSearchResultDTO"];
|
|
1429
|
+
};
|
|
1430
|
+
};
|
|
1431
|
+
400: {
|
|
1432
|
+
headers: {
|
|
1433
|
+
[name: string]: unknown;
|
|
1434
|
+
};
|
|
1435
|
+
content: {
|
|
1436
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1437
|
+
};
|
|
1438
|
+
};
|
|
1439
|
+
401: {
|
|
1440
|
+
headers: {
|
|
1441
|
+
[name: string]: unknown;
|
|
1442
|
+
};
|
|
1443
|
+
content: {
|
|
1444
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1445
|
+
};
|
|
1446
|
+
};
|
|
1447
|
+
403: {
|
|
1448
|
+
headers: {
|
|
1449
|
+
[name: string]: unknown;
|
|
1450
|
+
};
|
|
1451
|
+
content: {
|
|
1452
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
1455
|
+
404: {
|
|
1456
|
+
headers: {
|
|
1457
|
+
[name: string]: unknown;
|
|
1458
|
+
};
|
|
1459
|
+
content: {
|
|
1460
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
500: {
|
|
1464
|
+
headers: {
|
|
1465
|
+
[name: string]: unknown;
|
|
1466
|
+
};
|
|
1467
|
+
content: {
|
|
1468
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1469
|
+
};
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
};
|
|
1473
|
+
"postSearch-apiV1SearchSubjects": {
|
|
1474
|
+
parameters: {
|
|
1475
|
+
query?: never;
|
|
1476
|
+
header?: never;
|
|
1477
|
+
path?: never;
|
|
1478
|
+
cookie?: never;
|
|
1479
|
+
};
|
|
1480
|
+
requestBody: {
|
|
1481
|
+
content: {
|
|
1482
|
+
"application/json": components["schemas"]["SubjectAggsInputDTO"];
|
|
1483
|
+
};
|
|
1484
|
+
};
|
|
1485
|
+
responses: {
|
|
1486
|
+
200: {
|
|
1487
|
+
headers: {
|
|
1488
|
+
[name: string]: unknown;
|
|
1489
|
+
};
|
|
1490
|
+
content: {
|
|
1491
|
+
"application/json": components["schemas"]["SubjectAggregationsDTO"];
|
|
1492
|
+
};
|
|
1493
|
+
};
|
|
1494
|
+
400: {
|
|
1495
|
+
headers: {
|
|
1496
|
+
[name: string]: unknown;
|
|
1497
|
+
};
|
|
1498
|
+
content: {
|
|
1499
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1500
|
+
};
|
|
1501
|
+
};
|
|
1502
|
+
401: {
|
|
1503
|
+
headers: {
|
|
1504
|
+
[name: string]: unknown;
|
|
1505
|
+
};
|
|
1506
|
+
content: {
|
|
1507
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1508
|
+
};
|
|
1509
|
+
};
|
|
1510
|
+
403: {
|
|
1511
|
+
headers: {
|
|
1512
|
+
[name: string]: unknown;
|
|
1513
|
+
};
|
|
1514
|
+
content: {
|
|
1515
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1516
|
+
};
|
|
1517
|
+
};
|
|
1518
|
+
404: {
|
|
1519
|
+
headers: {
|
|
1520
|
+
[name: string]: unknown;
|
|
1521
|
+
};
|
|
1522
|
+
content: {
|
|
1523
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1524
|
+
};
|
|
1525
|
+
};
|
|
1526
|
+
500: {
|
|
1527
|
+
headers: {
|
|
1528
|
+
[name: string]: unknown;
|
|
1529
|
+
};
|
|
1530
|
+
content: {
|
|
1531
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1532
|
+
};
|
|
1533
|
+
};
|
|
1534
|
+
};
|
|
1535
|
+
};
|
|
1536
|
+
"postSearch-apiV1SearchGrep": {
|
|
1537
|
+
parameters: {
|
|
1538
|
+
query?: never;
|
|
1539
|
+
header?: never;
|
|
1540
|
+
path?: never;
|
|
1541
|
+
cookie?: never;
|
|
1542
|
+
};
|
|
1543
|
+
requestBody: {
|
|
1544
|
+
content: {
|
|
1545
|
+
"application/json": components["schemas"]["GrepSearchInputDTO"];
|
|
1546
|
+
};
|
|
1547
|
+
};
|
|
1548
|
+
responses: {
|
|
1549
|
+
200: {
|
|
1550
|
+
headers: {
|
|
1551
|
+
[name: string]: unknown;
|
|
1552
|
+
};
|
|
1553
|
+
content: {
|
|
1554
|
+
"application/json": components["schemas"]["GrepSearchResultsDTO"];
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
400: {
|
|
1558
|
+
headers: {
|
|
1559
|
+
[name: string]: unknown;
|
|
1560
|
+
};
|
|
1561
|
+
content: {
|
|
1562
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1563
|
+
};
|
|
1564
|
+
};
|
|
1565
|
+
401: {
|
|
1566
|
+
headers: {
|
|
1567
|
+
[name: string]: unknown;
|
|
1568
|
+
};
|
|
1569
|
+
content: {
|
|
1570
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1571
|
+
};
|
|
1572
|
+
};
|
|
1573
|
+
403: {
|
|
1574
|
+
headers: {
|
|
1575
|
+
[name: string]: unknown;
|
|
1576
|
+
};
|
|
1577
|
+
content: {
|
|
1578
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1579
|
+
};
|
|
1580
|
+
};
|
|
1581
|
+
404: {
|
|
1582
|
+
headers: {
|
|
1583
|
+
[name: string]: unknown;
|
|
1584
|
+
};
|
|
1585
|
+
content: {
|
|
1586
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1587
|
+
};
|
|
1588
|
+
};
|
|
1589
|
+
500: {
|
|
1590
|
+
headers: {
|
|
1591
|
+
[name: string]: unknown;
|
|
1592
|
+
};
|
|
1593
|
+
content: {
|
|
1594
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1595
|
+
};
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
"getSearch-apiV1SearchGrepReplacements": {
|
|
1600
|
+
parameters: {
|
|
1601
|
+
query?: {
|
|
1602
|
+
/** @description Grep codes to find replacements for. To provide codes ids, separate by comma (,). */
|
|
1603
|
+
codes?: string[];
|
|
1604
|
+
};
|
|
1605
|
+
header?: never;
|
|
1606
|
+
path?: never;
|
|
1607
|
+
cookie?: never;
|
|
1608
|
+
};
|
|
1609
|
+
requestBody?: never;
|
|
1610
|
+
responses: {
|
|
1611
|
+
200: {
|
|
1612
|
+
headers: {
|
|
1613
|
+
[name: string]: unknown;
|
|
1614
|
+
};
|
|
1615
|
+
content: {
|
|
1616
|
+
"application/json": components["schemas"]["Map_String"];
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
400: {
|
|
1620
|
+
headers: {
|
|
1621
|
+
[name: string]: unknown;
|
|
1622
|
+
};
|
|
1623
|
+
content: {
|
|
1624
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1625
|
+
};
|
|
1626
|
+
};
|
|
1627
|
+
404: {
|
|
1628
|
+
headers: {
|
|
1629
|
+
[name: string]: unknown;
|
|
1630
|
+
};
|
|
1631
|
+
content: {
|
|
1632
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1633
|
+
};
|
|
1634
|
+
};
|
|
1635
|
+
500: {
|
|
1636
|
+
headers: {
|
|
1637
|
+
[name: string]: unknown;
|
|
1638
|
+
};
|
|
1639
|
+
content: {
|
|
1640
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1641
|
+
};
|
|
1642
|
+
};
|
|
1643
|
+
};
|
|
1644
|
+
};
|
|
1645
|
+
}
|