@ndla/types-backend 1.0.155 → 1.0.157
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/taxonomy-api.d.ts +58 -214
- package/package.json +1 -1
package/build/taxonomy-api.d.ts
CHANGED
|
@@ -181,7 +181,7 @@ export type paths = {
|
|
|
181
181
|
put: operations["updateNodeConnection"];
|
|
182
182
|
post?: never;
|
|
183
183
|
/** Removes a connection between a node and a child */
|
|
184
|
-
delete: operations["
|
|
184
|
+
delete: operations["deleteEntity_2"];
|
|
185
185
|
options?: never;
|
|
186
186
|
head?: never;
|
|
187
187
|
patch?: never;
|
|
@@ -358,7 +358,7 @@ export type paths = {
|
|
|
358
358
|
put: operations["updateNode"];
|
|
359
359
|
post?: never;
|
|
360
360
|
/** Deletes a single node by id */
|
|
361
|
-
delete: operations["
|
|
361
|
+
delete: operations["deleteEntity_1"];
|
|
362
362
|
options?: never;
|
|
363
363
|
head?: never;
|
|
364
364
|
patch?: never;
|
|
@@ -763,10 +763,16 @@ export type paths = {
|
|
|
763
763
|
path?: never;
|
|
764
764
|
cookie?: never;
|
|
765
765
|
};
|
|
766
|
-
/**
|
|
766
|
+
/**
|
|
767
|
+
* Gets all connections between resources and resource types
|
|
768
|
+
* @deprecated
|
|
769
|
+
*/
|
|
767
770
|
get: operations["getAllResourceResourceTypes"];
|
|
768
771
|
put?: never;
|
|
769
|
-
/**
|
|
772
|
+
/**
|
|
773
|
+
* Adds a resource type to a resource
|
|
774
|
+
* @deprecated
|
|
775
|
+
*/
|
|
770
776
|
post: operations["createResourceResourceType"];
|
|
771
777
|
delete?: never;
|
|
772
778
|
options?: never;
|
|
@@ -781,10 +787,16 @@ export type paths = {
|
|
|
781
787
|
path?: never;
|
|
782
788
|
cookie?: never;
|
|
783
789
|
};
|
|
784
|
-
/**
|
|
790
|
+
/**
|
|
791
|
+
* Gets all connections between resources and resource types
|
|
792
|
+
* @deprecated
|
|
793
|
+
*/
|
|
785
794
|
get: operations["getAllResourceResourceTypes_1"];
|
|
786
795
|
put?: never;
|
|
787
|
-
/**
|
|
796
|
+
/**
|
|
797
|
+
* Adds a resource type to a resource
|
|
798
|
+
* @deprecated
|
|
799
|
+
*/
|
|
788
800
|
post: operations["createResourceResourceType_1"];
|
|
789
801
|
delete?: never;
|
|
790
802
|
options?: never;
|
|
@@ -799,11 +811,17 @@ export type paths = {
|
|
|
799
811
|
path?: never;
|
|
800
812
|
cookie?: never;
|
|
801
813
|
};
|
|
802
|
-
/**
|
|
814
|
+
/**
|
|
815
|
+
* Gets a single connection between resource and resource type
|
|
816
|
+
* @deprecated
|
|
817
|
+
*/
|
|
803
818
|
get: operations["getResourceResourceType"];
|
|
804
819
|
put?: never;
|
|
805
820
|
post?: never;
|
|
806
|
-
/**
|
|
821
|
+
/**
|
|
822
|
+
* Removes a resource type from a resource
|
|
823
|
+
* @deprecated
|
|
824
|
+
*/
|
|
807
825
|
delete: operations["deleteResourceResourceType"];
|
|
808
826
|
options?: never;
|
|
809
827
|
head?: never;
|
|
@@ -820,8 +838,7 @@ export type paths = {
|
|
|
820
838
|
/** Gets a list of all resource types */
|
|
821
839
|
get: operations["getAllResourceTypes"];
|
|
822
840
|
put?: never;
|
|
823
|
-
|
|
824
|
-
post: operations["createResourceType"];
|
|
841
|
+
post?: never;
|
|
825
842
|
delete?: never;
|
|
826
843
|
options?: never;
|
|
827
844
|
head?: never;
|
|
@@ -838,8 +855,7 @@ export type paths = {
|
|
|
838
855
|
/** Gets a list of all resource types */
|
|
839
856
|
get: operations["getAllResourceTypes_1"];
|
|
840
857
|
put?: never;
|
|
841
|
-
|
|
842
|
-
post: operations["createResourceType_1"];
|
|
858
|
+
post?: never;
|
|
843
859
|
delete?: never;
|
|
844
860
|
options?: never;
|
|
845
861
|
head?: never;
|
|
@@ -855,11 +871,9 @@ export type paths = {
|
|
|
855
871
|
};
|
|
856
872
|
/** Gets a single resource type */
|
|
857
873
|
get: operations["getResourceType"];
|
|
858
|
-
|
|
859
|
-
put: operations["updateResourceType"];
|
|
874
|
+
put?: never;
|
|
860
875
|
post?: never;
|
|
861
|
-
|
|
862
|
-
delete: operations["deleteEntity_1"];
|
|
876
|
+
delete?: never;
|
|
863
877
|
options?: never;
|
|
864
878
|
head?: never;
|
|
865
879
|
patch?: never;
|
|
@@ -889,7 +903,10 @@ export type paths = {
|
|
|
889
903
|
path?: never;
|
|
890
904
|
cookie?: never;
|
|
891
905
|
};
|
|
892
|
-
/**
|
|
906
|
+
/**
|
|
907
|
+
* Gets all relevanceTranslations for a single resource type
|
|
908
|
+
* @deprecated
|
|
909
|
+
*/
|
|
893
910
|
get: operations["getAllResourceTypeTranslations"];
|
|
894
911
|
put?: never;
|
|
895
912
|
post?: never;
|
|
@@ -906,7 +923,10 @@ export type paths = {
|
|
|
906
923
|
path?: never;
|
|
907
924
|
cookie?: never;
|
|
908
925
|
};
|
|
909
|
-
/**
|
|
926
|
+
/**
|
|
927
|
+
* Gets all relevanceTranslations for a single resource type
|
|
928
|
+
* @deprecated
|
|
929
|
+
*/
|
|
910
930
|
get: operations["getAllResourceTypeTranslations_1"];
|
|
911
931
|
put?: never;
|
|
912
932
|
post?: never;
|
|
@@ -923,13 +943,14 @@ export type paths = {
|
|
|
923
943
|
path?: never;
|
|
924
944
|
cookie?: never;
|
|
925
945
|
};
|
|
926
|
-
/**
|
|
946
|
+
/**
|
|
947
|
+
* Gets a single translation for a single resource type
|
|
948
|
+
* @deprecated
|
|
949
|
+
*/
|
|
927
950
|
get: operations["getResourceTypeTranslation"];
|
|
928
|
-
|
|
929
|
-
put: operations["createUpdateResourceTypeTranslation"];
|
|
951
|
+
put?: never;
|
|
930
952
|
post?: never;
|
|
931
|
-
|
|
932
|
-
delete: operations["deleteResourceTypeTranslation"];
|
|
953
|
+
delete?: never;
|
|
933
954
|
options?: never;
|
|
934
955
|
head?: never;
|
|
935
956
|
patch?: never;
|
|
@@ -2068,7 +2089,7 @@ export type components = {
|
|
|
2068
2089
|
nodeType?: components["schemas"]["NodeType"];
|
|
2069
2090
|
/** @description The quality evaluation of the node. Consist of a score from 1 to 5 and a comment. Can be null to remove existing evaluation. */
|
|
2070
2091
|
qualityEvaluation?: components["schemas"]["QualityEvaluationDTO"];
|
|
2071
|
-
/** @description ResourceType public ids to assign to the node. Only works
|
|
2092
|
+
/** @description ResourceType public ids to assign to the node. Only works for nodes of type RESOURCE */
|
|
2072
2093
|
resourceTypes?: string[];
|
|
2073
2094
|
/**
|
|
2074
2095
|
* @deprecated
|
|
@@ -2299,7 +2320,7 @@ export type components = {
|
|
|
2299
2320
|
/**
|
|
2300
2321
|
* Format: uri
|
|
2301
2322
|
* @description Resource to resource type connection id
|
|
2302
|
-
* @example urn:resource-
|
|
2323
|
+
* @example urn:resource-resourcetype:urn:resource:123_urn:resourcetype:subjectMaterial
|
|
2303
2324
|
*/
|
|
2304
2325
|
id: string;
|
|
2305
2326
|
/**
|
|
@@ -2346,38 +2367,14 @@ export type components = {
|
|
|
2346
2367
|
* @description Sort order of the resource type
|
|
2347
2368
|
* @example 1
|
|
2348
2369
|
*/
|
|
2349
|
-
order
|
|
2370
|
+
order: number;
|
|
2350
2371
|
/** @description Sub resource types */
|
|
2351
|
-
subtypes?: components["schemas"]["ResourceType"][];
|
|
2372
|
+
subtypes?: components["schemas"]["ResourceType"][] | null;
|
|
2352
2373
|
/** @description List of language codes supported by translations */
|
|
2353
2374
|
supportedLanguages: string[];
|
|
2354
2375
|
/** @description All translations of this resource type */
|
|
2355
2376
|
translations: components["schemas"]["Translation"][];
|
|
2356
2377
|
};
|
|
2357
|
-
/** @description The new resource type */
|
|
2358
|
-
ResourceTypePUT: {
|
|
2359
|
-
/**
|
|
2360
|
-
* Format: uri
|
|
2361
|
-
* @description If specified, set the id to this value. Must start with urn:resourcetype: and be a valid URI. If omitted, an id will be assigned automatically.
|
|
2362
|
-
* @example urn:resourcetype:1
|
|
2363
|
-
*/
|
|
2364
|
-
id: string | null;
|
|
2365
|
-
/**
|
|
2366
|
-
* @description The name of the resource type
|
|
2367
|
-
* @example Lecture
|
|
2368
|
-
*/
|
|
2369
|
-
name: string;
|
|
2370
|
-
/**
|
|
2371
|
-
* Format: int32
|
|
2372
|
-
* @description Order in which the resource type should be sorted among its siblings
|
|
2373
|
-
*/
|
|
2374
|
-
order?: number;
|
|
2375
|
-
/**
|
|
2376
|
-
* Format: uri
|
|
2377
|
-
* @description If specified, the new resource type will be a child of the mentioned resource type.
|
|
2378
|
-
*/
|
|
2379
|
-
parentId: string;
|
|
2380
|
-
};
|
|
2381
2378
|
ResourceTypeWithConnection: {
|
|
2382
2379
|
/**
|
|
2383
2380
|
* Format: uri
|
|
@@ -2399,12 +2396,12 @@ export type components = {
|
|
|
2399
2396
|
* Format: int32
|
|
2400
2397
|
* @description Internal order of the resource types
|
|
2401
2398
|
*/
|
|
2402
|
-
order
|
|
2399
|
+
order: number;
|
|
2403
2400
|
/**
|
|
2404
2401
|
* Format: uri
|
|
2405
2402
|
* @example urn:resourcetype:1
|
|
2406
2403
|
*/
|
|
2407
|
-
parentId?: string;
|
|
2404
|
+
parentId?: string | null;
|
|
2408
2405
|
/** @description List of language codes supported by translations */
|
|
2409
2406
|
supportedLanguages: string[];
|
|
2410
2407
|
/** @description All translations of this resource type */
|
|
@@ -2435,8 +2432,8 @@ export type components = {
|
|
|
2435
2432
|
[key: string]: string;
|
|
2436
2433
|
};
|
|
2437
2434
|
/** Format: int32 */
|
|
2438
|
-
order
|
|
2439
|
-
parentId?: string;
|
|
2435
|
+
order: number;
|
|
2436
|
+
parentId?: string | null;
|
|
2440
2437
|
};
|
|
2441
2438
|
TaxonomyContext: {
|
|
2442
2439
|
/** @description A breadcrumb of the names of the context's parents */
|
|
@@ -2663,7 +2660,6 @@ export type ResolvedUrl = components['schemas']['ResolvedUrl'];
|
|
|
2663
2660
|
export type ResourceResourceType = components['schemas']['ResourceResourceType'];
|
|
2664
2661
|
export type ResourceResourceTypePOST = components['schemas']['ResourceResourceTypePOST'];
|
|
2665
2662
|
export type ResourceType = components['schemas']['ResourceType'];
|
|
2666
|
-
export type ResourceTypePUT = components['schemas']['ResourceTypePUT'];
|
|
2667
2663
|
export type ResourceTypeWithConnection = components['schemas']['ResourceTypeWithConnection'];
|
|
2668
2664
|
export type SearchResult = components['schemas']['SearchResult'];
|
|
2669
2665
|
export type SearchableTaxonomyResourceType = components['schemas']['SearchableTaxonomyResourceType'];
|
|
@@ -3042,7 +3038,7 @@ export interface operations {
|
|
|
3042
3038
|
};
|
|
3043
3039
|
};
|
|
3044
3040
|
};
|
|
3045
|
-
|
|
3041
|
+
deleteEntity_2: {
|
|
3046
3042
|
parameters: {
|
|
3047
3043
|
query?: never;
|
|
3048
3044
|
header?: {
|
|
@@ -3563,6 +3559,8 @@ export interface operations {
|
|
|
3563
3559
|
value?: string;
|
|
3564
3560
|
/** @description Filter by context id. Beware: handled separately from other parameters! */
|
|
3565
3561
|
contextId?: string;
|
|
3562
|
+
/** @description Filter by context ids. Beware: handled separately from other parameters! */
|
|
3563
|
+
contextIds?: string[];
|
|
3566
3564
|
/** @description Filter contexts by visibility */
|
|
3567
3565
|
isVisible?: boolean;
|
|
3568
3566
|
/** @description Include all contexts */
|
|
@@ -3645,6 +3643,8 @@ export interface operations {
|
|
|
3645
3643
|
value?: string;
|
|
3646
3644
|
/** @description Filter by context id. Beware: handled separately from other parameters! */
|
|
3647
3645
|
contextId?: string;
|
|
3646
|
+
/** @description Filter by context ids. Beware: handled separately from other parameters! */
|
|
3647
|
+
contextIds?: string[];
|
|
3648
3648
|
/** @description Filter contexts by visibility */
|
|
3649
3649
|
isVisible?: boolean;
|
|
3650
3650
|
/** @description Include all contexts */
|
|
@@ -3880,7 +3880,7 @@ export interface operations {
|
|
|
3880
3880
|
};
|
|
3881
3881
|
};
|
|
3882
3882
|
};
|
|
3883
|
-
|
|
3883
|
+
deleteEntity_1: {
|
|
3884
3884
|
parameters: {
|
|
3885
3885
|
query?: never;
|
|
3886
3886
|
header?: {
|
|
@@ -4780,31 +4780,6 @@ export interface operations {
|
|
|
4780
4780
|
};
|
|
4781
4781
|
};
|
|
4782
4782
|
};
|
|
4783
|
-
createResourceType: {
|
|
4784
|
-
parameters: {
|
|
4785
|
-
query?: never;
|
|
4786
|
-
header?: {
|
|
4787
|
-
versionHash?: components["parameters"]["versionHash"];
|
|
4788
|
-
};
|
|
4789
|
-
path?: never;
|
|
4790
|
-
cookie?: never;
|
|
4791
|
-
};
|
|
4792
|
-
requestBody: {
|
|
4793
|
-
content: {
|
|
4794
|
-
"application/json": components["schemas"]["ResourceTypePUT"];
|
|
4795
|
-
};
|
|
4796
|
-
};
|
|
4797
|
-
responses: {
|
|
4798
|
-
/** @description Created */
|
|
4799
|
-
201: {
|
|
4800
|
-
headers: {
|
|
4801
|
-
Location?: string;
|
|
4802
|
-
[name: string]: unknown;
|
|
4803
|
-
};
|
|
4804
|
-
content?: never;
|
|
4805
|
-
};
|
|
4806
|
-
};
|
|
4807
|
-
};
|
|
4808
4783
|
getAllResourceTypes_1: {
|
|
4809
4784
|
parameters: {
|
|
4810
4785
|
query?: {
|
|
@@ -4833,31 +4808,6 @@ export interface operations {
|
|
|
4833
4808
|
};
|
|
4834
4809
|
};
|
|
4835
4810
|
};
|
|
4836
|
-
createResourceType_1: {
|
|
4837
|
-
parameters: {
|
|
4838
|
-
query?: never;
|
|
4839
|
-
header?: {
|
|
4840
|
-
versionHash?: components["parameters"]["versionHash"];
|
|
4841
|
-
};
|
|
4842
|
-
path?: never;
|
|
4843
|
-
cookie?: never;
|
|
4844
|
-
};
|
|
4845
|
-
requestBody: {
|
|
4846
|
-
content: {
|
|
4847
|
-
"application/json": components["schemas"]["ResourceTypePUT"];
|
|
4848
|
-
};
|
|
4849
|
-
};
|
|
4850
|
-
responses: {
|
|
4851
|
-
/** @description Created */
|
|
4852
|
-
201: {
|
|
4853
|
-
headers: {
|
|
4854
|
-
Location?: string;
|
|
4855
|
-
[name: string]: unknown;
|
|
4856
|
-
};
|
|
4857
|
-
content?: never;
|
|
4858
|
-
};
|
|
4859
|
-
};
|
|
4860
|
-
};
|
|
4861
4811
|
getResourceType: {
|
|
4862
4812
|
parameters: {
|
|
4863
4813
|
query?: {
|
|
@@ -4888,54 +4838,6 @@ export interface operations {
|
|
|
4888
4838
|
};
|
|
4889
4839
|
};
|
|
4890
4840
|
};
|
|
4891
|
-
updateResourceType: {
|
|
4892
|
-
parameters: {
|
|
4893
|
-
query?: never;
|
|
4894
|
-
header?: {
|
|
4895
|
-
versionHash?: components["parameters"]["versionHash"];
|
|
4896
|
-
};
|
|
4897
|
-
path: {
|
|
4898
|
-
id: string;
|
|
4899
|
-
};
|
|
4900
|
-
cookie?: never;
|
|
4901
|
-
};
|
|
4902
|
-
requestBody: {
|
|
4903
|
-
content: {
|
|
4904
|
-
"application/json": components["schemas"]["ResourceTypePUT"];
|
|
4905
|
-
};
|
|
4906
|
-
};
|
|
4907
|
-
responses: {
|
|
4908
|
-
/** @description No Content */
|
|
4909
|
-
204: {
|
|
4910
|
-
headers: {
|
|
4911
|
-
[name: string]: unknown;
|
|
4912
|
-
};
|
|
4913
|
-
content?: never;
|
|
4914
|
-
};
|
|
4915
|
-
};
|
|
4916
|
-
};
|
|
4917
|
-
deleteEntity_1: {
|
|
4918
|
-
parameters: {
|
|
4919
|
-
query?: never;
|
|
4920
|
-
header?: {
|
|
4921
|
-
versionHash?: components["parameters"]["versionHash"];
|
|
4922
|
-
};
|
|
4923
|
-
path: {
|
|
4924
|
-
id: string;
|
|
4925
|
-
};
|
|
4926
|
-
cookie?: never;
|
|
4927
|
-
};
|
|
4928
|
-
requestBody?: never;
|
|
4929
|
-
responses: {
|
|
4930
|
-
/** @description No Content */
|
|
4931
|
-
204: {
|
|
4932
|
-
headers: {
|
|
4933
|
-
[name: string]: unknown;
|
|
4934
|
-
};
|
|
4935
|
-
content?: never;
|
|
4936
|
-
};
|
|
4937
|
-
};
|
|
4938
|
-
};
|
|
4939
4841
|
getResourceTypeSubtypes: {
|
|
4940
4842
|
parameters: {
|
|
4941
4843
|
query?: {
|
|
@@ -5045,64 +4947,6 @@ export interface operations {
|
|
|
5045
4947
|
};
|
|
5046
4948
|
};
|
|
5047
4949
|
};
|
|
5048
|
-
createUpdateResourceTypeTranslation: {
|
|
5049
|
-
parameters: {
|
|
5050
|
-
query?: never;
|
|
5051
|
-
header?: {
|
|
5052
|
-
versionHash?: components["parameters"]["versionHash"];
|
|
5053
|
-
};
|
|
5054
|
-
path: {
|
|
5055
|
-
id: string;
|
|
5056
|
-
/**
|
|
5057
|
-
* @description ISO-639-1 language code
|
|
5058
|
-
* @example nb
|
|
5059
|
-
*/
|
|
5060
|
-
language: string;
|
|
5061
|
-
};
|
|
5062
|
-
cookie?: never;
|
|
5063
|
-
};
|
|
5064
|
-
requestBody: {
|
|
5065
|
-
content: {
|
|
5066
|
-
"application/json": components["schemas"]["TranslationPUT"];
|
|
5067
|
-
};
|
|
5068
|
-
};
|
|
5069
|
-
responses: {
|
|
5070
|
-
/** @description No Content */
|
|
5071
|
-
204: {
|
|
5072
|
-
headers: {
|
|
5073
|
-
[name: string]: unknown;
|
|
5074
|
-
};
|
|
5075
|
-
content?: never;
|
|
5076
|
-
};
|
|
5077
|
-
};
|
|
5078
|
-
};
|
|
5079
|
-
deleteResourceTypeTranslation: {
|
|
5080
|
-
parameters: {
|
|
5081
|
-
query?: never;
|
|
5082
|
-
header?: {
|
|
5083
|
-
versionHash?: components["parameters"]["versionHash"];
|
|
5084
|
-
};
|
|
5085
|
-
path: {
|
|
5086
|
-
id: string;
|
|
5087
|
-
/**
|
|
5088
|
-
* @description ISO-639-1 language code
|
|
5089
|
-
* @example nb
|
|
5090
|
-
*/
|
|
5091
|
-
language: string;
|
|
5092
|
-
};
|
|
5093
|
-
cookie?: never;
|
|
5094
|
-
};
|
|
5095
|
-
requestBody?: never;
|
|
5096
|
-
responses: {
|
|
5097
|
-
/** @description No Content */
|
|
5098
|
-
204: {
|
|
5099
|
-
headers: {
|
|
5100
|
-
[name: string]: unknown;
|
|
5101
|
-
};
|
|
5102
|
-
content?: never;
|
|
5103
|
-
};
|
|
5104
|
-
};
|
|
5105
|
-
};
|
|
5106
4950
|
redirect_168: {
|
|
5107
4951
|
parameters: {
|
|
5108
4952
|
query?: never;
|