@ndla/types-backend 1.0.72 → 1.0.74
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 +9 -0
- package/build/article-api.d.ts +2 -0
- package/build/draft-api-openapi.d.ts +9 -0
- package/build/draft-api.d.ts +2 -0
- package/build/myndla-api-openapi.d.ts +0 -8
- package/build/search-api-openapi.d.ts +8 -8
- package/build/search-api.d.ts +2 -2
- package/package.json +1 -1
|
@@ -300,6 +300,8 @@ export type components = {
|
|
|
300
300
|
grepCodes: string[];
|
|
301
301
|
/** @description Value that dictates who gets to see the article. Possible values are: everyone/teacher */
|
|
302
302
|
availability: string;
|
|
303
|
+
/** @description Traits extracted from the article content */
|
|
304
|
+
traits: components["schemas"]["ArticleTrait"][];
|
|
303
305
|
};
|
|
304
306
|
/**
|
|
305
307
|
* ArticleTagDTO
|
|
@@ -320,6 +322,11 @@ export type components = {
|
|
|
320
322
|
/** @description ISO 639-1 code that represents the language used in title */
|
|
321
323
|
language: string;
|
|
322
324
|
};
|
|
325
|
+
/**
|
|
326
|
+
* ArticleTrait
|
|
327
|
+
* @enum {string}
|
|
328
|
+
*/
|
|
329
|
+
ArticleTrait: "VIDEO" | "H5P" | "AUDIO" | "PODCAST";
|
|
323
330
|
/**
|
|
324
331
|
* ArticleV2DTO
|
|
325
332
|
* @description Information about the article
|
|
@@ -374,6 +381,8 @@ export type components = {
|
|
|
374
381
|
/** @description The path to the frontpage article */
|
|
375
382
|
slug?: string;
|
|
376
383
|
disclaimer?: components["schemas"]["DisclaimerDTO"];
|
|
384
|
+
/** @description Traits extracted from the article content */
|
|
385
|
+
traits: components["schemas"]["ArticleTrait"][];
|
|
377
386
|
};
|
|
378
387
|
/**
|
|
379
388
|
* AuthorDTO
|
package/build/article-api.d.ts
CHANGED
|
@@ -23,6 +23,8 @@ export type ArticleTagDTO = schemas["ArticleTagDTO"];
|
|
|
23
23
|
export type IArticleTagDTO = schemas["ArticleTagDTO"];
|
|
24
24
|
export type ArticleTitleDTO = schemas["ArticleTitleDTO"];
|
|
25
25
|
export type IArticleTitleDTO = schemas["ArticleTitleDTO"];
|
|
26
|
+
export type ArticleTrait = schemas["ArticleTrait"];
|
|
27
|
+
export type IArticleTrait = schemas["ArticleTrait"];
|
|
26
28
|
export type ArticleV2DTO = schemas["ArticleV2DTO"];
|
|
27
29
|
export type IArticleV2DTO = schemas["ArticleV2DTO"];
|
|
28
30
|
export type AuthorDTO = schemas["AuthorDTO"];
|
|
@@ -599,6 +599,8 @@ export type components = {
|
|
|
599
599
|
started: boolean;
|
|
600
600
|
qualityEvaluation?: components["schemas"]["QualityEvaluationDTO"];
|
|
601
601
|
disclaimer?: components["schemas"]["DisclaimerDTO"];
|
|
602
|
+
/** @description Traits extracted from the article content */
|
|
603
|
+
traits: components["schemas"]["ArticleTrait"][];
|
|
602
604
|
};
|
|
603
605
|
/**
|
|
604
606
|
* ArticleIntroductionDTO
|
|
@@ -733,6 +735,8 @@ export type components = {
|
|
|
733
735
|
status: components["schemas"]["StatusDTO"];
|
|
734
736
|
/** @description When the article was last updated */
|
|
735
737
|
updated: string;
|
|
738
|
+
/** @description Traits extracted from the article content */
|
|
739
|
+
traits: components["schemas"]["ArticleTrait"][];
|
|
736
740
|
};
|
|
737
741
|
/**
|
|
738
742
|
* ArticleTagDTO
|
|
@@ -753,6 +757,11 @@ export type components = {
|
|
|
753
757
|
/** @description ISO 639-1 code that represents the language used in title */
|
|
754
758
|
language: string;
|
|
755
759
|
};
|
|
760
|
+
/**
|
|
761
|
+
* ArticleTrait
|
|
762
|
+
* @enum {string}
|
|
763
|
+
*/
|
|
764
|
+
ArticleTrait: "VIDEO" | "H5P" | "AUDIO" | "PODCAST";
|
|
756
765
|
/**
|
|
757
766
|
* AuthorDTO
|
|
758
767
|
* @description Information about an author
|
package/build/draft-api.d.ts
CHANGED
|
@@ -29,6 +29,8 @@ export type ArticleTagDTO = schemas["ArticleTagDTO"];
|
|
|
29
29
|
export type IArticleTagDTO = schemas["ArticleTagDTO"];
|
|
30
30
|
export type ArticleTitleDTO = schemas["ArticleTitleDTO"];
|
|
31
31
|
export type IArticleTitleDTO = schemas["ArticleTitleDTO"];
|
|
32
|
+
export type ArticleTrait = schemas["ArticleTrait"];
|
|
33
|
+
export type IArticleTrait = schemas["ArticleTrait"];
|
|
32
34
|
export type AuthorDTO = schemas["AuthorDTO"];
|
|
33
35
|
export type IAuthorDTO = schemas["AuthorDTO"];
|
|
34
36
|
export type CommentDTO = schemas["CommentDTO"];
|
|
@@ -701,10 +701,6 @@ export type components = {
|
|
|
701
701
|
groups: components["schemas"]["MyNDLAGroupDTO"][];
|
|
702
702
|
/** @description Whether arena is explicitly enabled for the user */
|
|
703
703
|
arenaEnabled: boolean;
|
|
704
|
-
/** @description Whether the user has accepted the use of arena */
|
|
705
|
-
arenaAccepted: boolean;
|
|
706
|
-
/** @description Whether the user has accepted the sharing of their name */
|
|
707
|
-
shareNameAccepted: boolean;
|
|
708
704
|
};
|
|
709
705
|
/** NewFolderDTO */
|
|
710
706
|
NewFolderDTO: {
|
|
@@ -907,10 +903,6 @@ export type components = {
|
|
|
907
903
|
favoriteSubjects?: string[];
|
|
908
904
|
/** @description Whether arena should explicitly be enabled for the user */
|
|
909
905
|
arenaEnabled?: boolean;
|
|
910
|
-
/** @description Whether the user has accepted the use of arena */
|
|
911
|
-
arenaAccepted?: boolean;
|
|
912
|
-
/** @description Whether the user has accepted the sharing of their name */
|
|
913
|
-
shareNameAccepted?: boolean;
|
|
914
906
|
};
|
|
915
907
|
/** UpdatedResourceDTO */
|
|
916
908
|
UpdatedResourceDTO: {
|
|
@@ -163,6 +163,11 @@ export type components = {
|
|
|
163
163
|
/** @description Unique url for this context. */
|
|
164
164
|
url: string;
|
|
165
165
|
};
|
|
166
|
+
/**
|
|
167
|
+
* ArticleTrait
|
|
168
|
+
* @enum {string}
|
|
169
|
+
*/
|
|
170
|
+
ArticleTrait: "VIDEO" | "H5P" | "AUDIO" | "PODCAST";
|
|
166
171
|
/**
|
|
167
172
|
* CommentDTO
|
|
168
173
|
* @description Information about a comment attached to an article
|
|
@@ -244,7 +249,7 @@ export type components = {
|
|
|
244
249
|
/** @description A list of codes from GREP API the resources should be filtered by. */
|
|
245
250
|
grepCodes?: string[];
|
|
246
251
|
/** @description A comma separated list of traits the resources should be filtered by. */
|
|
247
|
-
traits?: components["schemas"]["
|
|
252
|
+
traits?: components["schemas"]["ArticleTrait"][];
|
|
248
253
|
/** @description List of index-paths that should be term-aggregated and returned in result. */
|
|
249
254
|
aggregatePaths?: string[];
|
|
250
255
|
/** @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. */
|
|
@@ -606,7 +611,7 @@ export type components = {
|
|
|
606
611
|
learningResourceType: components["schemas"]["LearningResourceType"];
|
|
607
612
|
status?: components["schemas"]["StatusDTO"];
|
|
608
613
|
/** @description Traits for the resource */
|
|
609
|
-
traits: components["schemas"]["
|
|
614
|
+
traits: components["schemas"]["ArticleTrait"][];
|
|
610
615
|
/**
|
|
611
616
|
* Format: float
|
|
612
617
|
* @description Relevance score. The higher the score, the better the document matches your search criteria.
|
|
@@ -787,7 +792,7 @@ export type components = {
|
|
|
787
792
|
/** @description A list of codes from GREP API the resources should be filtered by. */
|
|
788
793
|
grepCodes?: string[];
|
|
789
794
|
/** @description A comma separated list of traits the resources should be filtered by. */
|
|
790
|
-
traits?: components["schemas"]["
|
|
795
|
+
traits?: components["schemas"]["ArticleTrait"][];
|
|
791
796
|
/** @description List of index-paths that should be term-aggregated and returned in result. */
|
|
792
797
|
aggregatePaths?: string[];
|
|
793
798
|
/** @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. */
|
|
@@ -821,11 +826,6 @@ export type components = {
|
|
|
821
826
|
/** @description The list of suggest options for the field */
|
|
822
827
|
options: components["schemas"]["SuggestOptionDTO"][];
|
|
823
828
|
};
|
|
824
|
-
/**
|
|
825
|
-
* SearchTrait
|
|
826
|
-
* @enum {string}
|
|
827
|
-
*/
|
|
828
|
-
SearchTrait: "VIDEO" | "H5P" | "AUDIO" | "PODCAST";
|
|
829
829
|
/**
|
|
830
830
|
* SearchType
|
|
831
831
|
* @enum {string}
|
package/build/search-api.d.ts
CHANGED
|
@@ -5,6 +5,8 @@ export type AllErrors = schemas["AllErrors"];
|
|
|
5
5
|
export type IAllErrors = schemas["AllErrors"];
|
|
6
6
|
export type ApiTaxonomyContextDTO = schemas["ApiTaxonomyContextDTO"];
|
|
7
7
|
export type IApiTaxonomyContextDTO = schemas["ApiTaxonomyContextDTO"];
|
|
8
|
+
export type ArticleTrait = schemas["ArticleTrait"];
|
|
9
|
+
export type IArticleTrait = schemas["ArticleTrait"];
|
|
8
10
|
export type CommentDTO = schemas["CommentDTO"];
|
|
9
11
|
export type ICommentDTO = schemas["CommentDTO"];
|
|
10
12
|
export type DescriptionDTO = schemas["DescriptionDTO"];
|
|
@@ -93,8 +95,6 @@ export type SearchParamsDTO = schemas["SearchParamsDTO"];
|
|
|
93
95
|
export type ISearchParamsDTO = schemas["SearchParamsDTO"];
|
|
94
96
|
export type SearchSuggestionDTO = schemas["SearchSuggestionDTO"];
|
|
95
97
|
export type ISearchSuggestionDTO = schemas["SearchSuggestionDTO"];
|
|
96
|
-
export type SearchTrait = schemas["SearchTrait"];
|
|
97
|
-
export type ISearchTrait = schemas["SearchTrait"];
|
|
98
98
|
export type SearchType = schemas["SearchType"];
|
|
99
99
|
export type ISearchType = schemas["SearchType"];
|
|
100
100
|
export type Sort = schemas["Sort"];
|
package/package.json
CHANGED
|
@@ -32,6 +32,6 @@
|
|
|
32
32
|
"tsx": "^4.19.3",
|
|
33
33
|
"typescript": "^5.3.3"
|
|
34
34
|
},
|
|
35
|
-
"version": "1.0.
|
|
35
|
+
"version": "1.0.74",
|
|
36
36
|
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
|
|
37
37
|
}
|