@ndla/types-backend 1.0.35 → 1.0.37
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.
|
@@ -281,8 +281,6 @@ export type components = {
|
|
|
281
281
|
copyright?: components["schemas"]["DraftCopyrightDTO"];
|
|
282
282
|
/** @description URL for the source of the concept */
|
|
283
283
|
source?: string;
|
|
284
|
-
/** @description A meta image for the concept */
|
|
285
|
-
metaImage?: components["schemas"]["ConceptMetaImageDTO"];
|
|
286
284
|
tags?: components["schemas"]["ConceptTagsDTO"];
|
|
287
285
|
/** @description When the concept was created */
|
|
288
286
|
created: string;
|
|
@@ -302,15 +300,6 @@ export type components = {
|
|
|
302
300
|
/** @description Describes the changes made to the concept, only visible to editors */
|
|
303
301
|
editorNotes?: components["schemas"]["EditorNoteDTO"][];
|
|
304
302
|
};
|
|
305
|
-
/** ConceptMetaImageDTO */
|
|
306
|
-
ConceptMetaImageDTO: {
|
|
307
|
-
/** @description The meta image url */
|
|
308
|
-
url: string;
|
|
309
|
-
/** @description The alt text for the meta image */
|
|
310
|
-
alt: string;
|
|
311
|
-
/** @description The ISO 639-1 language code describing which concept translation this meta image belongs to */
|
|
312
|
-
language: string;
|
|
313
|
-
};
|
|
314
303
|
/**
|
|
315
304
|
* ConceptResponsibleDTO
|
|
316
305
|
* @description Object with data representing the editor responsible for this concept
|
|
@@ -400,8 +389,6 @@ export type components = {
|
|
|
400
389
|
title: components["schemas"]["ConceptTitleDTO"];
|
|
401
390
|
/** @description The content of the concept in available languages */
|
|
402
391
|
content: components["schemas"]["ConceptContent"];
|
|
403
|
-
/** @description The metaImage of the concept */
|
|
404
|
-
metaImage: components["schemas"]["ConceptMetaImageDTO"];
|
|
405
392
|
tags?: components["schemas"]["ConceptTagsDTO"];
|
|
406
393
|
/** @description All available languages of the current concept */
|
|
407
394
|
supportedLanguages: string[];
|
|
@@ -626,8 +613,6 @@ export type components = {
|
|
|
626
613
|
content?: string;
|
|
627
614
|
/** @description Describes the copyright information for the concept */
|
|
628
615
|
copyright?: components["schemas"]["DraftCopyrightDTO"];
|
|
629
|
-
/** @description An image-api ID for the concept meta image */
|
|
630
|
-
metaImage?: components["schemas"]["NewConceptMetaImageDTO"];
|
|
631
616
|
/** @description A list of searchable tags */
|
|
632
617
|
tags?: string[];
|
|
633
618
|
/** @description A visual element for the concept. May be anything from an image to a video or H5P */
|
|
@@ -638,13 +623,6 @@ export type components = {
|
|
|
638
623
|
conceptType: string;
|
|
639
624
|
glossData?: components["schemas"]["GlossDataDTO"];
|
|
640
625
|
};
|
|
641
|
-
/** NewConceptMetaImageDTO */
|
|
642
|
-
NewConceptMetaImageDTO: {
|
|
643
|
-
/** @description The image-api id of the meta image */
|
|
644
|
-
id: string;
|
|
645
|
-
/** @description The alt text of the meta image */
|
|
646
|
-
alt: string;
|
|
647
|
-
};
|
|
648
626
|
/**
|
|
649
627
|
* NotFoundWithSupportedLanguages
|
|
650
628
|
* @description Information about an error
|
|
@@ -726,7 +704,6 @@ export type components = {
|
|
|
726
704
|
title?: string;
|
|
727
705
|
/** @description The content of the concept */
|
|
728
706
|
content?: string;
|
|
729
|
-
metaImage?: components["schemas"]["NewConceptMetaImageDTO"] | null;
|
|
730
707
|
/** @description Describes the copyright information for the concept */
|
|
731
708
|
copyright?: components["schemas"]["DraftCopyrightDTO"];
|
|
732
709
|
/** @description A list of searchable tags */
|
package/build/concept-api.d.ts
CHANGED
|
@@ -9,8 +9,6 @@ export type ConceptContent = schemas["ConceptContent"];
|
|
|
9
9
|
export type IConceptContent = schemas["ConceptContent"];
|
|
10
10
|
export type ConceptDTO = schemas["ConceptDTO"];
|
|
11
11
|
export type IConceptDTO = schemas["ConceptDTO"];
|
|
12
|
-
export type ConceptMetaImageDTO = schemas["ConceptMetaImageDTO"];
|
|
13
|
-
export type IConceptMetaImageDTO = schemas["ConceptMetaImageDTO"];
|
|
14
12
|
export type ConceptResponsibleDTO = schemas["ConceptResponsibleDTO"];
|
|
15
13
|
export type IConceptResponsibleDTO = schemas["ConceptResponsibleDTO"];
|
|
16
14
|
export type ConceptSearchParamsDTO = schemas["ConceptSearchParamsDTO"];
|
|
@@ -47,8 +45,6 @@ export type MultiSearchTermsAggregationDTO = schemas["MultiSearchTermsAggregatio
|
|
|
47
45
|
export type IMultiSearchTermsAggregationDTO = schemas["MultiSearchTermsAggregationDTO"];
|
|
48
46
|
export type NewConceptDTO = schemas["NewConceptDTO"];
|
|
49
47
|
export type INewConceptDTO = schemas["NewConceptDTO"];
|
|
50
|
-
export type NewConceptMetaImageDTO = schemas["NewConceptMetaImageDTO"];
|
|
51
|
-
export type INewConceptMetaImageDTO = schemas["NewConceptMetaImageDTO"];
|
|
52
48
|
export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
|
|
53
49
|
export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
|
|
54
50
|
export type Sort = schemas["Sort"];
|
|
@@ -2547,7 +2547,7 @@ export interface operations {
|
|
|
2547
2547
|
};
|
|
2548
2548
|
header?: never;
|
|
2549
2549
|
path: {
|
|
2550
|
-
/** @description Slug of the article that is to be
|
|
2550
|
+
/** @description Slug of the article that is to be fetched. */
|
|
2551
2551
|
slug: string;
|
|
2552
2552
|
};
|
|
2553
2553
|
cookie?: never;
|
|
@@ -56,6 +56,26 @@ export type paths = {
|
|
|
56
56
|
patch: operations["patchFrontpage-apiV1SubjectpageSubjectpage-id"];
|
|
57
57
|
trace?: never;
|
|
58
58
|
};
|
|
59
|
+
"/frontpage-api/v1/subjectpage/{subjectpage-id}/language/{language}": {
|
|
60
|
+
parameters: {
|
|
61
|
+
query?: never;
|
|
62
|
+
header?: never;
|
|
63
|
+
path?: never;
|
|
64
|
+
cookie?: never;
|
|
65
|
+
};
|
|
66
|
+
get?: never;
|
|
67
|
+
put?: never;
|
|
68
|
+
post?: never;
|
|
69
|
+
/**
|
|
70
|
+
* Delete language from subject page
|
|
71
|
+
* @description Delete language from subject page
|
|
72
|
+
*/
|
|
73
|
+
delete: operations["deleteFrontpage-apiV1SubjectpageSubjectpage-idLanguageLanguage"];
|
|
74
|
+
options?: never;
|
|
75
|
+
head?: never;
|
|
76
|
+
patch?: never;
|
|
77
|
+
trace?: never;
|
|
78
|
+
};
|
|
59
79
|
"/frontpage-api/v1/frontpage": {
|
|
60
80
|
parameters: {
|
|
61
81
|
query?: never;
|
|
@@ -92,6 +112,26 @@ export type paths = {
|
|
|
92
112
|
patch?: never;
|
|
93
113
|
trace?: never;
|
|
94
114
|
};
|
|
115
|
+
"/frontpage-api/v1/filmfrontpage/language/{language}": {
|
|
116
|
+
parameters: {
|
|
117
|
+
query?: never;
|
|
118
|
+
header?: never;
|
|
119
|
+
path?: never;
|
|
120
|
+
cookie?: never;
|
|
121
|
+
};
|
|
122
|
+
get?: never;
|
|
123
|
+
put?: never;
|
|
124
|
+
post?: never;
|
|
125
|
+
/**
|
|
126
|
+
* Delete language from film front page
|
|
127
|
+
* @description Delete language from film front page
|
|
128
|
+
*/
|
|
129
|
+
delete: operations["deleteFrontpage-apiV1FilmfrontpageLanguageLanguage"];
|
|
130
|
+
options?: never;
|
|
131
|
+
head?: never;
|
|
132
|
+
patch?: never;
|
|
133
|
+
trace?: never;
|
|
134
|
+
};
|
|
95
135
|
};
|
|
96
136
|
export type webhooks = Record<string, never>;
|
|
97
137
|
export type components = {
|
|
@@ -144,6 +184,7 @@ export type components = {
|
|
|
144
184
|
movieThemes: components["schemas"]["MovieThemeDTO"][];
|
|
145
185
|
slideShow: string[];
|
|
146
186
|
article?: string;
|
|
187
|
+
supportedLanguages: string[];
|
|
147
188
|
};
|
|
148
189
|
/**
|
|
149
190
|
* FrontPageDTO
|
|
@@ -332,9 +373,13 @@ export interface operations {
|
|
|
332
373
|
"getFrontpage-apiV1Subjectpage": {
|
|
333
374
|
parameters: {
|
|
334
375
|
query?: {
|
|
376
|
+
/** @description The page number of the search hits to display. */
|
|
335
377
|
page?: number;
|
|
378
|
+
/** @description The number of search hits to display for each page. */
|
|
336
379
|
"page-size"?: number;
|
|
380
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
337
381
|
language?: string;
|
|
382
|
+
/** @description Fallback to existing language if language is specified. */
|
|
338
383
|
fallback?: boolean;
|
|
339
384
|
};
|
|
340
385
|
header?: never;
|
|
@@ -427,10 +472,15 @@ export interface operations {
|
|
|
427
472
|
"getFrontpage-apiV1SubjectpageIds": {
|
|
428
473
|
parameters: {
|
|
429
474
|
query?: {
|
|
475
|
+
/** @description Return only subject pages that have one of the provided ids. To provide multiple ids, separate by comma (,). */
|
|
430
476
|
ids?: number[];
|
|
477
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
431
478
|
language?: string;
|
|
479
|
+
/** @description Fallback to existing language if language is specified. */
|
|
432
480
|
fallback?: boolean;
|
|
481
|
+
/** @description The number of search hits to display for each page. */
|
|
433
482
|
"page-size"?: number;
|
|
483
|
+
/** @description The page number of the search hits to display. */
|
|
434
484
|
page?: number;
|
|
435
485
|
};
|
|
436
486
|
header?: never;
|
|
@@ -476,7 +526,9 @@ export interface operations {
|
|
|
476
526
|
"getFrontpage-apiV1SubjectpageSubjectpage-id": {
|
|
477
527
|
parameters: {
|
|
478
528
|
query?: {
|
|
529
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
479
530
|
language?: string;
|
|
531
|
+
/** @description Fallback to existing language if language is specified. */
|
|
480
532
|
fallback?: boolean;
|
|
481
533
|
};
|
|
482
534
|
header?: never;
|
|
@@ -525,7 +577,9 @@ export interface operations {
|
|
|
525
577
|
"patchFrontpage-apiV1SubjectpageSubjectpage-id": {
|
|
526
578
|
parameters: {
|
|
527
579
|
query?: {
|
|
580
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
528
581
|
language?: string;
|
|
582
|
+
/** @description Fallback to existing language if language is specified. */
|
|
529
583
|
fallback?: boolean;
|
|
530
584
|
};
|
|
531
585
|
header?: never;
|
|
@@ -575,6 +629,70 @@ export interface operations {
|
|
|
575
629
|
};
|
|
576
630
|
};
|
|
577
631
|
};
|
|
632
|
+
"deleteFrontpage-apiV1SubjectpageSubjectpage-idLanguageLanguage": {
|
|
633
|
+
parameters: {
|
|
634
|
+
query?: never;
|
|
635
|
+
header?: never;
|
|
636
|
+
path: {
|
|
637
|
+
/** @description The subjectpage id */
|
|
638
|
+
"subjectpage-id": number;
|
|
639
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
640
|
+
language: string;
|
|
641
|
+
};
|
|
642
|
+
cookie?: never;
|
|
643
|
+
};
|
|
644
|
+
requestBody?: never;
|
|
645
|
+
responses: {
|
|
646
|
+
200: {
|
|
647
|
+
headers: {
|
|
648
|
+
[name: string]: unknown;
|
|
649
|
+
};
|
|
650
|
+
content: {
|
|
651
|
+
"application/json": components["schemas"]["SubjectPageDTO"];
|
|
652
|
+
};
|
|
653
|
+
};
|
|
654
|
+
400: {
|
|
655
|
+
headers: {
|
|
656
|
+
[name: string]: unknown;
|
|
657
|
+
};
|
|
658
|
+
content: {
|
|
659
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
660
|
+
};
|
|
661
|
+
};
|
|
662
|
+
401: {
|
|
663
|
+
headers: {
|
|
664
|
+
[name: string]: unknown;
|
|
665
|
+
};
|
|
666
|
+
content: {
|
|
667
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
668
|
+
};
|
|
669
|
+
};
|
|
670
|
+
403: {
|
|
671
|
+
headers: {
|
|
672
|
+
[name: string]: unknown;
|
|
673
|
+
};
|
|
674
|
+
content: {
|
|
675
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
676
|
+
};
|
|
677
|
+
};
|
|
678
|
+
404: {
|
|
679
|
+
headers: {
|
|
680
|
+
[name: string]: unknown;
|
|
681
|
+
};
|
|
682
|
+
content: {
|
|
683
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
500: {
|
|
687
|
+
headers: {
|
|
688
|
+
[name: string]: unknown;
|
|
689
|
+
};
|
|
690
|
+
content: {
|
|
691
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
};
|
|
695
|
+
};
|
|
578
696
|
"getFrontpage-apiV1Frontpage": {
|
|
579
697
|
parameters: {
|
|
580
698
|
query?: never;
|
|
@@ -797,4 +915,66 @@ export interface operations {
|
|
|
797
915
|
};
|
|
798
916
|
};
|
|
799
917
|
};
|
|
918
|
+
"deleteFrontpage-apiV1FilmfrontpageLanguageLanguage": {
|
|
919
|
+
parameters: {
|
|
920
|
+
query?: never;
|
|
921
|
+
header?: never;
|
|
922
|
+
path: {
|
|
923
|
+
/** @description The ISO 639-1 language code describing language. */
|
|
924
|
+
language: string;
|
|
925
|
+
};
|
|
926
|
+
cookie?: never;
|
|
927
|
+
};
|
|
928
|
+
requestBody?: never;
|
|
929
|
+
responses: {
|
|
930
|
+
200: {
|
|
931
|
+
headers: {
|
|
932
|
+
[name: string]: unknown;
|
|
933
|
+
};
|
|
934
|
+
content: {
|
|
935
|
+
"application/json": components["schemas"]["FilmFrontPageDTO"];
|
|
936
|
+
};
|
|
937
|
+
};
|
|
938
|
+
400: {
|
|
939
|
+
headers: {
|
|
940
|
+
[name: string]: unknown;
|
|
941
|
+
};
|
|
942
|
+
content: {
|
|
943
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
944
|
+
};
|
|
945
|
+
};
|
|
946
|
+
401: {
|
|
947
|
+
headers: {
|
|
948
|
+
[name: string]: unknown;
|
|
949
|
+
};
|
|
950
|
+
content: {
|
|
951
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
952
|
+
};
|
|
953
|
+
};
|
|
954
|
+
403: {
|
|
955
|
+
headers: {
|
|
956
|
+
[name: string]: unknown;
|
|
957
|
+
};
|
|
958
|
+
content: {
|
|
959
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
960
|
+
};
|
|
961
|
+
};
|
|
962
|
+
404: {
|
|
963
|
+
headers: {
|
|
964
|
+
[name: string]: unknown;
|
|
965
|
+
};
|
|
966
|
+
content: {
|
|
967
|
+
"application/json": components["schemas"]["AllErrors"];
|
|
968
|
+
};
|
|
969
|
+
};
|
|
970
|
+
500: {
|
|
971
|
+
headers: {
|
|
972
|
+
[name: string]: unknown;
|
|
973
|
+
};
|
|
974
|
+
content: {
|
|
975
|
+
"application/json": components["schemas"]["ErrorBody"];
|
|
976
|
+
};
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
};
|
|
800
980
|
}
|
|
@@ -991,47 +991,31 @@ export interface operations {
|
|
|
991
991
|
"getSearch-apiV1SearchGroup": {
|
|
992
992
|
parameters: {
|
|
993
993
|
query?: {
|
|
994
|
-
/** @description Return only results with content matching the specified query. */
|
|
995
|
-
query?: string;
|
|
996
|
-
/** @description A comma separated list of resource-types the learning resources should be grouped by. */
|
|
997
|
-
"resource-types"?: string[];
|
|
998
|
-
/** @description The page number of the search hits to display. */
|
|
999
994
|
page?: number;
|
|
1000
|
-
/** @description The number of search hits to display for each page. Defaults to 10 and max is 10000. */
|
|
1001
995
|
"page-size"?: number;
|
|
1002
|
-
|
|
996
|
+
"article-types"?: string[];
|
|
997
|
+
"context-types"?: string[];
|
|
1003
998
|
language?: string;
|
|
1004
|
-
|
|
999
|
+
ids?: number[];
|
|
1000
|
+
"resource-types"?: string[];
|
|
1001
|
+
license?: string;
|
|
1002
|
+
query?: string;
|
|
1003
|
+
sort?: string;
|
|
1005
1004
|
fallback?: boolean;
|
|
1006
|
-
/** @description A comma separated list of subjects the learning resources should be filtered by. */
|
|
1007
1005
|
subjects?: string[];
|
|
1008
|
-
/** @description The sorting used on results.
|
|
1009
|
-
* The following are supported: -relevance, relevance, -title, title, -lastUpdated, lastUpdated, -id, id, -duration, duration, revisionDate, -revisionDate, responsibleLastUpdated, -responsibleLastUpdated, status, -status, -prioritized, prioritized, -parentTopicName, parentTopicName, -primaryRoot, primaryRoot, -resourceType, resourceType, -published, published, -favorited, favorited. Default is by -relevance (desc). */
|
|
1010
|
-
sort?: string;
|
|
1011
|
-
/** @description Return only learning resources that have one of the provided ids. To provide multiple ids, separate by comma (,). */
|
|
1012
|
-
ids?: number[];
|
|
1013
|
-
/** @description A comma separated list of types the learning resources should be filtered by. Available values is standard, topic-article, frontpage-article, learningpath, concept, gloss */
|
|
1014
|
-
"context-types"?: string[];
|
|
1015
|
-
/** @description A comma separated list of ISO 639-1 language codes that the learning resource can be available in. */
|
|
1016
1006
|
"language-filter"?: string[];
|
|
1017
|
-
/** @description A comma separated list of relevances the learning resources should be filtered by.
|
|
1018
|
-
* If subjects are specified the learning resource must have specified relevances in relation to a specified subject.
|
|
1019
|
-
* If levels are specified the learning resource must have specified relevances in relation to a specified level. */
|
|
1020
1007
|
relevance?: string[];
|
|
1021
|
-
|
|
1022
|
-
"missing-group"?: boolean;
|
|
1023
|
-
/** @description List of index-paths that should be term-aggregated and returned in result. */
|
|
1024
|
-
"aggregate-paths"?: string[];
|
|
1025
|
-
/** @description A comma separated list of codes from GREP API the resources should be filtered by. */
|
|
1008
|
+
"search-context"?: string;
|
|
1026
1009
|
"grep-codes"?: string[];
|
|
1027
|
-
|
|
1028
|
-
traits?: string[];
|
|
1029
|
-
/** @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. */
|
|
1010
|
+
"aggregate-paths"?: string[];
|
|
1030
1011
|
"embed-resource"?: string[];
|
|
1031
|
-
/** @description Return only results with embed data-resource_id, data-videoid or data-url with the specified id. */
|
|
1032
1012
|
"embed-id"?: string;
|
|
1033
|
-
/** @description Filter out inactive taxonomy contexts. */
|
|
1034
1013
|
"filter-inactive"?: boolean;
|
|
1014
|
+
traits?: string[];
|
|
1015
|
+
"result-types"?: string[];
|
|
1016
|
+
"node-types"?: string[];
|
|
1017
|
+
/** @description Whether to include group without resource-types for group-search. Defaults to false. */
|
|
1018
|
+
"missing-group"?: boolean;
|
|
1035
1019
|
};
|
|
1036
1020
|
header?: {
|
|
1037
1021
|
/** @description Header containing FEIDE access token. */
|
package/package.json
CHANGED