@ndla/types-backend 1.0.106 → 1.0.108

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/build/article-api.d.ts +119 -15
  2. package/build/audio-api.d.ts +190 -38
  3. package/build/concept-api.d.ts +52 -28
  4. package/build/draft-api.d.ts +112 -56
  5. package/build/frontpage-api.d.ts +54 -22
  6. package/build/image-api.d.ts +76 -44
  7. package/build/learningpath-api.d.ts +125 -53
  8. package/build/myndla-api.d.ts +97 -97
  9. package/build/oembed-proxy.d.ts +3 -3
  10. package/build/search-api.d.ts +16 -16
  11. package/package.json +1 -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'];
@@ -674,12 +703,12 @@ export interface operations {
674
703
  "application/json": components["schemas"]["AllErrors"];
675
704
  };
676
705
  };
677
- 500: {
706
+ default: {
678
707
  headers: {
679
708
  [name: string]: unknown;
680
709
  };
681
710
  content: {
682
- "application/json": components["schemas"]["ErrorBody"];
711
+ "application/json": components["schemas"]["AllErrors"];
683
712
  };
684
713
  };
685
714
  };
@@ -728,12 +757,12 @@ export interface operations {
728
757
  "application/json": components["schemas"]["AllErrors"];
729
758
  };
730
759
  };
731
- 500: {
760
+ default: {
732
761
  headers: {
733
762
  [name: string]: unknown;
734
763
  };
735
764
  content: {
736
- "application/json": components["schemas"]["ErrorBody"];
765
+ "application/json": components["schemas"]["AllErrors"];
737
766
  };
738
767
  };
739
768
  };
@@ -782,12 +811,12 @@ export interface operations {
782
811
  "application/json": components["schemas"]["AllErrors"];
783
812
  };
784
813
  };
785
- 500: {
814
+ default: {
786
815
  headers: {
787
816
  [name: string]: unknown;
788
817
  };
789
818
  content: {
790
- "application/json": components["schemas"]["ErrorBody"];
819
+ "application/json": components["schemas"]["AllErrors"];
791
820
  };
792
821
  };
793
822
  };
@@ -859,12 +888,12 @@ export interface operations {
859
888
  "application/json": components["schemas"]["AllErrors"];
860
889
  };
861
890
  };
862
- 500: {
891
+ default: {
863
892
  headers: {
864
893
  [name: string]: unknown;
865
894
  };
866
895
  content: {
867
- "application/json": components["schemas"]["ErrorBody"];
896
+ "application/json": components["schemas"]["AllErrors"];
868
897
  };
869
898
  };
870
899
  };
@@ -934,12 +963,12 @@ export interface operations {
934
963
  "application/json": components["schemas"]["AllErrors"];
935
964
  };
936
965
  };
937
- 500: {
966
+ default: {
938
967
  headers: {
939
968
  [name: string]: unknown;
940
969
  };
941
970
  content: {
942
- "application/json": components["schemas"]["ErrorBody"];
971
+ "application/json": components["schemas"]["AllErrors"];
943
972
  };
944
973
  };
945
974
  };
@@ -981,12 +1010,12 @@ export interface operations {
981
1010
  "application/json": components["schemas"]["AllErrors"];
982
1011
  };
983
1012
  };
984
- 500: {
1013
+ default: {
985
1014
  headers: {
986
1015
  [name: string]: unknown;
987
1016
  };
988
1017
  content: {
989
- "application/json": components["schemas"]["ErrorBody"];
1018
+ "application/json": components["schemas"]["AllErrors"];
990
1019
  };
991
1020
  };
992
1021
  };
@@ -1032,7 +1061,15 @@ export interface operations {
1032
1061
  [name: string]: unknown;
1033
1062
  };
1034
1063
  content: {
1035
- "application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
1064
+ "application/json": components["schemas"]["AllErrors"];
1065
+ };
1066
+ };
1067
+ default: {
1068
+ headers: {
1069
+ [name: string]: unknown;
1070
+ };
1071
+ content: {
1072
+ "application/json": components["schemas"]["AllErrors"];
1036
1073
  };
1037
1074
  };
1038
1075
  };
@@ -1078,7 +1115,15 @@ export interface operations {
1078
1115
  [name: string]: unknown;
1079
1116
  };
1080
1117
  content: {
1081
- "application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
1118
+ "application/json": components["schemas"]["AllErrors"];
1119
+ };
1120
+ };
1121
+ default: {
1122
+ headers: {
1123
+ [name: string]: unknown;
1124
+ };
1125
+ content: {
1126
+ "application/json": components["schemas"]["AllErrors"];
1082
1127
  };
1083
1128
  };
1084
1129
  };
@@ -1124,7 +1169,66 @@ export interface operations {
1124
1169
  [name: string]: unknown;
1125
1170
  };
1126
1171
  content: {
1127
- "application/json": components["schemas"]["AllErrors"] | components["schemas"]["ErrorBody"];
1172
+ "application/json": components["schemas"]["AllErrors"];
1173
+ };
1174
+ };
1175
+ default: {
1176
+ headers: {
1177
+ [name: string]: unknown;
1178
+ };
1179
+ content: {
1180
+ "application/json": components["schemas"]["AllErrors"];
1181
+ };
1182
+ };
1183
+ };
1184
+ };
1185
+ "getArticle-apiV2ArticlesArticle_idRevision-history": {
1186
+ parameters: {
1187
+ query?: {
1188
+ /** @description The ISO 639-1 language code describing language. */
1189
+ language?: string;
1190
+ /** @description Fallback to existing language if language is specified. */
1191
+ fallback?: boolean;
1192
+ };
1193
+ header?: never;
1194
+ path: {
1195
+ /** @description Id or slug of the article that is to be fetched. */
1196
+ article_id: number;
1197
+ };
1198
+ cookie?: never;
1199
+ };
1200
+ requestBody?: never;
1201
+ responses: {
1202
+ 200: {
1203
+ headers: {
1204
+ [name: string]: unknown;
1205
+ };
1206
+ content: {
1207
+ "application/json": components["schemas"]["ArticleRevisionHistoryDTO"];
1208
+ };
1209
+ };
1210
+ 400: {
1211
+ headers: {
1212
+ [name: string]: unknown;
1213
+ };
1214
+ content: {
1215
+ "application/json": components["schemas"]["AllErrors"];
1216
+ };
1217
+ };
1218
+ 404: {
1219
+ headers: {
1220
+ [name: string]: unknown;
1221
+ };
1222
+ content: {
1223
+ "application/json": components["schemas"]["AllErrors"];
1224
+ };
1225
+ };
1226
+ default: {
1227
+ headers: {
1228
+ [name: string]: unknown;
1229
+ };
1230
+ content: {
1231
+ "application/json": components["schemas"]["AllErrors"];
1128
1232
  };
1129
1233
  };
1130
1234
  };