@ndla/types-backend 1.0.103 → 1.0.105

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 (57) hide show
  1. package/build/article-api.d.ts +1132 -31
  2. package/build/article-api.js +0 -37
  3. package/build/article-api.js.map +1 -1
  4. package/build/audio-api.d.ts +2178 -36
  5. package/build/audio-api.js +0 -37
  6. package/build/audio-api.js.map +1 -1
  7. package/build/concept-api.d.ts +1657 -34
  8. package/build/concept-api.js +0 -37
  9. package/build/concept-api.js.map +1 -1
  10. package/build/draft-api.d.ts +3193 -57
  11. package/build/draft-api.js +0 -37
  12. package/build/draft-api.js.map +1 -1
  13. package/build/frontpage-api.d.ts +998 -27
  14. package/build/frontpage-api.js +0 -37
  15. package/build/frontpage-api.js.map +1 -1
  16. package/build/image-api.d.ts +2293 -34
  17. package/build/image-api.js +0 -37
  18. package/build/image-api.js.map +1 -1
  19. package/build/learningpath-api.d.ts +3092 -43
  20. package/build/learningpath-api.js +0 -37
  21. package/build/learningpath-api.js.map +1 -1
  22. package/build/myndla-api.d.ts +3880 -43
  23. package/build/myndla-api.js +0 -37
  24. package/build/myndla-api.js.map +1 -1
  25. package/build/oembed-proxy.d.ts +251 -9
  26. package/build/oembed-proxy.js +0 -37
  27. package/build/oembed-proxy.js.map +1 -1
  28. package/build/scripts/generate-openapi.js +5 -12
  29. package/build/scripts/generate-openapi.js.map +1 -1
  30. package/build/search-api.d.ts +1645 -66
  31. package/build/search-api.js +0 -37
  32. package/build/search-api.js.map +1 -1
  33. package/package.json +2 -2
  34. package/build/article-api-openapi.d.ts +0 -1104
  35. package/build/article-api-openapi.js +0 -3
  36. package/build/article-api-openapi.js.map +0 -1
  37. package/build/audio-api-openapi.d.ts +0 -2145
  38. package/build/audio-api-openapi.js +0 -3
  39. package/build/audio-api-openapi.js.map +0 -1
  40. package/build/concept-api-openapi.d.ts +0 -1626
  41. package/build/concept-api-openapi.js +0 -3
  42. package/build/concept-api-openapi.js.map +0 -1
  43. package/build/draft-api-openapi.d.ts +0 -3139
  44. package/build/draft-api-openapi.js +0 -3
  45. package/build/draft-api-openapi.js.map +0 -1
  46. package/build/frontpage-api-openapi.d.ts +0 -974
  47. package/build/frontpage-api-openapi.js +0 -3
  48. package/build/frontpage-api-openapi.js.map +0 -1
  49. package/build/learningpath-api-openapi.d.ts +0 -3052
  50. package/build/learningpath-api-openapi.js +0 -3
  51. package/build/learningpath-api-openapi.js.map +0 -1
  52. package/build/oembed-proxy-openapi.d.ts +0 -245
  53. package/build/oembed-proxy-openapi.js +0 -3
  54. package/build/oembed-proxy-openapi.js.map +0 -1
  55. package/build/search-api-openapi.d.ts +0 -1582
  56. package/build/search-api-openapi.js +0 -3
  57. package/build/search-api-openapi.js.map +0 -1
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=learningpath-api-openapi.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"learningpath-api-openapi.js","sourceRoot":"","sources":["../learningpath-api-openapi.ts"],"names":[],"mappings":""}
@@ -1,245 +0,0 @@
1
- export type paths = {
2
- "/oembed-proxy/v1/oembed": {
3
- parameters: {
4
- query?: never;
5
- header?: never;
6
- path?: never;
7
- cookie?: never;
8
- };
9
- /**
10
- * Returns oEmbed information for a given url.
11
- * @description Returns oEmbed information for a given url.
12
- */
13
- get: operations["getOembed-proxyV1Oembed"];
14
- put?: never;
15
- post?: never;
16
- delete?: never;
17
- options?: never;
18
- head?: never;
19
- patch?: never;
20
- trace?: never;
21
- };
22
- };
23
- export type webhooks = Record<string, never>;
24
- export type components = {
25
- schemas: {
26
- /** AllErrors */
27
- AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
28
- /**
29
- * ErrorBody
30
- * @description Information about an error
31
- */
32
- ErrorBody: {
33
- /** @description Code stating the type of error */
34
- code: string;
35
- /** @description Description of the error */
36
- description: string;
37
- /** @description When the error occurred */
38
- occurredAt: string;
39
- /**
40
- * Format: int32
41
- * @description Numeric http status code
42
- */
43
- statusCode: number;
44
- };
45
- /**
46
- * NotFoundWithSupportedLanguages
47
- * @description Information about an error
48
- */
49
- NotFoundWithSupportedLanguages: {
50
- /** @description Code stating the type of error */
51
- code: string;
52
- /** @description Description of the error */
53
- description: string;
54
- /** @description When the error occurred */
55
- occurredAt: string;
56
- /** @description List of supported languages */
57
- supportedLanguages?: string[];
58
- /**
59
- * Format: int32
60
- * @description Numeric http status code
61
- */
62
- statusCode: number;
63
- };
64
- /**
65
- * OEmbedDTO
66
- * @description oEmbed information for an url.
67
- */
68
- OEmbedDTO: {
69
- /** @description The resource type */
70
- type: string;
71
- /** @description The oEmbed version number. This must be 1.0. */
72
- version: string;
73
- /** @description A text title, describing the resource. */
74
- title?: string;
75
- /** @description A text description, describing the resource. Not standard. */
76
- description?: string;
77
- /** @description The name of the author/owner of the resource. */
78
- authorName?: string;
79
- /** @description A URL for the author/owner of the resource. */
80
- authorUrl?: string;
81
- /** @description The name of the resource provider. */
82
- providerName?: string;
83
- /** @description The url of the resource provider. */
84
- providerUrl?: string;
85
- /**
86
- * Format: int64
87
- * @description The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
88
- */
89
- cacheAge?: number;
90
- /** @description A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present. */
91
- thumbnailUrl?: string;
92
- /**
93
- * Format: int64
94
- * @description The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
95
- */
96
- thumbnailWidth?: number;
97
- /**
98
- * Format: int64
99
- * @description The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
100
- */
101
- thumbnailHeight?: number;
102
- /** @description The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid. Required if type is photo. */
103
- url?: string;
104
- /**
105
- * Format: int64
106
- * @description The width in pixels. Required if type is photo/video/rich
107
- */
108
- width?: number;
109
- /**
110
- * Format: int64
111
- * @description The height in pixels. Required if type is photo/video/rich
112
- */
113
- height?: number;
114
- /** @description The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. Required if type is video/rich. */
115
- html?: string;
116
- };
117
- /**
118
- * ValidationErrorBody
119
- * @description Information about an error
120
- */
121
- ValidationErrorBody: {
122
- /** @description Code stating the type of error */
123
- code: string;
124
- /** @description Description of the error */
125
- description: string;
126
- /** @description When the error occurred */
127
- occurredAt: string;
128
- /** @description List of validation messages */
129
- messages?: components["schemas"]["ValidationMessage"][];
130
- /**
131
- * Format: int32
132
- * @description Numeric http status code
133
- */
134
- statusCode: number;
135
- };
136
- /**
137
- * ValidationMessage
138
- * @description A message describing a validation error on a specific field
139
- */
140
- ValidationMessage: {
141
- /** @description The field the error occured in */
142
- field: string;
143
- /** @description The validation message */
144
- message: string;
145
- };
146
- };
147
- responses: never;
148
- parameters: never;
149
- requestBodies: never;
150
- headers: never;
151
- pathItems: never;
152
- };
153
- export type $defs = Record<string, never>;
154
- export interface operations {
155
- "getOembed-proxyV1Oembed": {
156
- parameters: {
157
- query: {
158
- /** @description The URL to retrieve embedding information for */
159
- url: string;
160
- /** @description The maximum width of the embedded resource */
161
- maxwidth?: string;
162
- /** @description The maximum height of the embedded resource */
163
- maxheight?: string;
164
- };
165
- header?: never;
166
- path?: never;
167
- cookie?: never;
168
- };
169
- requestBody?: never;
170
- responses: {
171
- 200: {
172
- headers: {
173
- [name: string]: unknown;
174
- };
175
- content: {
176
- "application/json": components["schemas"]["OEmbedDTO"];
177
- };
178
- };
179
- 400: {
180
- headers: {
181
- [name: string]: unknown;
182
- };
183
- content: {
184
- "application/json": components["schemas"]["AllErrors"];
185
- };
186
- };
187
- 401: {
188
- headers: {
189
- [name: string]: unknown;
190
- };
191
- content: {
192
- "application/json": components["schemas"]["AllErrors"];
193
- };
194
- };
195
- 403: {
196
- headers: {
197
- [name: string]: unknown;
198
- };
199
- content: {
200
- "application/json": components["schemas"]["AllErrors"];
201
- };
202
- };
203
- 404: {
204
- headers: {
205
- [name: string]: unknown;
206
- };
207
- content: {
208
- "application/json": components["schemas"]["AllErrors"];
209
- };
210
- };
211
- 410: {
212
- headers: {
213
- [name: string]: unknown;
214
- };
215
- content: {
216
- "application/json": components["schemas"]["AllErrors"];
217
- };
218
- };
219
- 422: {
220
- headers: {
221
- [name: string]: unknown;
222
- };
223
- content: {
224
- "application/json": components["schemas"]["AllErrors"];
225
- };
226
- };
227
- 500: {
228
- headers: {
229
- [name: string]: unknown;
230
- };
231
- content: {
232
- "application/json": components["schemas"]["ErrorBody"];
233
- };
234
- };
235
- 502: {
236
- headers: {
237
- [name: string]: unknown;
238
- };
239
- content: {
240
- "application/json": components["schemas"]["AllErrors"];
241
- };
242
- };
243
- };
244
- };
245
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=oembed-proxy-openapi.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"oembed-proxy-openapi.js","sourceRoot":"","sources":["../oembed-proxy-openapi.ts"],"names":[],"mappings":""}