@ndla/types-backend 1.0.33 → 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.
- package/build/article-api-openapi.d.ts +1092 -0
- package/build/article-api-openapi.js +7 -0
- package/build/article-api-openapi.js.map +1 -0
- package/build/article-api.d.ts +57 -156
- package/build/article-api.js +27 -13
- package/build/article-api.js.map +1 -1
- package/build/audio-api-openapi.d.ts +2153 -0
- package/build/audio-api-openapi.js +7 -0
- package/build/audio-api-openapi.js.map +1 -0
- package/build/audio-api.d.ts +69 -190
- package/build/audio-api.js +27 -13
- package/build/audio-api.js.map +1 -1
- package/build/concept-api-openapi.d.ts +1682 -0
- package/build/concept-api-openapi.js +7 -0
- package/build/concept-api-openapi.js.map +1 -0
- package/build/concept-api.d.ts +69 -221
- package/build/concept-api.js +27 -21
- package/build/concept-api.js.map +1 -1
- package/build/draft-api-openapi.d.ts +2893 -0
- package/build/draft-api-openapi.js +7 -0
- package/build/draft-api-openapi.js.map +1 -0
- package/build/draft-api.d.ts +117 -292
- package/build/draft-api.js +27 -13
- package/build/draft-api.js.map +1 -1
- package/build/frontpage-api-openapi.d.ts +800 -0
- package/build/frontpage-api-openapi.js +7 -0
- package/build/frontpage-api-openapi.js.map +1 -0
- package/build/frontpage-api.d.ts +53 -121
- package/build/frontpage-api.js +27 -1
- package/build/frontpage-api.js.map +1 -1
- package/build/image-api-openapi.d.ts +2192 -0
- package/build/image-api-openapi.js +7 -0
- package/build/image-api-openapi.js.map +1 -0
- package/build/image-api.d.ts +61 -174
- package/build/image-api.js +27 -13
- package/build/image-api.js.map +1 -1
- package/build/learningpath-api-openapi.d.ts +2671 -0
- package/build/learningpath-api-openapi.js +7 -0
- package/build/learningpath-api-openapi.js.map +1 -0
- package/build/learningpath-api.d.ts +71 -143
- package/build/learningpath-api.js +27 -1
- package/build/learningpath-api.js.map +1 -1
- package/build/myndla-api-openapi.d.ts +2718 -0
- package/build/myndla-api-openapi.js +7 -0
- package/build/myndla-api-openapi.js.map +1 -0
- package/build/myndla-api.d.ts +69 -115
- package/build/myndla-api.js +27 -1
- package/build/myndla-api.js.map +1 -1
- package/build/oembed-proxy-openapi.d.ts +249 -0
- package/build/oembed-proxy-openapi.js +7 -0
- package/build/oembed-proxy-openapi.js.map +1 -0
- package/build/oembed-proxy.d.ts +15 -0
- package/build/oembed-proxy.js +30 -0
- package/build/oembed-proxy.js.map +1 -0
- package/build/search-api-openapi.d.ts +1525 -0
- package/build/search-api-openapi.js +7 -0
- package/build/search-api-openapi.js.map +1 -0
- package/build/search-api.d.ts +121 -420
- package/build/search-api.js +27 -33
- package/build/search-api.js.map +1 -1
- package/package.json +2 -1
|
@@ -0,0 +1,1092 @@
|
|
|
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
|
+
"/article-api/v2/articles/tag-search": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Fetch tags used in articles.
|
|
15
|
+
* @description Retrieves a list of all previously used tags in articles.
|
|
16
|
+
*/
|
|
17
|
+
get: operations["getArticle-apiV2ArticlesTag-search"];
|
|
18
|
+
put?: never;
|
|
19
|
+
post?: never;
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/article-api/v2/articles/ids": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Fetch articles that matches ids parameter.
|
|
35
|
+
* @description Returns articles that matches ids parameter.
|
|
36
|
+
*/
|
|
37
|
+
get: operations["getArticle-apiV2ArticlesIds"];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/article-api/v2/articles/{slug}/rss.xml": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/** Get RSS feed for articles at a level in the frontpage menu */
|
|
54
|
+
get: operations["getArticle-apiV2ArticlesSlugRss.xml"];
|
|
55
|
+
put?: never;
|
|
56
|
+
post?: never;
|
|
57
|
+
delete?: never;
|
|
58
|
+
options?: never;
|
|
59
|
+
head?: never;
|
|
60
|
+
patch?: never;
|
|
61
|
+
trace?: never;
|
|
62
|
+
};
|
|
63
|
+
"/article-api/v2/articles/{article_id}": {
|
|
64
|
+
parameters: {
|
|
65
|
+
query?: never;
|
|
66
|
+
header?: never;
|
|
67
|
+
path?: never;
|
|
68
|
+
cookie?: never;
|
|
69
|
+
};
|
|
70
|
+
get: operations["getArticle-apiV2ArticlesArticle_id"];
|
|
71
|
+
put?: never;
|
|
72
|
+
post?: never;
|
|
73
|
+
delete?: never;
|
|
74
|
+
options?: never;
|
|
75
|
+
head?: never;
|
|
76
|
+
patch?: never;
|
|
77
|
+
trace?: never;
|
|
78
|
+
};
|
|
79
|
+
"/article-api/v2/articles": {
|
|
80
|
+
parameters: {
|
|
81
|
+
query?: never;
|
|
82
|
+
header?: never;
|
|
83
|
+
path?: never;
|
|
84
|
+
cookie?: never;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* Find published articles.
|
|
88
|
+
* @description Returns all articles. You can search it too.
|
|
89
|
+
*/
|
|
90
|
+
get: operations["getArticle-apiV2Articles"];
|
|
91
|
+
put?: never;
|
|
92
|
+
post?: never;
|
|
93
|
+
delete?: never;
|
|
94
|
+
options?: never;
|
|
95
|
+
head?: never;
|
|
96
|
+
patch?: never;
|
|
97
|
+
trace?: never;
|
|
98
|
+
};
|
|
99
|
+
"/article-api/v2/articles/search": {
|
|
100
|
+
parameters: {
|
|
101
|
+
query?: never;
|
|
102
|
+
header?: never;
|
|
103
|
+
path?: never;
|
|
104
|
+
cookie?: never;
|
|
105
|
+
};
|
|
106
|
+
get?: never;
|
|
107
|
+
put?: never;
|
|
108
|
+
/**
|
|
109
|
+
* Find published articles.
|
|
110
|
+
* @description Search all articles.
|
|
111
|
+
*/
|
|
112
|
+
post: operations["postArticle-apiV2ArticlesSearch"];
|
|
113
|
+
delete?: never;
|
|
114
|
+
options?: never;
|
|
115
|
+
head?: never;
|
|
116
|
+
patch?: never;
|
|
117
|
+
trace?: never;
|
|
118
|
+
};
|
|
119
|
+
"/article-api/v2/articles/{article_id}/revisions": {
|
|
120
|
+
parameters: {
|
|
121
|
+
query?: never;
|
|
122
|
+
header?: never;
|
|
123
|
+
path?: never;
|
|
124
|
+
cookie?: never;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Fetch list of existing revisions for article-id
|
|
128
|
+
* @description Fetch list of existing revisions for article-id
|
|
129
|
+
*/
|
|
130
|
+
get: operations["getArticle-apiV2ArticlesArticle_idRevisions"];
|
|
131
|
+
put?: never;
|
|
132
|
+
post?: never;
|
|
133
|
+
delete?: never;
|
|
134
|
+
options?: never;
|
|
135
|
+
head?: never;
|
|
136
|
+
patch?: never;
|
|
137
|
+
trace?: never;
|
|
138
|
+
};
|
|
139
|
+
"/article-api/v2/articles/external_id/{deprecated_node_id}": {
|
|
140
|
+
parameters: {
|
|
141
|
+
query?: never;
|
|
142
|
+
header?: never;
|
|
143
|
+
path?: never;
|
|
144
|
+
cookie?: never;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Get id of article corresponding to specified deprecated node id.
|
|
148
|
+
* @description Get internal id of article for a specified ndla_node_id.
|
|
149
|
+
*/
|
|
150
|
+
get: operations["getArticle-apiV2ArticlesExternal_idDeprecated_node_id"];
|
|
151
|
+
put?: never;
|
|
152
|
+
post?: never;
|
|
153
|
+
delete?: never;
|
|
154
|
+
options?: never;
|
|
155
|
+
head?: never;
|
|
156
|
+
patch?: never;
|
|
157
|
+
trace?: never;
|
|
158
|
+
};
|
|
159
|
+
"/article-api/v2/articles/external_ids/{deprecated_node_id}": {
|
|
160
|
+
parameters: {
|
|
161
|
+
query?: never;
|
|
162
|
+
header?: never;
|
|
163
|
+
path?: never;
|
|
164
|
+
cookie?: never;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Get all ids related to article corresponding to specified deprecated node id.
|
|
168
|
+
* @description Get internal id as well as all deprecated ndla_node_ids of article for a specified ndla_node_id.
|
|
169
|
+
*/
|
|
170
|
+
get: operations["getArticle-apiV2ArticlesExternal_idsDeprecated_node_id"];
|
|
171
|
+
put?: never;
|
|
172
|
+
post?: never;
|
|
173
|
+
delete?: never;
|
|
174
|
+
options?: never;
|
|
175
|
+
head?: never;
|
|
176
|
+
patch?: never;
|
|
177
|
+
trace?: never;
|
|
178
|
+
};
|
|
179
|
+
};
|
|
180
|
+
export type webhooks = Record<string, never>;
|
|
181
|
+
export type components = {
|
|
182
|
+
schemas: {
|
|
183
|
+
/** AllErrors */
|
|
184
|
+
AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
|
|
185
|
+
/**
|
|
186
|
+
* ArticleContentV2DTO
|
|
187
|
+
* @description The content of the article in available languages
|
|
188
|
+
*/
|
|
189
|
+
ArticleContentV2DTO: {
|
|
190
|
+
/** @description The html content */
|
|
191
|
+
content: string;
|
|
192
|
+
/** @description ISO 639-1 code that represents the language used in the content */
|
|
193
|
+
language: string;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* ArticleIdV2DTO
|
|
197
|
+
* @description Id for a single Article
|
|
198
|
+
*/
|
|
199
|
+
ArticleIdV2DTO: {
|
|
200
|
+
/**
|
|
201
|
+
* Format: int64
|
|
202
|
+
* @description The unique id of the article
|
|
203
|
+
*/
|
|
204
|
+
id: number;
|
|
205
|
+
};
|
|
206
|
+
/** ArticleIdsDTO */
|
|
207
|
+
ArticleIdsDTO: {
|
|
208
|
+
/** Format: int64 */
|
|
209
|
+
articleId: number;
|
|
210
|
+
externalIds: string[];
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* ArticleIntroductionDTO
|
|
214
|
+
* @description An introduction for the article
|
|
215
|
+
*/
|
|
216
|
+
ArticleIntroductionDTO: {
|
|
217
|
+
/** @description The introduction content */
|
|
218
|
+
introduction: string;
|
|
219
|
+
/** @description The html-version introduction content */
|
|
220
|
+
htmlIntroduction: string;
|
|
221
|
+
/** @description The ISO 639-1 language code describing which article translation this introduction belongs to */
|
|
222
|
+
language: string;
|
|
223
|
+
};
|
|
224
|
+
/** ArticleMetaDescriptionDTO */
|
|
225
|
+
ArticleMetaDescriptionDTO: {
|
|
226
|
+
/** @description The meta description */
|
|
227
|
+
metaDescription: string;
|
|
228
|
+
/** @description The ISO 639-1 language code describing which article translation this meta description belongs to */
|
|
229
|
+
language: string;
|
|
230
|
+
};
|
|
231
|
+
/**
|
|
232
|
+
* ArticleMetaImageDTO
|
|
233
|
+
* @description A meta image for the article
|
|
234
|
+
*/
|
|
235
|
+
ArticleMetaImageDTO: {
|
|
236
|
+
/** @description The meta image url */
|
|
237
|
+
url: string;
|
|
238
|
+
/** @description The alt text for the meta image */
|
|
239
|
+
alt: string;
|
|
240
|
+
/** @description The ISO 639-1 language code describing which article translation this meta description belongs to */
|
|
241
|
+
language: string;
|
|
242
|
+
};
|
|
243
|
+
/**
|
|
244
|
+
* ArticleSearchParamsDTO
|
|
245
|
+
* @description The search parameters
|
|
246
|
+
*/
|
|
247
|
+
ArticleSearchParamsDTO: {
|
|
248
|
+
/** @description The search query */
|
|
249
|
+
query?: string;
|
|
250
|
+
/** @description The ISO 639-1 language code describing language used in query-params */
|
|
251
|
+
language?: string;
|
|
252
|
+
/** @description Return only articles with provided license. */
|
|
253
|
+
license?: string;
|
|
254
|
+
/**
|
|
255
|
+
* Format: int32
|
|
256
|
+
* @description The page number of the search hits to display.
|
|
257
|
+
*/
|
|
258
|
+
page?: number;
|
|
259
|
+
/**
|
|
260
|
+
* Format: int32
|
|
261
|
+
* @description The number of search hits to display for each page.
|
|
262
|
+
*/
|
|
263
|
+
pageSize?: number;
|
|
264
|
+
/** @description Return only articles that have one of the provided ids */
|
|
265
|
+
ids?: number[];
|
|
266
|
+
/** @description Return only articles of specific type(s) */
|
|
267
|
+
articleTypes?: string[];
|
|
268
|
+
sort?: components["schemas"]["Sort"];
|
|
269
|
+
/** @description Return all matched articles whether they exist on selected language or not. */
|
|
270
|
+
fallback?: boolean;
|
|
271
|
+
/** @description A search context retrieved from the response header of a previous search. */
|
|
272
|
+
scrollId?: string;
|
|
273
|
+
/** @description A comma separated list of codes from GREP API to filter by. */
|
|
274
|
+
grepCodes?: string[];
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
* ArticleSummaryV2DTO
|
|
278
|
+
* @description Short summary of information about the article
|
|
279
|
+
*/
|
|
280
|
+
ArticleSummaryV2DTO: {
|
|
281
|
+
/**
|
|
282
|
+
* Format: int64
|
|
283
|
+
* @description The unique id of the article
|
|
284
|
+
*/
|
|
285
|
+
id: number;
|
|
286
|
+
/** @description The title of the article */
|
|
287
|
+
title: components["schemas"]["ArticleTitleDTO"];
|
|
288
|
+
visualElement?: components["schemas"]["VisualElementDTO"];
|
|
289
|
+
introduction?: components["schemas"]["ArticleIntroductionDTO"];
|
|
290
|
+
/** @description A metaDescription for the article */
|
|
291
|
+
metaDescription?: components["schemas"]["ArticleMetaDescriptionDTO"];
|
|
292
|
+
metaImage?: components["schemas"]["ArticleMetaImageDTO"];
|
|
293
|
+
/** @description The full url to where the complete information about the article can be found */
|
|
294
|
+
url: string;
|
|
295
|
+
/** @description Describes the license of the article */
|
|
296
|
+
license: string;
|
|
297
|
+
/** @description The type of article this is. Possible values are frontpage-article, standard, topic-article */
|
|
298
|
+
articleType: string;
|
|
299
|
+
/** @description The time when the article was last updated */
|
|
300
|
+
lastUpdated: string;
|
|
301
|
+
/** @description A list of available languages for this article */
|
|
302
|
+
supportedLanguages: string[];
|
|
303
|
+
/** @description A list of codes from GREP API attached to this article */
|
|
304
|
+
grepCodes: string[];
|
|
305
|
+
/** @description Value that dictates who gets to see the article. Possible values are: everyone/teacher */
|
|
306
|
+
availability: string;
|
|
307
|
+
};
|
|
308
|
+
/**
|
|
309
|
+
* ArticleTagDTO
|
|
310
|
+
* @description Searchable tags for the article
|
|
311
|
+
*/
|
|
312
|
+
ArticleTagDTO: {
|
|
313
|
+
/** @description The searchable tag. */
|
|
314
|
+
tags: string[];
|
|
315
|
+
/** @description ISO 639-1 code that represents the language used in tag */
|
|
316
|
+
language: string;
|
|
317
|
+
};
|
|
318
|
+
/** ArticleTitleDTO */
|
|
319
|
+
ArticleTitleDTO: {
|
|
320
|
+
/** @description The freetext title of the article */
|
|
321
|
+
title: string;
|
|
322
|
+
/** @description The freetext html-version title of the article */
|
|
323
|
+
htmlTitle: string;
|
|
324
|
+
/** @description ISO 639-1 code that represents the language used in title */
|
|
325
|
+
language: string;
|
|
326
|
+
};
|
|
327
|
+
/**
|
|
328
|
+
* ArticleV2DTO
|
|
329
|
+
* @description Information about the article
|
|
330
|
+
*/
|
|
331
|
+
ArticleV2DTO: {
|
|
332
|
+
/**
|
|
333
|
+
* Format: int64
|
|
334
|
+
* @description The unique id of the article
|
|
335
|
+
*/
|
|
336
|
+
id: number;
|
|
337
|
+
/** @description Link to article on old platform */
|
|
338
|
+
oldNdlaUrl?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Format: int32
|
|
341
|
+
* @description The revision number for the article
|
|
342
|
+
*/
|
|
343
|
+
revision: number;
|
|
344
|
+
/** @description Available titles for the article */
|
|
345
|
+
title: components["schemas"]["ArticleTitleDTO"];
|
|
346
|
+
content: components["schemas"]["ArticleContentV2DTO"];
|
|
347
|
+
copyright: components["schemas"]["CopyrightDTO"];
|
|
348
|
+
tags: components["schemas"]["ArticleTagDTO"];
|
|
349
|
+
/** @description Required libraries in order to render the article */
|
|
350
|
+
requiredLibraries: components["schemas"]["RequiredLibraryDTO"][];
|
|
351
|
+
visualElement?: components["schemas"]["VisualElementDTO"];
|
|
352
|
+
metaImage?: components["schemas"]["ArticleMetaImageDTO"];
|
|
353
|
+
introduction?: components["schemas"]["ArticleIntroductionDTO"];
|
|
354
|
+
/** @description Meta description for the article */
|
|
355
|
+
metaDescription: components["schemas"]["ArticleMetaDescriptionDTO"];
|
|
356
|
+
/** @description When the article was created */
|
|
357
|
+
created: string;
|
|
358
|
+
/** @description When the article was last updated */
|
|
359
|
+
updated: string;
|
|
360
|
+
/** @description By whom the article was last updated */
|
|
361
|
+
updatedBy: string;
|
|
362
|
+
/** @description When the article was last published */
|
|
363
|
+
published: string;
|
|
364
|
+
/** @description The type of article this is. Possible values are frontpage-article, standard, topic-article */
|
|
365
|
+
articleType: string;
|
|
366
|
+
/** @description The languages this article supports */
|
|
367
|
+
supportedLanguages: string[];
|
|
368
|
+
/** @description A list of codes from GREP API connected to the article */
|
|
369
|
+
grepCodes: string[];
|
|
370
|
+
/** @description A list of conceptIds connected to the article */
|
|
371
|
+
conceptIds: number[];
|
|
372
|
+
/** @description Value that dictates who gets to see the article. Possible values are: everyone/teacher */
|
|
373
|
+
availability: string;
|
|
374
|
+
/** @description A list of content related to the article */
|
|
375
|
+
relatedContent: (components["schemas"]["RelatedContentLinkDTO"] | number)[];
|
|
376
|
+
/** @description The date for the next planned revision which indicates when the article might be outdated */
|
|
377
|
+
revisionDate?: string;
|
|
378
|
+
/** @description The path to the frontpage article */
|
|
379
|
+
slug?: string;
|
|
380
|
+
disclaimer?: components["schemas"]["DisclaimerDTO"];
|
|
381
|
+
};
|
|
382
|
+
/**
|
|
383
|
+
* AuthorDTO
|
|
384
|
+
* @description Information about an author
|
|
385
|
+
*/
|
|
386
|
+
AuthorDTO: {
|
|
387
|
+
type: components["schemas"]["ContributorType"];
|
|
388
|
+
/** @description The name of the of the author */
|
|
389
|
+
name: string;
|
|
390
|
+
};
|
|
391
|
+
/**
|
|
392
|
+
* ContributorType
|
|
393
|
+
* @description The description of the author. Eg. Photographer or Supplier
|
|
394
|
+
* @enum {string}
|
|
395
|
+
*/
|
|
396
|
+
ContributorType: "artist" | "cowriter" | "compiler" | "composer" | "correction" | "director" | "distributor" | "editorial" | "facilitator" | "idea" | "illustrator" | "linguistic" | "originator" | "photographer" | "processor" | "publisher" | "reader" | "rightsholder" | "scriptwriter" | "supplier" | "translator" | "writer";
|
|
397
|
+
/**
|
|
398
|
+
* CopyrightDTO
|
|
399
|
+
* @description Describes the copyright information for the article
|
|
400
|
+
*/
|
|
401
|
+
CopyrightDTO: {
|
|
402
|
+
license: components["schemas"]["LicenseDTO"];
|
|
403
|
+
/** @description Reference to where the article is procured */
|
|
404
|
+
origin?: string;
|
|
405
|
+
/** @description List of creators */
|
|
406
|
+
creators: components["schemas"]["AuthorDTO"][];
|
|
407
|
+
/** @description List of processors */
|
|
408
|
+
processors: components["schemas"]["AuthorDTO"][];
|
|
409
|
+
/** @description List of rightsholders */
|
|
410
|
+
rightsholders: components["schemas"]["AuthorDTO"][];
|
|
411
|
+
/** @description Date from which the copyright is valid */
|
|
412
|
+
validFrom?: string;
|
|
413
|
+
/** @description Date to which the copyright is valid */
|
|
414
|
+
validTo?: string;
|
|
415
|
+
/** @description Whether or not the content has been processed */
|
|
416
|
+
processed: boolean;
|
|
417
|
+
};
|
|
418
|
+
/**
|
|
419
|
+
* DisclaimerDTO
|
|
420
|
+
* @description The disclaimer of the article
|
|
421
|
+
*/
|
|
422
|
+
DisclaimerDTO: {
|
|
423
|
+
/** @description The freetext html content of the disclaimer */
|
|
424
|
+
disclaimer: string;
|
|
425
|
+
/** @description ISO 639-1 code that represents the language used in the disclaimer */
|
|
426
|
+
language: string;
|
|
427
|
+
};
|
|
428
|
+
/**
|
|
429
|
+
* ErrorBody
|
|
430
|
+
* @description Information about an error
|
|
431
|
+
*/
|
|
432
|
+
ErrorBody: {
|
|
433
|
+
/** @description Code stating the type of error */
|
|
434
|
+
code: string;
|
|
435
|
+
/** @description Description of the error */
|
|
436
|
+
description: string;
|
|
437
|
+
/** @description When the error occurred */
|
|
438
|
+
occurredAt: string;
|
|
439
|
+
/**
|
|
440
|
+
* Format: int32
|
|
441
|
+
* @description Numeric http status code
|
|
442
|
+
*/
|
|
443
|
+
statusCode: number;
|
|
444
|
+
};
|
|
445
|
+
/**
|
|
446
|
+
* LicenseDTO
|
|
447
|
+
* @description Describes the license of the article
|
|
448
|
+
*/
|
|
449
|
+
LicenseDTO: {
|
|
450
|
+
/** @description The name of the license */
|
|
451
|
+
license: string;
|
|
452
|
+
/** @description Description of the license */
|
|
453
|
+
description?: string;
|
|
454
|
+
/** @description Url to where the license can be found */
|
|
455
|
+
url?: string;
|
|
456
|
+
};
|
|
457
|
+
/**
|
|
458
|
+
* NotFoundWithSupportedLanguages
|
|
459
|
+
* @description Information about an error
|
|
460
|
+
*/
|
|
461
|
+
NotFoundWithSupportedLanguages: {
|
|
462
|
+
/** @description Code stating the type of error */
|
|
463
|
+
code: string;
|
|
464
|
+
/** @description Description of the error */
|
|
465
|
+
description: string;
|
|
466
|
+
/** @description When the error occurred */
|
|
467
|
+
occurredAt: string;
|
|
468
|
+
/** @description List of supported languages */
|
|
469
|
+
supportedLanguages?: string[];
|
|
470
|
+
/**
|
|
471
|
+
* Format: int32
|
|
472
|
+
* @description Numeric http status code
|
|
473
|
+
*/
|
|
474
|
+
statusCode: number;
|
|
475
|
+
};
|
|
476
|
+
/**
|
|
477
|
+
* RelatedContentLinkDTO
|
|
478
|
+
* @description External link related to the article
|
|
479
|
+
*/
|
|
480
|
+
RelatedContentLinkDTO: {
|
|
481
|
+
/** @description Title of the article */
|
|
482
|
+
title: string;
|
|
483
|
+
/** @description The url to where the article can be viewed */
|
|
484
|
+
url: string;
|
|
485
|
+
};
|
|
486
|
+
/**
|
|
487
|
+
* RequiredLibraryDTO
|
|
488
|
+
* @description Information about a library required to render the article
|
|
489
|
+
*/
|
|
490
|
+
RequiredLibraryDTO: {
|
|
491
|
+
/** @description The type of the library. E.g. CSS or JavaScript */
|
|
492
|
+
mediaType: string;
|
|
493
|
+
/** @description The name of the library */
|
|
494
|
+
name: string;
|
|
495
|
+
/** @description The full url to where the library can be downloaded */
|
|
496
|
+
url: string;
|
|
497
|
+
};
|
|
498
|
+
/**
|
|
499
|
+
* SearchResultV2DTO
|
|
500
|
+
* @description Information about search-results
|
|
501
|
+
*/
|
|
502
|
+
SearchResultV2DTO: {
|
|
503
|
+
/**
|
|
504
|
+
* Format: int64
|
|
505
|
+
* @description The total number of articles matching this query
|
|
506
|
+
*/
|
|
507
|
+
totalCount: number;
|
|
508
|
+
/**
|
|
509
|
+
* Format: int32
|
|
510
|
+
* @description For which page results are shown from
|
|
511
|
+
*/
|
|
512
|
+
page?: number;
|
|
513
|
+
/**
|
|
514
|
+
* Format: int32
|
|
515
|
+
* @description The number of results per page
|
|
516
|
+
*/
|
|
517
|
+
pageSize: number;
|
|
518
|
+
/** @description The chosen search language */
|
|
519
|
+
language: string;
|
|
520
|
+
/** @description The search results */
|
|
521
|
+
results: components["schemas"]["ArticleSummaryV2DTO"][];
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* Sort
|
|
525
|
+
* @description The sorting used on results. Default is by -relevance.
|
|
526
|
+
* @enum {string}
|
|
527
|
+
*/
|
|
528
|
+
Sort: "-relevance" | "relevance" | "-title" | "title" | "-lastUpdated" | "lastUpdated" | "-id" | "id";
|
|
529
|
+
/**
|
|
530
|
+
* TagsSearchResultDTO
|
|
531
|
+
* @description Information about tags-search-results
|
|
532
|
+
*/
|
|
533
|
+
TagsSearchResultDTO: {
|
|
534
|
+
/**
|
|
535
|
+
* Format: int64
|
|
536
|
+
* @description The total number of tags 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: string[];
|
|
553
|
+
};
|
|
554
|
+
/**
|
|
555
|
+
* ValidationErrorBody
|
|
556
|
+
* @description Information about an error
|
|
557
|
+
*/
|
|
558
|
+
ValidationErrorBody: {
|
|
559
|
+
/** @description Code stating the type of error */
|
|
560
|
+
code: string;
|
|
561
|
+
/** @description Description of the error */
|
|
562
|
+
description: string;
|
|
563
|
+
/** @description When the error occurred */
|
|
564
|
+
occurredAt: string;
|
|
565
|
+
/** @description List of validation messages */
|
|
566
|
+
messages?: components["schemas"]["ValidationMessage"][];
|
|
567
|
+
/**
|
|
568
|
+
* Format: int32
|
|
569
|
+
* @description Numeric http status code
|
|
570
|
+
*/
|
|
571
|
+
statusCode: number;
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* ValidationMessage
|
|
575
|
+
* @description A message describing a validation error on a specific field
|
|
576
|
+
*/
|
|
577
|
+
ValidationMessage: {
|
|
578
|
+
/** @description The field the error occured in */
|
|
579
|
+
field: string;
|
|
580
|
+
/** @description The validation message */
|
|
581
|
+
message: string;
|
|
582
|
+
};
|
|
583
|
+
/**
|
|
584
|
+
* VisualElementDTO
|
|
585
|
+
* @description A visual element article
|
|
586
|
+
*/
|
|
587
|
+
VisualElementDTO: {
|
|
588
|
+
/** @description Html containing the visual element. May contain any legal html element, including the embed-tag */
|
|
589
|
+
visualElement: string;
|
|
590
|
+
/** @description The ISO 639-1 language code describing which article translation this visual element belongs to */
|
|
591
|
+
language: string;
|
|
592
|
+
};
|
|
593
|
+
};
|
|
594
|
+
responses: never;
|
|
595
|
+
parameters: never;
|
|
596
|
+
requestBodies: never;
|
|
597
|
+
headers: never;
|
|
598
|
+
pathItems: never;
|
|
599
|
+
};
|
|
600
|
+
export type $defs = Record<string, never>;
|
|
601
|
+
export interface operations {
|
|
602
|
+
"getArticle-apiV2ArticlesTag-search": {
|
|
603
|
+
parameters: {
|
|
604
|
+
query?: {
|
|
605
|
+
/** @description Return only articles with content matching the specified query. */
|
|
606
|
+
query?: string;
|
|
607
|
+
/** @description The number of search hits to display for each page. */
|
|
608
|
+
"page-size"?: number;
|
|
609
|
+
/** @description The page number of the search hits to display. */
|
|
610
|
+
page?: number;
|
|
611
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
612
|
+
language?: string;
|
|
613
|
+
};
|
|
614
|
+
header?: never;
|
|
615
|
+
path?: never;
|
|
616
|
+
cookie?: never;
|
|
617
|
+
};
|
|
618
|
+
requestBody?: never;
|
|
619
|
+
responses: {
|
|
620
|
+
200: {
|
|
621
|
+
headers: {
|
|
622
|
+
[name: string]: unknown;
|
|
623
|
+
};
|
|
624
|
+
content: {
|
|
625
|
+
"application/json": components["schemas"]["TagsSearchResultDTO"];
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
400: {
|
|
629
|
+
headers: {
|
|
630
|
+
[name: string]: unknown;
|
|
631
|
+
};
|
|
632
|
+
content: {
|
|
633
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
634
|
+
};
|
|
635
|
+
};
|
|
636
|
+
404: {
|
|
637
|
+
headers: {
|
|
638
|
+
[name: string]: unknown;
|
|
639
|
+
};
|
|
640
|
+
content: {
|
|
641
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
642
|
+
};
|
|
643
|
+
};
|
|
644
|
+
500: {
|
|
645
|
+
headers: {
|
|
646
|
+
[name: string]: unknown;
|
|
647
|
+
};
|
|
648
|
+
content: {
|
|
649
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
650
|
+
};
|
|
651
|
+
};
|
|
652
|
+
};
|
|
653
|
+
};
|
|
654
|
+
"getArticle-apiV2ArticlesIds": {
|
|
655
|
+
parameters: {
|
|
656
|
+
query?: {
|
|
657
|
+
/** @description Return only articles that have one of the provided ids. To provide multiple ids, separate by comma (,). */
|
|
658
|
+
ids?: number[];
|
|
659
|
+
/** @description Fallback to existing language if language is specified. */
|
|
660
|
+
fallback?: boolean;
|
|
661
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
662
|
+
language?: string;
|
|
663
|
+
/** @description The number of search hits to display for each page. */
|
|
664
|
+
"page-size"?: number;
|
|
665
|
+
/** @description The page number of the search hits to display. */
|
|
666
|
+
page?: number;
|
|
667
|
+
};
|
|
668
|
+
header?: {
|
|
669
|
+
/** @description Header containing FEIDE access token. */
|
|
670
|
+
FeideAuthorization?: string;
|
|
671
|
+
};
|
|
672
|
+
path?: never;
|
|
673
|
+
cookie?: never;
|
|
674
|
+
};
|
|
675
|
+
requestBody?: never;
|
|
676
|
+
responses: {
|
|
677
|
+
200: {
|
|
678
|
+
headers: {
|
|
679
|
+
[name: string]: unknown;
|
|
680
|
+
};
|
|
681
|
+
content: {
|
|
682
|
+
"application/json": components["schemas"]["ArticleV2DTO"][];
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
400: {
|
|
686
|
+
headers: {
|
|
687
|
+
[name: string]: unknown;
|
|
688
|
+
};
|
|
689
|
+
content: {
|
|
690
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
691
|
+
};
|
|
692
|
+
};
|
|
693
|
+
404: {
|
|
694
|
+
headers: {
|
|
695
|
+
[name: string]: unknown;
|
|
696
|
+
};
|
|
697
|
+
content: {
|
|
698
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
500: {
|
|
702
|
+
headers: {
|
|
703
|
+
[name: string]: unknown;
|
|
704
|
+
};
|
|
705
|
+
content: {
|
|
706
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
707
|
+
};
|
|
708
|
+
};
|
|
709
|
+
};
|
|
710
|
+
};
|
|
711
|
+
"getArticle-apiV2ArticlesSlugRss.xml": {
|
|
712
|
+
parameters: {
|
|
713
|
+
query?: never;
|
|
714
|
+
header?: never;
|
|
715
|
+
path: {
|
|
716
|
+
/** @description Slug of the article to generate RSS for */
|
|
717
|
+
slug: string;
|
|
718
|
+
};
|
|
719
|
+
cookie?: never;
|
|
720
|
+
};
|
|
721
|
+
requestBody?: never;
|
|
722
|
+
responses: {
|
|
723
|
+
200: {
|
|
724
|
+
headers: {
|
|
725
|
+
[name: string]: unknown;
|
|
726
|
+
};
|
|
727
|
+
content: {
|
|
728
|
+
"text/plain": string;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
400: {
|
|
732
|
+
headers: {
|
|
733
|
+
[name: string]: unknown;
|
|
734
|
+
};
|
|
735
|
+
content: {
|
|
736
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
404: {
|
|
740
|
+
headers: {
|
|
741
|
+
[name: string]: unknown;
|
|
742
|
+
};
|
|
743
|
+
content: {
|
|
744
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
745
|
+
};
|
|
746
|
+
};
|
|
747
|
+
410: {
|
|
748
|
+
headers: {
|
|
749
|
+
[name: string]: unknown;
|
|
750
|
+
};
|
|
751
|
+
content: {
|
|
752
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
500: {
|
|
756
|
+
headers: {
|
|
757
|
+
[name: string]: unknown;
|
|
758
|
+
};
|
|
759
|
+
content: {
|
|
760
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
761
|
+
};
|
|
762
|
+
};
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
"getArticle-apiV2ArticlesArticle_id": {
|
|
766
|
+
parameters: {
|
|
767
|
+
query?: {
|
|
768
|
+
/** @description Revision of article to fetch. If not provided the current revision is returned. */
|
|
769
|
+
revision?: number;
|
|
770
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
771
|
+
language?: string;
|
|
772
|
+
/** @description Fallback to existing language if language is specified. */
|
|
773
|
+
fallback?: boolean;
|
|
774
|
+
};
|
|
775
|
+
header?: {
|
|
776
|
+
/** @description Header containing FEIDE access token. */
|
|
777
|
+
FeideAuthorization?: string;
|
|
778
|
+
};
|
|
779
|
+
path: {
|
|
780
|
+
/** @description Id or slug of the article that is to be fetched. */
|
|
781
|
+
article_id: string;
|
|
782
|
+
};
|
|
783
|
+
cookie?: never;
|
|
784
|
+
};
|
|
785
|
+
requestBody?: never;
|
|
786
|
+
responses: {
|
|
787
|
+
200: {
|
|
788
|
+
headers: {
|
|
789
|
+
[name: string]: unknown;
|
|
790
|
+
};
|
|
791
|
+
content: {
|
|
792
|
+
"application/json": components["schemas"]["ArticleV2DTO"];
|
|
793
|
+
};
|
|
794
|
+
};
|
|
795
|
+
400: {
|
|
796
|
+
headers: {
|
|
797
|
+
[name: string]: unknown;
|
|
798
|
+
};
|
|
799
|
+
content: {
|
|
800
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
801
|
+
};
|
|
802
|
+
};
|
|
803
|
+
404: {
|
|
804
|
+
headers: {
|
|
805
|
+
[name: string]: unknown;
|
|
806
|
+
};
|
|
807
|
+
content: {
|
|
808
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
410: {
|
|
812
|
+
headers: {
|
|
813
|
+
[name: string]: unknown;
|
|
814
|
+
};
|
|
815
|
+
content: {
|
|
816
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
500: {
|
|
820
|
+
headers: {
|
|
821
|
+
[name: string]: unknown;
|
|
822
|
+
};
|
|
823
|
+
content: {
|
|
824
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
825
|
+
};
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
};
|
|
829
|
+
"getArticle-apiV2Articles": {
|
|
830
|
+
parameters: {
|
|
831
|
+
query?: {
|
|
832
|
+
/** @description Return only articles with content matching the specified query. */
|
|
833
|
+
query?: string;
|
|
834
|
+
/** @description Return only articles of specific type(s). To provide multiple types, separate by comma (,). */
|
|
835
|
+
articleTypes?: string[];
|
|
836
|
+
/** @description Return only articles that have one of the provided ids. To provide multiple ids, separate by comma (,). */
|
|
837
|
+
ids?: number[];
|
|
838
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
839
|
+
language?: string;
|
|
840
|
+
/** @description Return only results with provided license. Specifying 'all' gives all articles regardless of licence. */
|
|
841
|
+
license?: string;
|
|
842
|
+
/** @description The page number of the search hits to display. */
|
|
843
|
+
page?: number;
|
|
844
|
+
/** @description The number of search hits to display for each page. */
|
|
845
|
+
"page-size"?: number;
|
|
846
|
+
/** @description The sorting used on results.
|
|
847
|
+
* The following are supported: -relevance, relevance, -title, title, -lastUpdated, lastUpdated, -id, id.
|
|
848
|
+
* Default is by -relevance (desc) when query is set, and id (asc) when query is empty. */
|
|
849
|
+
sort?: string;
|
|
850
|
+
/** @description Fallback to existing language if language is specified. */
|
|
851
|
+
fallback?: boolean;
|
|
852
|
+
/** @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].
|
|
853
|
+
* When scrolling, the parameters from the initial search is used, except in the case of 'language' and 'fallback'.
|
|
854
|
+
* This value may change between scrolls. Always use the one in the latest scroll result (The context, if unused, dies after 1m).
|
|
855
|
+
* If you are not paginating past 10000 hits, you can ignore this and use 'page' and 'page-size' instead.
|
|
856
|
+
* */
|
|
857
|
+
"search-context"?: string;
|
|
858
|
+
/** @description A comma separated list of codes from GREP API the resources should be filtered by. */
|
|
859
|
+
"grep-codes"?: string[];
|
|
860
|
+
};
|
|
861
|
+
header?: {
|
|
862
|
+
/** @description Header containing FEIDE access token. */
|
|
863
|
+
FeideAuthorization?: string;
|
|
864
|
+
};
|
|
865
|
+
path?: never;
|
|
866
|
+
cookie?: never;
|
|
867
|
+
};
|
|
868
|
+
requestBody?: never;
|
|
869
|
+
responses: {
|
|
870
|
+
200: {
|
|
871
|
+
headers: {
|
|
872
|
+
[name: string]: unknown;
|
|
873
|
+
};
|
|
874
|
+
content: {
|
|
875
|
+
"application/json": components["schemas"]["SearchResultV2DTO"];
|
|
876
|
+
};
|
|
877
|
+
};
|
|
878
|
+
400: {
|
|
879
|
+
headers: {
|
|
880
|
+
[name: string]: unknown;
|
|
881
|
+
};
|
|
882
|
+
content: {
|
|
883
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
884
|
+
};
|
|
885
|
+
};
|
|
886
|
+
404: {
|
|
887
|
+
headers: {
|
|
888
|
+
[name: string]: unknown;
|
|
889
|
+
};
|
|
890
|
+
content: {
|
|
891
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
892
|
+
};
|
|
893
|
+
};
|
|
894
|
+
500: {
|
|
895
|
+
headers: {
|
|
896
|
+
[name: string]: unknown;
|
|
897
|
+
};
|
|
898
|
+
content: {
|
|
899
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
900
|
+
};
|
|
901
|
+
};
|
|
902
|
+
};
|
|
903
|
+
};
|
|
904
|
+
"postArticle-apiV2ArticlesSearch": {
|
|
905
|
+
parameters: {
|
|
906
|
+
query?: never;
|
|
907
|
+
header?: {
|
|
908
|
+
/** @description Header containing FEIDE access token. */
|
|
909
|
+
FeideAuthorization?: string;
|
|
910
|
+
};
|
|
911
|
+
path?: never;
|
|
912
|
+
cookie?: never;
|
|
913
|
+
};
|
|
914
|
+
requestBody: {
|
|
915
|
+
content: {
|
|
916
|
+
"application/json": components["schemas"]["ArticleSearchParamsDTO"];
|
|
917
|
+
};
|
|
918
|
+
};
|
|
919
|
+
responses: {
|
|
920
|
+
200: {
|
|
921
|
+
headers: {
|
|
922
|
+
[name: string]: unknown;
|
|
923
|
+
};
|
|
924
|
+
content: {
|
|
925
|
+
"application/json": components["schemas"]["SearchResultV2DTO"];
|
|
926
|
+
};
|
|
927
|
+
};
|
|
928
|
+
400: {
|
|
929
|
+
headers: {
|
|
930
|
+
[name: string]: unknown;
|
|
931
|
+
};
|
|
932
|
+
content: {
|
|
933
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
934
|
+
};
|
|
935
|
+
};
|
|
936
|
+
404: {
|
|
937
|
+
headers: {
|
|
938
|
+
[name: string]: unknown;
|
|
939
|
+
};
|
|
940
|
+
content: {
|
|
941
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
500: {
|
|
945
|
+
headers: {
|
|
946
|
+
[name: string]: unknown;
|
|
947
|
+
};
|
|
948
|
+
content: {
|
|
949
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
950
|
+
};
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
};
|
|
954
|
+
"getArticle-apiV2ArticlesArticle_idRevisions": {
|
|
955
|
+
parameters: {
|
|
956
|
+
query?: never;
|
|
957
|
+
header?: never;
|
|
958
|
+
path: {
|
|
959
|
+
/** @description Id or slug of the article that is to be fetched. */
|
|
960
|
+
article_id: number;
|
|
961
|
+
};
|
|
962
|
+
cookie?: never;
|
|
963
|
+
};
|
|
964
|
+
requestBody?: never;
|
|
965
|
+
responses: {
|
|
966
|
+
200: {
|
|
967
|
+
headers: {
|
|
968
|
+
[name: string]: unknown;
|
|
969
|
+
};
|
|
970
|
+
content: {
|
|
971
|
+
"application/json": number[];
|
|
972
|
+
};
|
|
973
|
+
};
|
|
974
|
+
400: {
|
|
975
|
+
headers: {
|
|
976
|
+
[name: string]: unknown;
|
|
977
|
+
};
|
|
978
|
+
content: {
|
|
979
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
404: {
|
|
983
|
+
headers: {
|
|
984
|
+
[name: string]: unknown;
|
|
985
|
+
};
|
|
986
|
+
content: {
|
|
987
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
988
|
+
};
|
|
989
|
+
};
|
|
990
|
+
500: {
|
|
991
|
+
headers: {
|
|
992
|
+
[name: string]: unknown;
|
|
993
|
+
};
|
|
994
|
+
content: {
|
|
995
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
996
|
+
};
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
"getArticle-apiV2ArticlesExternal_idDeprecated_node_id": {
|
|
1001
|
+
parameters: {
|
|
1002
|
+
query?: never;
|
|
1003
|
+
header?: never;
|
|
1004
|
+
path: {
|
|
1005
|
+
/** @description Id of deprecated NDLA node */
|
|
1006
|
+
deprecated_node_id: string;
|
|
1007
|
+
};
|
|
1008
|
+
cookie?: never;
|
|
1009
|
+
};
|
|
1010
|
+
requestBody?: never;
|
|
1011
|
+
responses: {
|
|
1012
|
+
200: {
|
|
1013
|
+
headers: {
|
|
1014
|
+
[name: string]: unknown;
|
|
1015
|
+
};
|
|
1016
|
+
content: {
|
|
1017
|
+
"application/json": components["schemas"]["ArticleIdV2DTO"];
|
|
1018
|
+
};
|
|
1019
|
+
};
|
|
1020
|
+
400: {
|
|
1021
|
+
headers: {
|
|
1022
|
+
[name: string]: unknown;
|
|
1023
|
+
};
|
|
1024
|
+
content: {
|
|
1025
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1026
|
+
};
|
|
1027
|
+
};
|
|
1028
|
+
404: {
|
|
1029
|
+
headers: {
|
|
1030
|
+
[name: string]: unknown;
|
|
1031
|
+
};
|
|
1032
|
+
content: {
|
|
1033
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
500: {
|
|
1037
|
+
headers: {
|
|
1038
|
+
[name: string]: unknown;
|
|
1039
|
+
};
|
|
1040
|
+
content: {
|
|
1041
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
};
|
|
1045
|
+
};
|
|
1046
|
+
"getArticle-apiV2ArticlesExternal_idsDeprecated_node_id": {
|
|
1047
|
+
parameters: {
|
|
1048
|
+
query?: never;
|
|
1049
|
+
header?: never;
|
|
1050
|
+
path: {
|
|
1051
|
+
/** @description Id of deprecated NDLA node */
|
|
1052
|
+
deprecated_node_id: string;
|
|
1053
|
+
};
|
|
1054
|
+
cookie?: never;
|
|
1055
|
+
};
|
|
1056
|
+
requestBody?: never;
|
|
1057
|
+
responses: {
|
|
1058
|
+
200: {
|
|
1059
|
+
headers: {
|
|
1060
|
+
[name: string]: unknown;
|
|
1061
|
+
};
|
|
1062
|
+
content: {
|
|
1063
|
+
"application/json": components["schemas"]["ArticleIdsDTO"];
|
|
1064
|
+
};
|
|
1065
|
+
};
|
|
1066
|
+
400: {
|
|
1067
|
+
headers: {
|
|
1068
|
+
[name: string]: unknown;
|
|
1069
|
+
};
|
|
1070
|
+
content: {
|
|
1071
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1072
|
+
};
|
|
1073
|
+
};
|
|
1074
|
+
404: {
|
|
1075
|
+
headers: {
|
|
1076
|
+
[name: string]: unknown;
|
|
1077
|
+
};
|
|
1078
|
+
content: {
|
|
1079
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1080
|
+
};
|
|
1081
|
+
};
|
|
1082
|
+
500: {
|
|
1083
|
+
headers: {
|
|
1084
|
+
[name: string]: unknown;
|
|
1085
|
+
};
|
|
1086
|
+
content: {
|
|
1087
|
+
"application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
|
|
1088
|
+
};
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
1091
|
+
};
|
|
1092
|
+
}
|