@ndla/types-taxonomy 1.0.43 → 1.0.45
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-openapi.d.ts +109 -73
- package/build/taxonomy-api.d.ts +2 -0
- package/openapi.json +1 -1
- package/package.json +1 -1
- package/taxonomy-api-openapi.ts +109 -73
- package/taxonomy-api.ts +2 -0
|
@@ -2198,6 +2198,9 @@ export type components = {
|
|
|
2198
2198
|
/** Format: int32 */
|
|
2199
2199
|
count: number;
|
|
2200
2200
|
};
|
|
2201
|
+
LanguageFieldString: {
|
|
2202
|
+
[key: string]: string;
|
|
2203
|
+
};
|
|
2201
2204
|
Metadata: {
|
|
2202
2205
|
customFields: {
|
|
2203
2206
|
[key: string]: string;
|
|
@@ -2205,6 +2208,16 @@ export type components = {
|
|
|
2205
2208
|
grepCodes: string[];
|
|
2206
2209
|
visible: boolean;
|
|
2207
2210
|
};
|
|
2211
|
+
MetadataPUT: {
|
|
2212
|
+
/** @description Custom fields, Only updated if present */
|
|
2213
|
+
customFields?: {
|
|
2214
|
+
[key: string]: string;
|
|
2215
|
+
};
|
|
2216
|
+
/** @description Set of grep codes, Only updated if present */
|
|
2217
|
+
grepCodes?: string[];
|
|
2218
|
+
/** @description Visibility of the node, Only updated if present */
|
|
2219
|
+
visible?: boolean;
|
|
2220
|
+
};
|
|
2208
2221
|
Node: {
|
|
2209
2222
|
/**
|
|
2210
2223
|
* @description The stored name of the node
|
|
@@ -2496,7 +2509,7 @@ export type components = {
|
|
|
2496
2509
|
* @description The language used at create time. Used to set default translation.
|
|
2497
2510
|
* @example nb
|
|
2498
2511
|
*/
|
|
2499
|
-
language
|
|
2512
|
+
language?: string;
|
|
2500
2513
|
/**
|
|
2501
2514
|
* @description The name of the node. Required on create.
|
|
2502
2515
|
* @example Trigonometry
|
|
@@ -2508,7 +2521,7 @@ export type components = {
|
|
|
2508
2521
|
* @description Type of node.
|
|
2509
2522
|
* @example topic
|
|
2510
2523
|
*/
|
|
2511
|
-
nodeType
|
|
2524
|
+
nodeType?: components["schemas"]["NodeType"];
|
|
2512
2525
|
/** @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. */
|
|
2513
2526
|
qualityEvaluation?: components["schemas"]["QualityEvaluationDTO"];
|
|
2514
2527
|
/**
|
|
@@ -2618,28 +2631,28 @@ export type components = {
|
|
|
2618
2631
|
[key: string]: string;
|
|
2619
2632
|
};
|
|
2620
2633
|
/** @description Filter out programme contexts */
|
|
2621
|
-
filterProgrammes
|
|
2634
|
+
filterProgrammes?: boolean;
|
|
2622
2635
|
/** @description Ids to fetch for query */
|
|
2623
2636
|
ids?: string[];
|
|
2624
2637
|
/** @description Include all contexts */
|
|
2625
|
-
includeContexts
|
|
2638
|
+
includeContexts?: boolean;
|
|
2626
2639
|
/**
|
|
2627
2640
|
* @description ISO-639-1 language code
|
|
2628
2641
|
* @example nb
|
|
2629
2642
|
*/
|
|
2630
|
-
language
|
|
2643
|
+
language?: string;
|
|
2631
2644
|
/** @description Filter by nodeType */
|
|
2632
2645
|
nodeType?: components["schemas"]["NodeType"][];
|
|
2633
2646
|
/**
|
|
2634
2647
|
* Format: int32
|
|
2635
2648
|
* @description Which page to fetch
|
|
2636
2649
|
*/
|
|
2637
|
-
page
|
|
2650
|
+
page?: number;
|
|
2638
2651
|
/**
|
|
2639
2652
|
* Format: int32
|
|
2640
2653
|
* @description How many results to return per page
|
|
2641
2654
|
*/
|
|
2642
|
-
pageSize
|
|
2655
|
+
pageSize?: number;
|
|
2643
2656
|
/**
|
|
2644
2657
|
* Format: uri
|
|
2645
2658
|
* @description Id to parent id in context.
|
|
@@ -3160,9 +3173,7 @@ export type components = {
|
|
|
3160
3173
|
*/
|
|
3161
3174
|
rank: number;
|
|
3162
3175
|
/** @description Name of the relevance of the parent connection */
|
|
3163
|
-
relevance:
|
|
3164
|
-
[key: string]: string;
|
|
3165
|
-
};
|
|
3176
|
+
relevance: components["schemas"]["LanguageFieldString"];
|
|
3166
3177
|
/**
|
|
3167
3178
|
* Format: uri
|
|
3168
3179
|
* @description Id of the relevance of the parent connection
|
|
@@ -3191,9 +3202,7 @@ export type components = {
|
|
|
3191
3202
|
*/
|
|
3192
3203
|
id: string;
|
|
3193
3204
|
/** @description The name of the node */
|
|
3194
|
-
name:
|
|
3195
|
-
[key: string]: string;
|
|
3196
|
-
};
|
|
3205
|
+
name: components["schemas"]["LanguageFieldString"];
|
|
3197
3206
|
/** @description The context path */
|
|
3198
3207
|
path: string;
|
|
3199
3208
|
/** @description The context url */
|
|
@@ -3621,9 +3630,10 @@ export interface operations {
|
|
|
3621
3630
|
};
|
|
3622
3631
|
};
|
|
3623
3632
|
responses: {
|
|
3624
|
-
/** @description
|
|
3625
|
-
|
|
3633
|
+
/** @description Created */
|
|
3634
|
+
201: {
|
|
3626
3635
|
headers: {
|
|
3636
|
+
Location?: string;
|
|
3627
3637
|
[name: string]: unknown;
|
|
3628
3638
|
};
|
|
3629
3639
|
content?: never;
|
|
@@ -3673,9 +3683,10 @@ export interface operations {
|
|
|
3673
3683
|
};
|
|
3674
3684
|
};
|
|
3675
3685
|
responses: {
|
|
3676
|
-
/** @description
|
|
3677
|
-
|
|
3686
|
+
/** @description Created */
|
|
3687
|
+
201: {
|
|
3678
3688
|
headers: {
|
|
3689
|
+
Location?: string;
|
|
3679
3690
|
[name: string]: unknown;
|
|
3680
3691
|
};
|
|
3681
3692
|
content?: never;
|
|
@@ -3741,9 +3752,10 @@ export interface operations {
|
|
|
3741
3752
|
};
|
|
3742
3753
|
};
|
|
3743
3754
|
responses: {
|
|
3744
|
-
/** @description
|
|
3745
|
-
|
|
3755
|
+
/** @description Created */
|
|
3756
|
+
201: {
|
|
3746
3757
|
headers: {
|
|
3758
|
+
Location?: string;
|
|
3747
3759
|
[name: string]: unknown;
|
|
3748
3760
|
};
|
|
3749
3761
|
content?: never;
|
|
@@ -3787,9 +3799,10 @@ export interface operations {
|
|
|
3787
3799
|
};
|
|
3788
3800
|
};
|
|
3789
3801
|
responses: {
|
|
3790
|
-
/** @description
|
|
3791
|
-
|
|
3802
|
+
/** @description Created */
|
|
3803
|
+
201: {
|
|
3792
3804
|
headers: {
|
|
3805
|
+
Location?: string;
|
|
3793
3806
|
[name: string]: unknown;
|
|
3794
3807
|
};
|
|
3795
3808
|
content?: never;
|
|
@@ -3932,7 +3945,7 @@ export interface operations {
|
|
|
3932
3945
|
};
|
|
3933
3946
|
requestBody: {
|
|
3934
3947
|
content: {
|
|
3935
|
-
"application/json": components["schemas"]["
|
|
3948
|
+
"application/json": components["schemas"]["MetadataPUT"];
|
|
3936
3949
|
};
|
|
3937
3950
|
};
|
|
3938
3951
|
responses: {
|
|
@@ -3984,9 +3997,10 @@ export interface operations {
|
|
|
3984
3997
|
};
|
|
3985
3998
|
};
|
|
3986
3999
|
responses: {
|
|
3987
|
-
/** @description
|
|
3988
|
-
|
|
4000
|
+
/** @description Created */
|
|
4001
|
+
201: {
|
|
3989
4002
|
headers: {
|
|
4003
|
+
Location?: string;
|
|
3990
4004
|
[name: string]: unknown;
|
|
3991
4005
|
};
|
|
3992
4006
|
content?: never;
|
|
@@ -4030,9 +4044,10 @@ export interface operations {
|
|
|
4030
4044
|
};
|
|
4031
4045
|
};
|
|
4032
4046
|
responses: {
|
|
4033
|
-
/** @description
|
|
4034
|
-
|
|
4047
|
+
/** @description Created */
|
|
4048
|
+
201: {
|
|
4035
4049
|
headers: {
|
|
4050
|
+
Location?: string;
|
|
4036
4051
|
[name: string]: unknown;
|
|
4037
4052
|
};
|
|
4038
4053
|
content?: never;
|
|
@@ -4175,7 +4190,7 @@ export interface operations {
|
|
|
4175
4190
|
};
|
|
4176
4191
|
requestBody: {
|
|
4177
4192
|
content: {
|
|
4178
|
-
"application/json": components["schemas"]["
|
|
4193
|
+
"application/json": components["schemas"]["MetadataPUT"];
|
|
4179
4194
|
};
|
|
4180
4195
|
};
|
|
4181
4196
|
responses: {
|
|
@@ -4262,9 +4277,10 @@ export interface operations {
|
|
|
4262
4277
|
};
|
|
4263
4278
|
};
|
|
4264
4279
|
responses: {
|
|
4265
|
-
/** @description
|
|
4266
|
-
|
|
4280
|
+
/** @description Created */
|
|
4281
|
+
201: {
|
|
4267
4282
|
headers: {
|
|
4283
|
+
Location?: string;
|
|
4268
4284
|
[name: string]: unknown;
|
|
4269
4285
|
};
|
|
4270
4286
|
content?: never;
|
|
@@ -4343,9 +4359,10 @@ export interface operations {
|
|
|
4343
4359
|
};
|
|
4344
4360
|
};
|
|
4345
4361
|
responses: {
|
|
4346
|
-
/** @description
|
|
4347
|
-
|
|
4362
|
+
/** @description Created */
|
|
4363
|
+
201: {
|
|
4348
4364
|
headers: {
|
|
4365
|
+
Location?: string;
|
|
4349
4366
|
[name: string]: unknown;
|
|
4350
4367
|
};
|
|
4351
4368
|
content?: never;
|
|
@@ -4704,7 +4721,7 @@ export interface operations {
|
|
|
4704
4721
|
};
|
|
4705
4722
|
requestBody: {
|
|
4706
4723
|
content: {
|
|
4707
|
-
"application/json": components["schemas"]["
|
|
4724
|
+
"application/json": components["schemas"]["MetadataPUT"];
|
|
4708
4725
|
};
|
|
4709
4726
|
};
|
|
4710
4727
|
responses: {
|
|
@@ -5331,9 +5348,10 @@ export interface operations {
|
|
|
5331
5348
|
};
|
|
5332
5349
|
};
|
|
5333
5350
|
responses: {
|
|
5334
|
-
/** @description
|
|
5335
|
-
|
|
5351
|
+
/** @description Created */
|
|
5352
|
+
201: {
|
|
5336
5353
|
headers: {
|
|
5354
|
+
Location?: string;
|
|
5337
5355
|
[name: string]: unknown;
|
|
5338
5356
|
};
|
|
5339
5357
|
content?: never;
|
|
@@ -5377,9 +5395,10 @@ export interface operations {
|
|
|
5377
5395
|
};
|
|
5378
5396
|
};
|
|
5379
5397
|
responses: {
|
|
5380
|
-
/** @description
|
|
5381
|
-
|
|
5398
|
+
/** @description Created */
|
|
5399
|
+
201: {
|
|
5382
5400
|
headers: {
|
|
5401
|
+
Location?: string;
|
|
5383
5402
|
[name: string]: unknown;
|
|
5384
5403
|
};
|
|
5385
5404
|
content?: never;
|
|
@@ -5475,9 +5494,10 @@ export interface operations {
|
|
|
5475
5494
|
};
|
|
5476
5495
|
};
|
|
5477
5496
|
responses: {
|
|
5478
|
-
/** @description
|
|
5479
|
-
|
|
5497
|
+
/** @description Created */
|
|
5498
|
+
201: {
|
|
5480
5499
|
headers: {
|
|
5500
|
+
Location?: string;
|
|
5481
5501
|
[name: string]: unknown;
|
|
5482
5502
|
};
|
|
5483
5503
|
content?: never;
|
|
@@ -5527,9 +5547,10 @@ export interface operations {
|
|
|
5527
5547
|
};
|
|
5528
5548
|
};
|
|
5529
5549
|
responses: {
|
|
5530
|
-
/** @description
|
|
5531
|
-
|
|
5550
|
+
/** @description Created */
|
|
5551
|
+
201: {
|
|
5532
5552
|
headers: {
|
|
5553
|
+
Location?: string;
|
|
5533
5554
|
[name: string]: unknown;
|
|
5534
5555
|
};
|
|
5535
5556
|
content?: never;
|
|
@@ -5832,9 +5853,10 @@ export interface operations {
|
|
|
5832
5853
|
};
|
|
5833
5854
|
};
|
|
5834
5855
|
responses: {
|
|
5835
|
-
/** @description
|
|
5836
|
-
|
|
5856
|
+
/** @description Created */
|
|
5857
|
+
201: {
|
|
5837
5858
|
headers: {
|
|
5859
|
+
Location?: string;
|
|
5838
5860
|
[name: string]: unknown;
|
|
5839
5861
|
};
|
|
5840
5862
|
content?: never;
|
|
@@ -5892,9 +5914,10 @@ export interface operations {
|
|
|
5892
5914
|
};
|
|
5893
5915
|
};
|
|
5894
5916
|
responses: {
|
|
5895
|
-
/** @description
|
|
5896
|
-
|
|
5917
|
+
/** @description Created */
|
|
5918
|
+
201: {
|
|
5897
5919
|
headers: {
|
|
5920
|
+
Location?: string;
|
|
5898
5921
|
[name: string]: unknown;
|
|
5899
5922
|
};
|
|
5900
5923
|
content?: never;
|
|
@@ -6070,9 +6093,10 @@ export interface operations {
|
|
|
6070
6093
|
};
|
|
6071
6094
|
};
|
|
6072
6095
|
responses: {
|
|
6073
|
-
/** @description
|
|
6074
|
-
|
|
6096
|
+
/** @description Created */
|
|
6097
|
+
201: {
|
|
6075
6098
|
headers: {
|
|
6099
|
+
Location?: string;
|
|
6076
6100
|
[name: string]: unknown;
|
|
6077
6101
|
};
|
|
6078
6102
|
content?: never;
|
|
@@ -6146,7 +6170,7 @@ export interface operations {
|
|
|
6146
6170
|
};
|
|
6147
6171
|
requestBody: {
|
|
6148
6172
|
content: {
|
|
6149
|
-
"application/json": components["schemas"]["
|
|
6173
|
+
"application/json": components["schemas"]["MetadataPUT"];
|
|
6150
6174
|
};
|
|
6151
6175
|
};
|
|
6152
6176
|
responses: {
|
|
@@ -6363,9 +6387,10 @@ export interface operations {
|
|
|
6363
6387
|
};
|
|
6364
6388
|
};
|
|
6365
6389
|
responses: {
|
|
6366
|
-
/** @description
|
|
6367
|
-
|
|
6390
|
+
/** @description Created */
|
|
6391
|
+
201: {
|
|
6368
6392
|
headers: {
|
|
6393
|
+
Location?: string;
|
|
6369
6394
|
[name: string]: unknown;
|
|
6370
6395
|
};
|
|
6371
6396
|
content?: never;
|
|
@@ -6409,9 +6434,10 @@ export interface operations {
|
|
|
6409
6434
|
};
|
|
6410
6435
|
};
|
|
6411
6436
|
responses: {
|
|
6412
|
-
/** @description
|
|
6413
|
-
|
|
6437
|
+
/** @description Created */
|
|
6438
|
+
201: {
|
|
6414
6439
|
headers: {
|
|
6440
|
+
Location?: string;
|
|
6415
6441
|
[name: string]: unknown;
|
|
6416
6442
|
};
|
|
6417
6443
|
content?: never;
|
|
@@ -6566,9 +6592,10 @@ export interface operations {
|
|
|
6566
6592
|
};
|
|
6567
6593
|
};
|
|
6568
6594
|
responses: {
|
|
6569
|
-
/** @description
|
|
6570
|
-
|
|
6595
|
+
/** @description Created */
|
|
6596
|
+
201: {
|
|
6571
6597
|
headers: {
|
|
6598
|
+
Location?: string;
|
|
6572
6599
|
[name: string]: unknown;
|
|
6573
6600
|
};
|
|
6574
6601
|
content?: never;
|
|
@@ -6624,9 +6651,10 @@ export interface operations {
|
|
|
6624
6651
|
};
|
|
6625
6652
|
};
|
|
6626
6653
|
responses: {
|
|
6627
|
-
/** @description
|
|
6628
|
-
|
|
6654
|
+
/** @description Created */
|
|
6655
|
+
201: {
|
|
6629
6656
|
headers: {
|
|
6657
|
+
Location?: string;
|
|
6630
6658
|
[name: string]: unknown;
|
|
6631
6659
|
};
|
|
6632
6660
|
content?: never;
|
|
@@ -6818,7 +6846,7 @@ export interface operations {
|
|
|
6818
6846
|
};
|
|
6819
6847
|
requestBody: {
|
|
6820
6848
|
content: {
|
|
6821
|
-
"application/json": components["schemas"]["
|
|
6849
|
+
"application/json": components["schemas"]["MetadataPUT"];
|
|
6822
6850
|
};
|
|
6823
6851
|
};
|
|
6824
6852
|
responses: {
|
|
@@ -7073,9 +7101,10 @@ export interface operations {
|
|
|
7073
7101
|
};
|
|
7074
7102
|
};
|
|
7075
7103
|
responses: {
|
|
7076
|
-
/** @description
|
|
7077
|
-
|
|
7104
|
+
/** @description Created */
|
|
7105
|
+
201: {
|
|
7078
7106
|
headers: {
|
|
7107
|
+
Location?: string;
|
|
7079
7108
|
[name: string]: unknown;
|
|
7080
7109
|
};
|
|
7081
7110
|
content?: never;
|
|
@@ -7119,9 +7148,10 @@ export interface operations {
|
|
|
7119
7148
|
};
|
|
7120
7149
|
};
|
|
7121
7150
|
responses: {
|
|
7122
|
-
/** @description
|
|
7123
|
-
|
|
7151
|
+
/** @description Created */
|
|
7152
|
+
201: {
|
|
7124
7153
|
headers: {
|
|
7154
|
+
Location?: string;
|
|
7125
7155
|
[name: string]: unknown;
|
|
7126
7156
|
};
|
|
7127
7157
|
content?: never;
|
|
@@ -7264,9 +7294,10 @@ export interface operations {
|
|
|
7264
7294
|
};
|
|
7265
7295
|
};
|
|
7266
7296
|
responses: {
|
|
7267
|
-
/** @description
|
|
7268
|
-
|
|
7297
|
+
/** @description Created */
|
|
7298
|
+
201: {
|
|
7269
7299
|
headers: {
|
|
7300
|
+
Location?: string;
|
|
7270
7301
|
[name: string]: unknown;
|
|
7271
7302
|
};
|
|
7272
7303
|
content?: never;
|
|
@@ -7310,9 +7341,10 @@ export interface operations {
|
|
|
7310
7341
|
};
|
|
7311
7342
|
};
|
|
7312
7343
|
responses: {
|
|
7313
|
-
/** @description
|
|
7314
|
-
|
|
7344
|
+
/** @description Created */
|
|
7345
|
+
201: {
|
|
7315
7346
|
headers: {
|
|
7347
|
+
Location?: string;
|
|
7316
7348
|
[name: string]: unknown;
|
|
7317
7349
|
};
|
|
7318
7350
|
content?: never;
|
|
@@ -7469,9 +7501,10 @@ export interface operations {
|
|
|
7469
7501
|
};
|
|
7470
7502
|
};
|
|
7471
7503
|
responses: {
|
|
7472
|
-
/** @description
|
|
7473
|
-
|
|
7504
|
+
/** @description Created */
|
|
7505
|
+
201: {
|
|
7474
7506
|
headers: {
|
|
7507
|
+
Location?: string;
|
|
7475
7508
|
[name: string]: unknown;
|
|
7476
7509
|
};
|
|
7477
7510
|
content?: never;
|
|
@@ -7529,9 +7562,10 @@ export interface operations {
|
|
|
7529
7562
|
};
|
|
7530
7563
|
};
|
|
7531
7564
|
responses: {
|
|
7532
|
-
/** @description
|
|
7533
|
-
|
|
7565
|
+
/** @description Created */
|
|
7566
|
+
201: {
|
|
7534
7567
|
headers: {
|
|
7568
|
+
Location?: string;
|
|
7535
7569
|
[name: string]: unknown;
|
|
7536
7570
|
};
|
|
7537
7571
|
content?: never;
|
|
@@ -7774,7 +7808,7 @@ export interface operations {
|
|
|
7774
7808
|
};
|
|
7775
7809
|
requestBody: {
|
|
7776
7810
|
content: {
|
|
7777
|
-
"application/json": components["schemas"]["
|
|
7811
|
+
"application/json": components["schemas"]["MetadataPUT"];
|
|
7778
7812
|
};
|
|
7779
7813
|
};
|
|
7780
7814
|
responses: {
|
|
@@ -8120,9 +8154,10 @@ export interface operations {
|
|
|
8120
8154
|
};
|
|
8121
8155
|
};
|
|
8122
8156
|
responses: {
|
|
8123
|
-
/** @description
|
|
8124
|
-
|
|
8157
|
+
/** @description Created */
|
|
8158
|
+
201: {
|
|
8125
8159
|
headers: {
|
|
8160
|
+
Location?: string;
|
|
8126
8161
|
[name: string]: unknown;
|
|
8127
8162
|
};
|
|
8128
8163
|
content?: never;
|
|
@@ -8180,9 +8215,10 @@ export interface operations {
|
|
|
8180
8215
|
};
|
|
8181
8216
|
};
|
|
8182
8217
|
responses: {
|
|
8183
|
-
/** @description
|
|
8184
|
-
|
|
8218
|
+
/** @description Created */
|
|
8219
|
+
201: {
|
|
8185
8220
|
headers: {
|
|
8221
|
+
Location?: string;
|
|
8186
8222
|
[name: string]: unknown;
|
|
8187
8223
|
};
|
|
8188
8224
|
content?: never;
|
package/build/taxonomy-api.d.ts
CHANGED
|
@@ -6,7 +6,9 @@ export type Context = schemas["Context"];
|
|
|
6
6
|
export type ContextPOST = schemas["ContextPOST"];
|
|
7
7
|
export type Grade = schemas["Grade"];
|
|
8
8
|
export type GradeAverage = schemas["GradeAverage"];
|
|
9
|
+
export type LanguageFieldString = schemas["LanguageFieldString"];
|
|
9
10
|
export type Metadata = schemas["Metadata"];
|
|
11
|
+
export type MetadataPUT = schemas["MetadataPUT"];
|
|
10
12
|
export type Node = schemas["Node"];
|
|
11
13
|
export type NodeChild = schemas["NodeChild"];
|
|
12
14
|
export type NodeConnection = schemas["NodeConnection"];
|