@ndla/types-backend 1.0.105 → 1.0.107
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 +80 -0
- package/build/concept-api.d.ts +16 -0
- package/build/image-api.d.ts +14 -2
- package/package.json +1 -1
- package/build/image-api-openapi.d.ts +0 -2262
- package/build/image-api-openapi.js +0 -3
- package/build/image-api-openapi.js.map +0 -1
- package/build/myndla-api-openapi.d.ts +0 -3840
- package/build/myndla-api-openapi.js +0 -3
- package/build/myndla-api-openapi.js.map +0 -1
package/build/article-api.d.ts
CHANGED
|
@@ -172,6 +172,26 @@ export type paths = {
|
|
|
172
172
|
patch?: never;
|
|
173
173
|
trace?: never;
|
|
174
174
|
};
|
|
175
|
+
"/article-api/v2/articles/{article_id}/revision-history": {
|
|
176
|
+
parameters: {
|
|
177
|
+
query?: never;
|
|
178
|
+
header?: never;
|
|
179
|
+
path?: never;
|
|
180
|
+
cookie?: never;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Get the revision history for an article
|
|
184
|
+
* @description Get an object that describes the revision history for a specific article
|
|
185
|
+
*/
|
|
186
|
+
get: operations["getArticle-apiV2ArticlesArticle_idRevision-history"];
|
|
187
|
+
put?: never;
|
|
188
|
+
post?: never;
|
|
189
|
+
delete?: never;
|
|
190
|
+
options?: never;
|
|
191
|
+
head?: never;
|
|
192
|
+
patch?: never;
|
|
193
|
+
trace?: never;
|
|
194
|
+
};
|
|
175
195
|
};
|
|
176
196
|
export type webhooks = Record<string, never>;
|
|
177
197
|
export type components = {
|
|
@@ -236,6 +256,14 @@ export type components = {
|
|
|
236
256
|
/** @description The ISO 639-1 language code describing which article translation this meta description belongs to */
|
|
237
257
|
language: string;
|
|
238
258
|
};
|
|
259
|
+
/**
|
|
260
|
+
* ArticleRevisionHistoryDTO
|
|
261
|
+
* @description Information about article revision history
|
|
262
|
+
*/
|
|
263
|
+
ArticleRevisionHistoryDTO: {
|
|
264
|
+
/** @description The revisions of an article, with the latest revision being the first in the list */
|
|
265
|
+
revision: components["schemas"]["ArticleV2DTO"][];
|
|
266
|
+
};
|
|
239
267
|
/**
|
|
240
268
|
* ArticleSearchParamsDTO
|
|
241
269
|
* @description The search parameters
|
|
@@ -609,6 +637,7 @@ export type ArticleIdsDTO = components['schemas']['ArticleIdsDTO'];
|
|
|
609
637
|
export type ArticleIntroductionDTO = components['schemas']['ArticleIntroductionDTO'];
|
|
610
638
|
export type ArticleMetaDescriptionDTO = components['schemas']['ArticleMetaDescriptionDTO'];
|
|
611
639
|
export type ArticleMetaImageDTO = components['schemas']['ArticleMetaImageDTO'];
|
|
640
|
+
export type ArticleRevisionHistoryDTO = components['schemas']['ArticleRevisionHistoryDTO'];
|
|
612
641
|
export type ArticleSearchParamsDTO = components['schemas']['ArticleSearchParamsDTO'];
|
|
613
642
|
export type ArticleSummaryV2DTO = components['schemas']['ArticleSummaryV2DTO'];
|
|
614
643
|
export type ArticleTagDTO = components['schemas']['ArticleTagDTO'];
|
|
@@ -1129,4 +1158,55 @@ export interface operations {
|
|
|
1129
1158
|
};
|
|
1130
1159
|
};
|
|
1131
1160
|
};
|
|
1161
|
+
"getArticle-apiV2ArticlesArticle_idRevision-history": {
|
|
1162
|
+
parameters: {
|
|
1163
|
+
query?: {
|
|
1164
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
1165
|
+
language?: string;
|
|
1166
|
+
/** @description Fallback to existing language if language is specified. */
|
|
1167
|
+
fallback?: boolean;
|
|
1168
|
+
};
|
|
1169
|
+
header?: never;
|
|
1170
|
+
path: {
|
|
1171
|
+
/** @description Id or slug of the article that is to be fetched. */
|
|
1172
|
+
article_id: number;
|
|
1173
|
+
};
|
|
1174
|
+
cookie?: never;
|
|
1175
|
+
};
|
|
1176
|
+
requestBody?: never;
|
|
1177
|
+
responses: {
|
|
1178
|
+
200: {
|
|
1179
|
+
headers: {
|
|
1180
|
+
[name: string]: unknown;
|
|
1181
|
+
};
|
|
1182
|
+
content: {
|
|
1183
|
+
"application/json": components["schemas"]["ArticleRevisionHistoryDTO"];
|
|
1184
|
+
};
|
|
1185
|
+
};
|
|
1186
|
+
400: {
|
|
1187
|
+
headers: {
|
|
1188
|
+
[name: string]: unknown;
|
|
1189
|
+
};
|
|
1190
|
+
content: {
|
|
1191
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
404: {
|
|
1195
|
+
headers: {
|
|
1196
|
+
[name: string]: unknown;
|
|
1197
|
+
};
|
|
1198
|
+
content: {
|
|
1199
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
500: {
|
|
1203
|
+
headers: {
|
|
1204
|
+
[name: string]: unknown;
|
|
1205
|
+
};
|
|
1206
|
+
content: {
|
|
1207
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
1208
|
+
};
|
|
1209
|
+
};
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1132
1212
|
}
|
package/build/concept-api.d.ts
CHANGED
|
@@ -1111,6 +1111,14 @@ export interface operations {
|
|
|
1111
1111
|
"application/json": components["schemas"]["AllErrors"];
|
|
1112
1112
|
};
|
|
1113
1113
|
};
|
|
1114
|
+
401: {
|
|
1115
|
+
headers: {
|
|
1116
|
+
[name: string]: unknown;
|
|
1117
|
+
};
|
|
1118
|
+
content: {
|
|
1119
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1120
|
+
};
|
|
1121
|
+
};
|
|
1114
1122
|
403: {
|
|
1115
1123
|
headers: {
|
|
1116
1124
|
[name: string]: unknown;
|
|
@@ -1385,6 +1393,14 @@ export interface operations {
|
|
|
1385
1393
|
"application/json": components["schemas"]["AllErrors"];
|
|
1386
1394
|
};
|
|
1387
1395
|
};
|
|
1396
|
+
401: {
|
|
1397
|
+
headers: {
|
|
1398
|
+
[name: string]: unknown;
|
|
1399
|
+
};
|
|
1400
|
+
content: {
|
|
1401
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
1402
|
+
};
|
|
1403
|
+
};
|
|
1388
1404
|
403: {
|
|
1389
1405
|
headers: {
|
|
1390
1406
|
[name: string]: unknown;
|
package/build/image-api.d.ts
CHANGED
|
@@ -442,6 +442,11 @@ export type components = {
|
|
|
442
442
|
/** @description ISO 639-1 code that represents the language used in the caption */
|
|
443
443
|
language: string;
|
|
444
444
|
};
|
|
445
|
+
/**
|
|
446
|
+
* ImageContentType
|
|
447
|
+
* @enum {string}
|
|
448
|
+
*/
|
|
449
|
+
ImageContentType: "image/bmp" | "image/gif" | "image/jpeg" | "image/x-citrix-jpeg" | "image/pjpeg" | "image/png" | "image/x-png" | "image/svg+xml" | "image/webp";
|
|
445
450
|
/**
|
|
446
451
|
* ImageDimensionsDTO
|
|
447
452
|
* @description Dimensions of the image
|
|
@@ -471,7 +476,7 @@ export type components = {
|
|
|
471
476
|
*/
|
|
472
477
|
size: number;
|
|
473
478
|
/** @description The mimetype of the image */
|
|
474
|
-
contentType:
|
|
479
|
+
contentType: components["schemas"]["ImageContentType"];
|
|
475
480
|
/** @description The full url to where the image can be downloaded */
|
|
476
481
|
imageUrl: string;
|
|
477
482
|
dimensions?: components["schemas"]["ImageDimensionsDTO"];
|
|
@@ -501,7 +506,7 @@ export type components = {
|
|
|
501
506
|
*/
|
|
502
507
|
size: number;
|
|
503
508
|
/** @description The mimetype of the image */
|
|
504
|
-
contentType:
|
|
509
|
+
contentType: components["schemas"]["ImageContentType"];
|
|
505
510
|
copyright: components["schemas"]["CopyrightDTO"];
|
|
506
511
|
tags: components["schemas"]["ImageTagDTO"];
|
|
507
512
|
/** @description Searchable caption for the image */
|
|
@@ -738,6 +743,8 @@ export type components = {
|
|
|
738
743
|
* @description Filter images with height less than or equal to this value.
|
|
739
744
|
*/
|
|
740
745
|
heightTo?: number;
|
|
746
|
+
/** @description Filter images by content type (e.g., 'image/jpeg', 'image/png'). */
|
|
747
|
+
contentType?: components["schemas"]["ImageContentType"];
|
|
741
748
|
};
|
|
742
749
|
/**
|
|
743
750
|
* SearchResultDTO
|
|
@@ -892,6 +899,7 @@ export type EditorNoteDTO = components['schemas']['EditorNoteDTO'];
|
|
|
892
899
|
export type ErrorBody = components['schemas']['ErrorBody'];
|
|
893
900
|
export type ImageAltTextDTO = components['schemas']['ImageAltTextDTO'];
|
|
894
901
|
export type ImageCaptionDTO = components['schemas']['ImageCaptionDTO'];
|
|
902
|
+
export type ImageContentType = components['schemas']['ImageContentType'];
|
|
895
903
|
export type ImageDimensionsDTO = components['schemas']['ImageDimensionsDTO'];
|
|
896
904
|
export type ImageFileDTO = components['schemas']['ImageFileDTO'];
|
|
897
905
|
export type ImageMetaInformationV2DTO = components['schemas']['ImageMetaInformationV2DTO'];
|
|
@@ -960,6 +968,8 @@ export interface operations {
|
|
|
960
968
|
"height-from"?: number;
|
|
961
969
|
/** @description Filter images with height less than or equal to this value. */
|
|
962
970
|
"height-to"?: number;
|
|
971
|
+
/** @description Filter images by content type (e.g., 'image/jpeg', 'image/png'). */
|
|
972
|
+
"content-type"?: string;
|
|
963
973
|
};
|
|
964
974
|
header?: never;
|
|
965
975
|
path?: never;
|
|
@@ -1542,6 +1552,8 @@ export interface operations {
|
|
|
1542
1552
|
"height-from"?: number;
|
|
1543
1553
|
/** @description Filter images with height less than or equal to this value. */
|
|
1544
1554
|
"height-to"?: number;
|
|
1555
|
+
/** @description Filter images by content type (e.g., 'image/jpeg', 'image/png'). */
|
|
1556
|
+
"content-type"?: string;
|
|
1545
1557
|
};
|
|
1546
1558
|
header?: never;
|
|
1547
1559
|
path?: never;
|