@epilot/entity-client 4.17.0 → 4.18.1-rc.1
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/dist/client.d.ts +0 -0
- package/dist/client.js +0 -0
- package/dist/definition.d.ts +0 -0
- package/dist/definition.js +1 -1
- package/dist/index.d.ts +0 -0
- package/dist/index.js +0 -0
- package/dist/openapi-runtime.json +222 -149
- package/dist/openapi.d.ts +451 -189
- package/dist/openapi.json +556 -218
- package/dist/schema-model.d.ts +0 -0
- package/dist/schema-model.js +0 -0
- package/package.json +2 -2
package/dist/openapi.json
CHANGED
|
@@ -95,7 +95,12 @@
|
|
|
95
95
|
],
|
|
96
96
|
"parameters": [
|
|
97
97
|
{
|
|
98
|
-
"
|
|
98
|
+
"in": "path",
|
|
99
|
+
"name": "slug",
|
|
100
|
+
"required": true,
|
|
101
|
+
"schema": {
|
|
102
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
103
|
+
}
|
|
99
104
|
},
|
|
100
105
|
{
|
|
101
106
|
"in": "query",
|
|
@@ -127,7 +132,12 @@
|
|
|
127
132
|
],
|
|
128
133
|
"parameters": [
|
|
129
134
|
{
|
|
130
|
-
"
|
|
135
|
+
"in": "path",
|
|
136
|
+
"name": "slug",
|
|
137
|
+
"required": true,
|
|
138
|
+
"schema": {
|
|
139
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
140
|
+
}
|
|
131
141
|
},
|
|
132
142
|
{
|
|
133
143
|
"in": "query",
|
|
@@ -169,7 +179,12 @@
|
|
|
169
179
|
],
|
|
170
180
|
"parameters": [
|
|
171
181
|
{
|
|
172
|
-
"
|
|
182
|
+
"in": "path",
|
|
183
|
+
"name": "slug",
|
|
184
|
+
"required": true,
|
|
185
|
+
"schema": {
|
|
186
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
187
|
+
}
|
|
173
188
|
}
|
|
174
189
|
],
|
|
175
190
|
"responses": {
|
|
@@ -189,7 +204,12 @@
|
|
|
189
204
|
],
|
|
190
205
|
"parameters": [
|
|
191
206
|
{
|
|
192
|
-
"
|
|
207
|
+
"in": "path",
|
|
208
|
+
"name": "slug",
|
|
209
|
+
"required": true,
|
|
210
|
+
"schema": {
|
|
211
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
212
|
+
}
|
|
193
213
|
},
|
|
194
214
|
{
|
|
195
215
|
"in": "query",
|
|
@@ -288,10 +308,20 @@
|
|
|
288
308
|
],
|
|
289
309
|
"parameters": [
|
|
290
310
|
{
|
|
291
|
-
"
|
|
311
|
+
"in": "path",
|
|
312
|
+
"name": "slug",
|
|
313
|
+
"required": true,
|
|
314
|
+
"schema": {
|
|
315
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
316
|
+
}
|
|
292
317
|
},
|
|
293
318
|
{
|
|
294
|
-
"
|
|
319
|
+
"in": "path",
|
|
320
|
+
"name": "taxonomySlug",
|
|
321
|
+
"required": true,
|
|
322
|
+
"schema": {
|
|
323
|
+
"$ref": "#/components/schemas/TaxonomySlug"
|
|
324
|
+
}
|
|
295
325
|
},
|
|
296
326
|
{
|
|
297
327
|
"in": "query",
|
|
@@ -376,13 +406,32 @@
|
|
|
376
406
|
],
|
|
377
407
|
"parameters": [
|
|
378
408
|
{
|
|
379
|
-
"
|
|
409
|
+
"in": "path",
|
|
410
|
+
"name": "slug",
|
|
411
|
+
"description": "Entity Schema",
|
|
412
|
+
"required": true,
|
|
413
|
+
"schema": {
|
|
414
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
415
|
+
}
|
|
380
416
|
},
|
|
381
417
|
{
|
|
382
|
-
"
|
|
418
|
+
"in": "query",
|
|
419
|
+
"name": "activity_id",
|
|
420
|
+
"description": "Activity to include in event feed",
|
|
421
|
+
"required": false,
|
|
422
|
+
"schema": {
|
|
423
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
424
|
+
}
|
|
383
425
|
},
|
|
384
426
|
{
|
|
385
|
-
"
|
|
427
|
+
"in": "query",
|
|
428
|
+
"name": "async",
|
|
429
|
+
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
430
|
+
"required": false,
|
|
431
|
+
"schema": {
|
|
432
|
+
"type": "boolean",
|
|
433
|
+
"default": false
|
|
434
|
+
}
|
|
386
435
|
}
|
|
387
436
|
],
|
|
388
437
|
"requestBody": {
|
|
@@ -453,16 +502,42 @@
|
|
|
453
502
|
],
|
|
454
503
|
"parameters": [
|
|
455
504
|
{
|
|
456
|
-
"
|
|
505
|
+
"in": "path",
|
|
506
|
+
"name": "slug",
|
|
507
|
+
"description": "Entity Schema",
|
|
508
|
+
"required": true,
|
|
509
|
+
"schema": {
|
|
510
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
511
|
+
}
|
|
457
512
|
},
|
|
458
513
|
{
|
|
459
|
-
"
|
|
514
|
+
"in": "query",
|
|
515
|
+
"name": "activity_id",
|
|
516
|
+
"description": "Activity to include in event feed",
|
|
517
|
+
"required": false,
|
|
518
|
+
"schema": {
|
|
519
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
520
|
+
}
|
|
460
521
|
},
|
|
461
522
|
{
|
|
462
|
-
"
|
|
523
|
+
"in": "query",
|
|
524
|
+
"name": "dry_run",
|
|
525
|
+
"description": "Dry Run mode = return matched entities but don't update them.",
|
|
526
|
+
"required": false,
|
|
527
|
+
"schema": {
|
|
528
|
+
"type": "boolean",
|
|
529
|
+
"default": false
|
|
530
|
+
}
|
|
463
531
|
},
|
|
464
532
|
{
|
|
465
|
-
"
|
|
533
|
+
"in": "query",
|
|
534
|
+
"name": "async",
|
|
535
|
+
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
536
|
+
"required": false,
|
|
537
|
+
"schema": {
|
|
538
|
+
"type": "boolean",
|
|
539
|
+
"default": false
|
|
540
|
+
}
|
|
466
541
|
}
|
|
467
542
|
],
|
|
468
543
|
"requestBody": {
|
|
@@ -530,13 +605,31 @@
|
|
|
530
605
|
],
|
|
531
606
|
"parameters": [
|
|
532
607
|
{
|
|
533
|
-
"
|
|
608
|
+
"in": "path",
|
|
609
|
+
"name": "slug",
|
|
610
|
+
"description": "Entity Type",
|
|
611
|
+
"required": true,
|
|
612
|
+
"schema": {
|
|
613
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
614
|
+
}
|
|
534
615
|
},
|
|
535
616
|
{
|
|
536
|
-
"
|
|
617
|
+
"in": "path",
|
|
618
|
+
"name": "id",
|
|
619
|
+
"description": "Entity id",
|
|
620
|
+
"required": true,
|
|
621
|
+
"schema": {
|
|
622
|
+
"$ref": "#/components/schemas/EntityId"
|
|
623
|
+
}
|
|
537
624
|
},
|
|
538
625
|
{
|
|
539
|
-
"
|
|
626
|
+
"in": "query",
|
|
627
|
+
"name": "hydrate",
|
|
628
|
+
"description": "When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.",
|
|
629
|
+
"schema": {
|
|
630
|
+
"default": false,
|
|
631
|
+
"type": "boolean"
|
|
632
|
+
}
|
|
540
633
|
}
|
|
541
634
|
],
|
|
542
635
|
"responses": {
|
|
@@ -572,16 +665,41 @@
|
|
|
572
665
|
],
|
|
573
666
|
"parameters": [
|
|
574
667
|
{
|
|
575
|
-
"
|
|
668
|
+
"in": "path",
|
|
669
|
+
"name": "slug",
|
|
670
|
+
"description": "Entity Type",
|
|
671
|
+
"required": true,
|
|
672
|
+
"schema": {
|
|
673
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
674
|
+
}
|
|
576
675
|
},
|
|
577
676
|
{
|
|
578
|
-
"
|
|
677
|
+
"in": "path",
|
|
678
|
+
"name": "id",
|
|
679
|
+
"description": "Entity id",
|
|
680
|
+
"required": true,
|
|
681
|
+
"schema": {
|
|
682
|
+
"$ref": "#/components/schemas/EntityId"
|
|
683
|
+
}
|
|
579
684
|
},
|
|
580
685
|
{
|
|
581
|
-
"
|
|
686
|
+
"in": "query",
|
|
687
|
+
"name": "activity_id",
|
|
688
|
+
"description": "Activity to include in event feed",
|
|
689
|
+
"required": false,
|
|
690
|
+
"schema": {
|
|
691
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
692
|
+
}
|
|
582
693
|
},
|
|
583
694
|
{
|
|
584
|
-
"
|
|
695
|
+
"in": "query",
|
|
696
|
+
"name": "async",
|
|
697
|
+
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
698
|
+
"required": false,
|
|
699
|
+
"schema": {
|
|
700
|
+
"type": "boolean",
|
|
701
|
+
"default": false
|
|
702
|
+
}
|
|
585
703
|
}
|
|
586
704
|
],
|
|
587
705
|
"requestBody": {
|
|
@@ -616,19 +734,51 @@
|
|
|
616
734
|
],
|
|
617
735
|
"parameters": [
|
|
618
736
|
{
|
|
619
|
-
"
|
|
737
|
+
"in": "path",
|
|
738
|
+
"name": "slug",
|
|
739
|
+
"description": "Entity Schema",
|
|
740
|
+
"required": true,
|
|
741
|
+
"schema": {
|
|
742
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
743
|
+
}
|
|
620
744
|
},
|
|
621
745
|
{
|
|
622
|
-
"
|
|
746
|
+
"in": "path",
|
|
747
|
+
"name": "id",
|
|
748
|
+
"description": "Entity Id",
|
|
749
|
+
"required": true,
|
|
750
|
+
"schema": {
|
|
751
|
+
"$ref": "#/components/schemas/EntityId"
|
|
752
|
+
}
|
|
623
753
|
},
|
|
624
754
|
{
|
|
625
|
-
"
|
|
755
|
+
"in": "query",
|
|
756
|
+
"name": "activity_id",
|
|
757
|
+
"description": "Activity to include in event feed",
|
|
758
|
+
"required": false,
|
|
759
|
+
"schema": {
|
|
760
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
761
|
+
}
|
|
626
762
|
},
|
|
627
763
|
{
|
|
628
|
-
"
|
|
764
|
+
"in": "query",
|
|
765
|
+
"name": "dry_run",
|
|
766
|
+
"description": "Dry Run mode = returns the patch result but doesn't perform the patch.",
|
|
767
|
+
"required": false,
|
|
768
|
+
"schema": {
|
|
769
|
+
"type": "boolean",
|
|
770
|
+
"default": false
|
|
771
|
+
}
|
|
629
772
|
},
|
|
630
773
|
{
|
|
631
|
-
"
|
|
774
|
+
"in": "query",
|
|
775
|
+
"name": "async",
|
|
776
|
+
"description": "Don't wait for the patch entity to become available in Search API. Useful for large migrations",
|
|
777
|
+
"required": false,
|
|
778
|
+
"schema": {
|
|
779
|
+
"type": "boolean",
|
|
780
|
+
"default": false
|
|
781
|
+
}
|
|
632
782
|
}
|
|
633
783
|
],
|
|
634
784
|
"requestBody": {
|
|
@@ -667,13 +817,30 @@
|
|
|
667
817
|
],
|
|
668
818
|
"parameters": [
|
|
669
819
|
{
|
|
670
|
-
"
|
|
820
|
+
"in": "path",
|
|
821
|
+
"name": "slug",
|
|
822
|
+
"description": "Entity Type",
|
|
823
|
+
"required": true,
|
|
824
|
+
"schema": {
|
|
825
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
826
|
+
}
|
|
671
827
|
},
|
|
672
828
|
{
|
|
673
|
-
"
|
|
829
|
+
"in": "path",
|
|
830
|
+
"name": "id",
|
|
831
|
+
"required": true,
|
|
832
|
+
"schema": {
|
|
833
|
+
"$ref": "#/components/schemas/EntityId"
|
|
834
|
+
}
|
|
674
835
|
},
|
|
675
836
|
{
|
|
676
|
-
"
|
|
837
|
+
"in": "query",
|
|
838
|
+
"name": "activity_id",
|
|
839
|
+
"description": "Activity to include in event feed",
|
|
840
|
+
"required": false,
|
|
841
|
+
"schema": {
|
|
842
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
843
|
+
}
|
|
677
844
|
}
|
|
678
845
|
],
|
|
679
846
|
"responses": {
|
|
@@ -826,7 +993,13 @@
|
|
|
826
993
|
],
|
|
827
994
|
"parameters": [
|
|
828
995
|
{
|
|
829
|
-
"
|
|
996
|
+
"in": "path",
|
|
997
|
+
"name": "id",
|
|
998
|
+
"description": "Activity Id",
|
|
999
|
+
"required": true,
|
|
1000
|
+
"schema": {
|
|
1001
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
1002
|
+
}
|
|
830
1003
|
},
|
|
831
1004
|
{
|
|
832
1005
|
"in": "query",
|
|
@@ -874,7 +1047,13 @@
|
|
|
874
1047
|
],
|
|
875
1048
|
"parameters": [
|
|
876
1049
|
{
|
|
877
|
-
"
|
|
1050
|
+
"in": "path",
|
|
1051
|
+
"name": "id",
|
|
1052
|
+
"description": "Activity Id",
|
|
1053
|
+
"required": true,
|
|
1054
|
+
"schema": {
|
|
1055
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
1056
|
+
}
|
|
878
1057
|
},
|
|
879
1058
|
{
|
|
880
1059
|
"in": "query",
|
|
@@ -914,10 +1093,22 @@
|
|
|
914
1093
|
],
|
|
915
1094
|
"parameters": [
|
|
916
1095
|
{
|
|
917
|
-
"
|
|
1096
|
+
"in": "path",
|
|
1097
|
+
"name": "slug",
|
|
1098
|
+
"description": "Entity Type",
|
|
1099
|
+
"required": true,
|
|
1100
|
+
"schema": {
|
|
1101
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1102
|
+
}
|
|
918
1103
|
},
|
|
919
1104
|
{
|
|
920
|
-
"
|
|
1105
|
+
"in": "path",
|
|
1106
|
+
"name": "id",
|
|
1107
|
+
"description": "Entity id",
|
|
1108
|
+
"required": true,
|
|
1109
|
+
"schema": {
|
|
1110
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1111
|
+
}
|
|
921
1112
|
},
|
|
922
1113
|
{
|
|
923
1114
|
"in": "query",
|
|
@@ -938,7 +1129,14 @@
|
|
|
938
1129
|
}
|
|
939
1130
|
},
|
|
940
1131
|
{
|
|
941
|
-
"
|
|
1132
|
+
"in": "query",
|
|
1133
|
+
"name": "from",
|
|
1134
|
+
"description": "start from page",
|
|
1135
|
+
"schema": {
|
|
1136
|
+
"type": "integer",
|
|
1137
|
+
"minimum": 0,
|
|
1138
|
+
"default": 0
|
|
1139
|
+
}
|
|
942
1140
|
},
|
|
943
1141
|
{
|
|
944
1142
|
"in": "query",
|
|
@@ -1005,19 +1203,50 @@
|
|
|
1005
1203
|
],
|
|
1006
1204
|
"parameters": [
|
|
1007
1205
|
{
|
|
1008
|
-
"
|
|
1206
|
+
"in": "path",
|
|
1207
|
+
"name": "slug",
|
|
1208
|
+
"description": "Entity Type",
|
|
1209
|
+
"required": true,
|
|
1210
|
+
"schema": {
|
|
1211
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1212
|
+
}
|
|
1009
1213
|
},
|
|
1010
1214
|
{
|
|
1011
|
-
"
|
|
1215
|
+
"in": "path",
|
|
1216
|
+
"name": "id",
|
|
1217
|
+
"description": "Entity id",
|
|
1218
|
+
"required": true,
|
|
1219
|
+
"schema": {
|
|
1220
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1221
|
+
}
|
|
1012
1222
|
},
|
|
1013
1223
|
{
|
|
1014
|
-
"
|
|
1224
|
+
"in": "query",
|
|
1225
|
+
"name": "hydrate",
|
|
1226
|
+
"description": "When true, expand relation items with full blown entities.",
|
|
1227
|
+
"schema": {
|
|
1228
|
+
"default": false,
|
|
1229
|
+
"type": "boolean"
|
|
1230
|
+
}
|
|
1015
1231
|
},
|
|
1016
1232
|
{
|
|
1017
|
-
"
|
|
1233
|
+
"in": "query",
|
|
1234
|
+
"name": "include_reverse",
|
|
1235
|
+
"description": "When true, includes reverse relations in response (other entities pointing to this entity)",
|
|
1236
|
+
"schema": {
|
|
1237
|
+
"default": false,
|
|
1238
|
+
"type": "boolean"
|
|
1239
|
+
}
|
|
1018
1240
|
},
|
|
1019
1241
|
{
|
|
1020
|
-
"
|
|
1242
|
+
"in": "query",
|
|
1243
|
+
"name": "from",
|
|
1244
|
+
"description": "Starting page number",
|
|
1245
|
+
"schema": {
|
|
1246
|
+
"type": "integer",
|
|
1247
|
+
"minimum": 0,
|
|
1248
|
+
"default": 0
|
|
1249
|
+
}
|
|
1021
1250
|
},
|
|
1022
1251
|
{
|
|
1023
1252
|
"in": "query",
|
|
@@ -1032,10 +1261,32 @@
|
|
|
1032
1261
|
}
|
|
1033
1262
|
},
|
|
1034
1263
|
{
|
|
1035
|
-
"
|
|
1264
|
+
"in": "query",
|
|
1265
|
+
"name": "include_schemas",
|
|
1266
|
+
"description": "Filter results to only include schemas",
|
|
1267
|
+
"required": false,
|
|
1268
|
+
"style": "form",
|
|
1269
|
+
"explode": false,
|
|
1270
|
+
"schema": {
|
|
1271
|
+
"type": "array",
|
|
1272
|
+
"items": {
|
|
1273
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1274
|
+
}
|
|
1275
|
+
}
|
|
1036
1276
|
},
|
|
1037
1277
|
{
|
|
1038
|
-
"
|
|
1278
|
+
"in": "query",
|
|
1279
|
+
"name": "exclude_schemas",
|
|
1280
|
+
"description": "Filter results to exclude schemas",
|
|
1281
|
+
"required": false,
|
|
1282
|
+
"style": "form",
|
|
1283
|
+
"explode": false,
|
|
1284
|
+
"schema": {
|
|
1285
|
+
"type": "array",
|
|
1286
|
+
"items": {
|
|
1287
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1039
1290
|
}
|
|
1040
1291
|
],
|
|
1041
1292
|
"responses": {
|
|
@@ -1095,16 +1346,41 @@
|
|
|
1095
1346
|
],
|
|
1096
1347
|
"parameters": [
|
|
1097
1348
|
{
|
|
1098
|
-
"
|
|
1349
|
+
"in": "path",
|
|
1350
|
+
"name": "slug",
|
|
1351
|
+
"description": "Entity Type",
|
|
1352
|
+
"required": true,
|
|
1353
|
+
"schema": {
|
|
1354
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1355
|
+
}
|
|
1099
1356
|
},
|
|
1100
1357
|
{
|
|
1101
|
-
"
|
|
1358
|
+
"in": "path",
|
|
1359
|
+
"name": "id",
|
|
1360
|
+
"description": "Entity id",
|
|
1361
|
+
"required": true,
|
|
1362
|
+
"schema": {
|
|
1363
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1364
|
+
}
|
|
1102
1365
|
},
|
|
1103
1366
|
{
|
|
1104
|
-
"
|
|
1367
|
+
"in": "query",
|
|
1368
|
+
"name": "async",
|
|
1369
|
+
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
1370
|
+
"required": false,
|
|
1371
|
+
"schema": {
|
|
1372
|
+
"type": "boolean",
|
|
1373
|
+
"default": false
|
|
1374
|
+
}
|
|
1105
1375
|
},
|
|
1106
1376
|
{
|
|
1107
|
-
"
|
|
1377
|
+
"in": "query",
|
|
1378
|
+
"name": "activity_id",
|
|
1379
|
+
"description": "Activity to include in event feed",
|
|
1380
|
+
"required": false,
|
|
1381
|
+
"schema": {
|
|
1382
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
1383
|
+
}
|
|
1108
1384
|
}
|
|
1109
1385
|
],
|
|
1110
1386
|
"requestBody": {
|
|
@@ -1160,13 +1436,31 @@
|
|
|
1160
1436
|
],
|
|
1161
1437
|
"parameters": [
|
|
1162
1438
|
{
|
|
1163
|
-
"
|
|
1439
|
+
"in": "path",
|
|
1440
|
+
"name": "slug",
|
|
1441
|
+
"description": "Entity Type",
|
|
1442
|
+
"required": true,
|
|
1443
|
+
"schema": {
|
|
1444
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1445
|
+
}
|
|
1164
1446
|
},
|
|
1165
1447
|
{
|
|
1166
|
-
"
|
|
1448
|
+
"in": "path",
|
|
1449
|
+
"name": "id",
|
|
1450
|
+
"description": "Entity id",
|
|
1451
|
+
"required": true,
|
|
1452
|
+
"schema": {
|
|
1453
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1454
|
+
}
|
|
1167
1455
|
},
|
|
1168
1456
|
{
|
|
1169
|
-
"
|
|
1457
|
+
"in": "query",
|
|
1458
|
+
"name": "hydrate",
|
|
1459
|
+
"description": "When true, expand relation items with full blown entities.",
|
|
1460
|
+
"schema": {
|
|
1461
|
+
"default": false,
|
|
1462
|
+
"type": "boolean"
|
|
1463
|
+
}
|
|
1170
1464
|
},
|
|
1171
1465
|
{
|
|
1172
1466
|
"in": "query",
|
|
@@ -1177,10 +1471,23 @@
|
|
|
1177
1471
|
}
|
|
1178
1472
|
},
|
|
1179
1473
|
{
|
|
1180
|
-
"
|
|
1474
|
+
"in": "query",
|
|
1475
|
+
"name": "include_reverse",
|
|
1476
|
+
"description": "When true, includes reverse relations in response (other entities pointing to this entity)",
|
|
1477
|
+
"schema": {
|
|
1478
|
+
"default": false,
|
|
1479
|
+
"type": "boolean"
|
|
1480
|
+
}
|
|
1181
1481
|
},
|
|
1182
1482
|
{
|
|
1183
|
-
"
|
|
1483
|
+
"in": "query",
|
|
1484
|
+
"name": "from",
|
|
1485
|
+
"description": "Starting page number",
|
|
1486
|
+
"schema": {
|
|
1487
|
+
"type": "integer",
|
|
1488
|
+
"minimum": 0,
|
|
1489
|
+
"default": 0
|
|
1490
|
+
}
|
|
1184
1491
|
},
|
|
1185
1492
|
{
|
|
1186
1493
|
"in": "query",
|
|
@@ -1189,7 +1496,6 @@
|
|
|
1189
1496
|
"schema": {
|
|
1190
1497
|
"type": "integer",
|
|
1191
1498
|
"minimum": 1,
|
|
1192
|
-
"maximum": 1000,
|
|
1193
1499
|
"default": 50
|
|
1194
1500
|
}
|
|
1195
1501
|
},
|
|
@@ -1234,19 +1540,50 @@
|
|
|
1234
1540
|
],
|
|
1235
1541
|
"parameters": [
|
|
1236
1542
|
{
|
|
1237
|
-
"
|
|
1543
|
+
"in": "path",
|
|
1544
|
+
"name": "slug",
|
|
1545
|
+
"description": "Entity Type",
|
|
1546
|
+
"required": true,
|
|
1547
|
+
"schema": {
|
|
1548
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1549
|
+
}
|
|
1238
1550
|
},
|
|
1239
1551
|
{
|
|
1240
|
-
"
|
|
1552
|
+
"in": "path",
|
|
1553
|
+
"name": "id",
|
|
1554
|
+
"description": "Entity id",
|
|
1555
|
+
"required": true,
|
|
1556
|
+
"schema": {
|
|
1557
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1558
|
+
}
|
|
1241
1559
|
},
|
|
1242
1560
|
{
|
|
1243
|
-
"
|
|
1561
|
+
"in": "query",
|
|
1562
|
+
"name": "hydrate",
|
|
1563
|
+
"description": "When true, expand relation items with full blown entities.",
|
|
1564
|
+
"schema": {
|
|
1565
|
+
"default": false,
|
|
1566
|
+
"type": "boolean"
|
|
1567
|
+
}
|
|
1244
1568
|
},
|
|
1245
1569
|
{
|
|
1246
|
-
"
|
|
1570
|
+
"in": "query",
|
|
1571
|
+
"name": "include_reverse",
|
|
1572
|
+
"description": "When true, includes reverse relations in response (other entities pointing to this entity)",
|
|
1573
|
+
"schema": {
|
|
1574
|
+
"default": false,
|
|
1575
|
+
"type": "boolean"
|
|
1576
|
+
}
|
|
1247
1577
|
},
|
|
1248
1578
|
{
|
|
1249
|
-
"
|
|
1579
|
+
"in": "query",
|
|
1580
|
+
"name": "from",
|
|
1581
|
+
"description": "Starting page number",
|
|
1582
|
+
"schema": {
|
|
1583
|
+
"type": "integer",
|
|
1584
|
+
"minimum": 0,
|
|
1585
|
+
"default": 0
|
|
1586
|
+
}
|
|
1250
1587
|
},
|
|
1251
1588
|
{
|
|
1252
1589
|
"in": "query",
|
|
@@ -1261,10 +1598,32 @@
|
|
|
1261
1598
|
}
|
|
1262
1599
|
},
|
|
1263
1600
|
{
|
|
1264
|
-
"
|
|
1601
|
+
"in": "query",
|
|
1602
|
+
"name": "include_schemas",
|
|
1603
|
+
"description": "Filter results to only include schemas",
|
|
1604
|
+
"required": false,
|
|
1605
|
+
"style": "form",
|
|
1606
|
+
"explode": false,
|
|
1607
|
+
"schema": {
|
|
1608
|
+
"type": "array",
|
|
1609
|
+
"items": {
|
|
1610
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1265
1613
|
},
|
|
1266
1614
|
{
|
|
1267
|
-
"
|
|
1615
|
+
"in": "query",
|
|
1616
|
+
"name": "exclude_schemas",
|
|
1617
|
+
"description": "Filter results to exclude schemas",
|
|
1618
|
+
"required": false,
|
|
1619
|
+
"style": "form",
|
|
1620
|
+
"explode": false,
|
|
1621
|
+
"schema": {
|
|
1622
|
+
"type": "array",
|
|
1623
|
+
"items": {
|
|
1624
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1625
|
+
}
|
|
1626
|
+
}
|
|
1268
1627
|
}
|
|
1269
1628
|
],
|
|
1270
1629
|
"responses": {
|
|
@@ -1291,13 +1650,37 @@
|
|
|
1291
1650
|
],
|
|
1292
1651
|
"parameters": [
|
|
1293
1652
|
{
|
|
1294
|
-
"
|
|
1653
|
+
"in": "path",
|
|
1654
|
+
"name": "slug",
|
|
1655
|
+
"description": "Entity Schema",
|
|
1656
|
+
"required": true,
|
|
1657
|
+
"schema": {
|
|
1658
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1659
|
+
}
|
|
1295
1660
|
},
|
|
1296
1661
|
{
|
|
1297
|
-
"
|
|
1662
|
+
"in": "path",
|
|
1663
|
+
"name": "id",
|
|
1664
|
+
"description": "Entity id",
|
|
1665
|
+
"required": true,
|
|
1666
|
+
"schema": {
|
|
1667
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1668
|
+
}
|
|
1298
1669
|
},
|
|
1299
1670
|
{
|
|
1300
|
-
"
|
|
1671
|
+
"in": "query",
|
|
1672
|
+
"name": "exclude_schemas",
|
|
1673
|
+
"description": "To be excluded from the count by given schemas",
|
|
1674
|
+
"required": false,
|
|
1675
|
+
"style": "form",
|
|
1676
|
+
"example": "<url>/count?exclude_schemas=file,message",
|
|
1677
|
+
"explode": false,
|
|
1678
|
+
"schema": {
|
|
1679
|
+
"type": "array",
|
|
1680
|
+
"items": {
|
|
1681
|
+
"type": "string"
|
|
1682
|
+
}
|
|
1683
|
+
}
|
|
1301
1684
|
}
|
|
1302
1685
|
],
|
|
1303
1686
|
"responses": {
|
|
@@ -1324,10 +1707,22 @@
|
|
|
1324
1707
|
],
|
|
1325
1708
|
"parameters": [
|
|
1326
1709
|
{
|
|
1327
|
-
"
|
|
1710
|
+
"in": "path",
|
|
1711
|
+
"name": "slug",
|
|
1712
|
+
"description": "Entity Type",
|
|
1713
|
+
"required": true,
|
|
1714
|
+
"schema": {
|
|
1715
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1716
|
+
}
|
|
1328
1717
|
},
|
|
1329
1718
|
{
|
|
1330
|
-
"
|
|
1719
|
+
"in": "path",
|
|
1720
|
+
"name": "id",
|
|
1721
|
+
"description": "Entity id",
|
|
1722
|
+
"required": true,
|
|
1723
|
+
"schema": {
|
|
1724
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1725
|
+
}
|
|
1331
1726
|
},
|
|
1332
1727
|
{
|
|
1333
1728
|
"in": "path",
|
|
@@ -1348,10 +1743,23 @@
|
|
|
1348
1743
|
}
|
|
1349
1744
|
},
|
|
1350
1745
|
{
|
|
1351
|
-
"
|
|
1746
|
+
"in": "query",
|
|
1747
|
+
"name": "async",
|
|
1748
|
+
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
1749
|
+
"required": false,
|
|
1750
|
+
"schema": {
|
|
1751
|
+
"type": "boolean",
|
|
1752
|
+
"default": false
|
|
1753
|
+
}
|
|
1352
1754
|
},
|
|
1353
1755
|
{
|
|
1354
|
-
"
|
|
1756
|
+
"in": "query",
|
|
1757
|
+
"name": "activity_id",
|
|
1758
|
+
"description": "Activity to include in event feed",
|
|
1759
|
+
"required": false,
|
|
1760
|
+
"schema": {
|
|
1761
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
1762
|
+
}
|
|
1355
1763
|
}
|
|
1356
1764
|
],
|
|
1357
1765
|
"requestBody": {
|
|
@@ -1399,10 +1807,22 @@
|
|
|
1399
1807
|
],
|
|
1400
1808
|
"parameters": [
|
|
1401
1809
|
{
|
|
1402
|
-
"
|
|
1810
|
+
"in": "path",
|
|
1811
|
+
"name": "slug",
|
|
1812
|
+
"description": "Entity Type",
|
|
1813
|
+
"required": true,
|
|
1814
|
+
"schema": {
|
|
1815
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1816
|
+
}
|
|
1403
1817
|
},
|
|
1404
1818
|
{
|
|
1405
|
-
"
|
|
1819
|
+
"in": "path",
|
|
1820
|
+
"name": "id",
|
|
1821
|
+
"description": "Entity id",
|
|
1822
|
+
"required": true,
|
|
1823
|
+
"schema": {
|
|
1824
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1825
|
+
}
|
|
1406
1826
|
},
|
|
1407
1827
|
{
|
|
1408
1828
|
"in": "path",
|
|
@@ -1423,10 +1843,23 @@
|
|
|
1423
1843
|
}
|
|
1424
1844
|
},
|
|
1425
1845
|
{
|
|
1426
|
-
"
|
|
1846
|
+
"in": "query",
|
|
1847
|
+
"name": "async",
|
|
1848
|
+
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
1849
|
+
"required": false,
|
|
1850
|
+
"schema": {
|
|
1851
|
+
"type": "boolean",
|
|
1852
|
+
"default": false
|
|
1853
|
+
}
|
|
1427
1854
|
},
|
|
1428
1855
|
{
|
|
1429
|
-
"
|
|
1856
|
+
"in": "query",
|
|
1857
|
+
"name": "activity_id",
|
|
1858
|
+
"description": "Activity to include in event feed",
|
|
1859
|
+
"required": false,
|
|
1860
|
+
"schema": {
|
|
1861
|
+
"$ref": "#/components/schemas/ActivityId"
|
|
1862
|
+
}
|
|
1430
1863
|
}
|
|
1431
1864
|
],
|
|
1432
1865
|
"responses": {
|
|
@@ -1591,7 +2024,13 @@
|
|
|
1591
2024
|
],
|
|
1592
2025
|
"parameters": [
|
|
1593
2026
|
{
|
|
1594
|
-
"
|
|
2027
|
+
"in": "path",
|
|
2028
|
+
"name": "id",
|
|
2029
|
+
"description": "View id",
|
|
2030
|
+
"required": true,
|
|
2031
|
+
"schema": {
|
|
2032
|
+
"$ref": "#/components/schemas/SavedViewId"
|
|
2033
|
+
}
|
|
1595
2034
|
}
|
|
1596
2035
|
],
|
|
1597
2036
|
"responses": {
|
|
@@ -1621,7 +2060,13 @@
|
|
|
1621
2060
|
],
|
|
1622
2061
|
"parameters": [
|
|
1623
2062
|
{
|
|
1624
|
-
"
|
|
2063
|
+
"in": "path",
|
|
2064
|
+
"name": "id",
|
|
2065
|
+
"description": "View id",
|
|
2066
|
+
"required": true,
|
|
2067
|
+
"schema": {
|
|
2068
|
+
"$ref": "#/components/schemas/SavedViewId"
|
|
2069
|
+
}
|
|
1625
2070
|
}
|
|
1626
2071
|
],
|
|
1627
2072
|
"requestBody": {
|
|
@@ -1652,7 +2097,13 @@
|
|
|
1652
2097
|
"description": "Deletes a saved view",
|
|
1653
2098
|
"parameters": [
|
|
1654
2099
|
{
|
|
1655
|
-
"
|
|
2100
|
+
"in": "path",
|
|
2101
|
+
"name": "id",
|
|
2102
|
+
"description": "View id",
|
|
2103
|
+
"required": true,
|
|
2104
|
+
"schema": {
|
|
2105
|
+
"$ref": "#/components/schemas/SavedViewId"
|
|
2106
|
+
}
|
|
1656
2107
|
}
|
|
1657
2108
|
],
|
|
1658
2109
|
"tags": [
|
|
@@ -1735,7 +2186,13 @@
|
|
|
1735
2186
|
],
|
|
1736
2187
|
"parameters": [
|
|
1737
2188
|
{
|
|
1738
|
-
"
|
|
2189
|
+
"in": "path",
|
|
2190
|
+
"name": "taxonomySlug",
|
|
2191
|
+
"description": "Taxonomy slug to return taxonomy for",
|
|
2192
|
+
"schema": {
|
|
2193
|
+
"$ref": "#/components/schemas/TaxonomySlug"
|
|
2194
|
+
},
|
|
2195
|
+
"required": true
|
|
1739
2196
|
}
|
|
1740
2197
|
],
|
|
1741
2198
|
"responses": {
|
|
@@ -1762,7 +2219,13 @@
|
|
|
1762
2219
|
],
|
|
1763
2220
|
"parameters": [
|
|
1764
2221
|
{
|
|
1765
|
-
"
|
|
2222
|
+
"in": "path",
|
|
2223
|
+
"name": "taxonomySlug",
|
|
2224
|
+
"description": "Limit results to slug",
|
|
2225
|
+
"schema": {
|
|
2226
|
+
"type": "string"
|
|
2227
|
+
},
|
|
2228
|
+
"required": true
|
|
1766
2229
|
},
|
|
1767
2230
|
{
|
|
1768
2231
|
"in": "query",
|
|
@@ -1813,7 +2276,13 @@
|
|
|
1813
2276
|
],
|
|
1814
2277
|
"parameters": [
|
|
1815
2278
|
{
|
|
1816
|
-
"
|
|
2279
|
+
"in": "query",
|
|
2280
|
+
"name": "taxonomySlug",
|
|
2281
|
+
"description": "Taxonomy slug",
|
|
2282
|
+
"schema": {
|
|
2283
|
+
"type": "string"
|
|
2284
|
+
},
|
|
2285
|
+
"required": true
|
|
1817
2286
|
}
|
|
1818
2287
|
],
|
|
1819
2288
|
"requestBody": {
|
|
@@ -1865,7 +2334,13 @@
|
|
|
1865
2334
|
],
|
|
1866
2335
|
"parameters": [
|
|
1867
2336
|
{
|
|
1868
|
-
"
|
|
2337
|
+
"in": "path",
|
|
2338
|
+
"name": "taxonomySlug",
|
|
2339
|
+
"description": "Taxonomy slug",
|
|
2340
|
+
"schema": {
|
|
2341
|
+
"type": "string"
|
|
2342
|
+
},
|
|
2343
|
+
"required": true
|
|
1869
2344
|
}
|
|
1870
2345
|
],
|
|
1871
2346
|
"requestBody": {
|
|
@@ -4747,148 +5222,6 @@
|
|
|
4747
5222
|
}
|
|
4748
5223
|
}
|
|
4749
5224
|
},
|
|
4750
|
-
"parameters": {
|
|
4751
|
-
"EntityIdPathParam": {
|
|
4752
|
-
"name": "id",
|
|
4753
|
-
"description": "Entity id",
|
|
4754
|
-
"in": "path",
|
|
4755
|
-
"required": true,
|
|
4756
|
-
"schema": {
|
|
4757
|
-
"$ref": "#/components/schemas/EntityId"
|
|
4758
|
-
}
|
|
4759
|
-
},
|
|
4760
|
-
"EntitySlugPathParam": {
|
|
4761
|
-
"name": "slug",
|
|
4762
|
-
"description": "Entity Type",
|
|
4763
|
-
"in": "path",
|
|
4764
|
-
"required": true,
|
|
4765
|
-
"schema": {
|
|
4766
|
-
"$ref": "#/components/schemas/EntitySlug"
|
|
4767
|
-
}
|
|
4768
|
-
},
|
|
4769
|
-
"TaxonomySlugQueryParam": {
|
|
4770
|
-
"name": "taxonomySlug",
|
|
4771
|
-
"description": "Taxonomy slug",
|
|
4772
|
-
"in": "query",
|
|
4773
|
-
"schema": {
|
|
4774
|
-
"type": "string"
|
|
4775
|
-
},
|
|
4776
|
-
"required": true
|
|
4777
|
-
},
|
|
4778
|
-
"TaxonomySlugPathParam": {
|
|
4779
|
-
"name": "taxonomySlug",
|
|
4780
|
-
"description": "Taxonomy slug",
|
|
4781
|
-
"in": "path",
|
|
4782
|
-
"required": true,
|
|
4783
|
-
"schema": {
|
|
4784
|
-
"type": "string"
|
|
4785
|
-
}
|
|
4786
|
-
},
|
|
4787
|
-
"SavedViewIdPathParam": {
|
|
4788
|
-
"name": "id",
|
|
4789
|
-
"description": "View id",
|
|
4790
|
-
"in": "path",
|
|
4791
|
-
"required": true,
|
|
4792
|
-
"schema": {
|
|
4793
|
-
"$ref": "#/components/schemas/SavedViewId"
|
|
4794
|
-
}
|
|
4795
|
-
},
|
|
4796
|
-
"AsyncOperationQueryParam": {
|
|
4797
|
-
"name": "async",
|
|
4798
|
-
"description": "Don't wait for updated entity to become available in Search API. Useful for large migrations",
|
|
4799
|
-
"in": "query",
|
|
4800
|
-
"required": false,
|
|
4801
|
-
"schema": {
|
|
4802
|
-
"type": "boolean",
|
|
4803
|
-
"default": false
|
|
4804
|
-
}
|
|
4805
|
-
},
|
|
4806
|
-
"HydrateEntitiesQueryParam": {
|
|
4807
|
-
"name": "hydrate",
|
|
4808
|
-
"description": "When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.",
|
|
4809
|
-
"in": "query",
|
|
4810
|
-
"schema": {
|
|
4811
|
-
"default": false,
|
|
4812
|
-
"type": "boolean"
|
|
4813
|
-
}
|
|
4814
|
-
},
|
|
4815
|
-
"ActivityIdQueryParam": {
|
|
4816
|
-
"name": "activity_id",
|
|
4817
|
-
"description": "Activity to include in event feed",
|
|
4818
|
-
"in": "query",
|
|
4819
|
-
"required": false,
|
|
4820
|
-
"schema": {
|
|
4821
|
-
"$ref": "#/components/schemas/ActivityId"
|
|
4822
|
-
}
|
|
4823
|
-
},
|
|
4824
|
-
"ActivityIdPathParam": {
|
|
4825
|
-
"name": "id",
|
|
4826
|
-
"description": "Activity Id",
|
|
4827
|
-
"in": "path",
|
|
4828
|
-
"required": true,
|
|
4829
|
-
"schema": {
|
|
4830
|
-
"$ref": "#/components/schemas/ActivityId"
|
|
4831
|
-
}
|
|
4832
|
-
},
|
|
4833
|
-
"FromPageQueryParam": {
|
|
4834
|
-
"name": "from",
|
|
4835
|
-
"description": "Starting page number",
|
|
4836
|
-
"in": "query",
|
|
4837
|
-
"schema": {
|
|
4838
|
-
"type": "integer",
|
|
4839
|
-
"minimum": 0,
|
|
4840
|
-
"default": 0
|
|
4841
|
-
}
|
|
4842
|
-
},
|
|
4843
|
-
"IncludeReverseQueryParam": {
|
|
4844
|
-
"name": "include_reverse",
|
|
4845
|
-
"description": "When true, includes reverse relations in response (other entities pointing to this entity)",
|
|
4846
|
-
"in": "query",
|
|
4847
|
-
"schema": {
|
|
4848
|
-
"default": false,
|
|
4849
|
-
"type": "boolean"
|
|
4850
|
-
}
|
|
4851
|
-
},
|
|
4852
|
-
"IncludeSchemasQueryParam": {
|
|
4853
|
-
"name": "include_schemas",
|
|
4854
|
-
"description": "Filter results to only include schemas",
|
|
4855
|
-
"in": "query",
|
|
4856
|
-
"required": false,
|
|
4857
|
-
"style": "form",
|
|
4858
|
-
"explode": false,
|
|
4859
|
-
"schema": {
|
|
4860
|
-
"type": "array",
|
|
4861
|
-
"items": {
|
|
4862
|
-
"$ref": "#/components/schemas/EntitySlug"
|
|
4863
|
-
}
|
|
4864
|
-
}
|
|
4865
|
-
},
|
|
4866
|
-
"ExcludeSchemasQueryParam": {
|
|
4867
|
-
"name": "exclude_schemas",
|
|
4868
|
-
"description": "Filter results to exclude schemas",
|
|
4869
|
-
"in": "query",
|
|
4870
|
-
"required": false,
|
|
4871
|
-
"style": "form",
|
|
4872
|
-
"explode": false,
|
|
4873
|
-
"example": "<url>/<operation>?exclude_schemas=file,message",
|
|
4874
|
-
"schema": {
|
|
4875
|
-
"type": "array",
|
|
4876
|
-
"items": {
|
|
4877
|
-
"$ref": "#/components/schemas/EntitySlug"
|
|
4878
|
-
}
|
|
4879
|
-
}
|
|
4880
|
-
},
|
|
4881
|
-
"DryRunQueryParam": {
|
|
4882
|
-
"name": "dry_run",
|
|
4883
|
-
"description": "Dry Run mode = return results but does not perform the operation.",
|
|
4884
|
-
"in": "query",
|
|
4885
|
-
"required": false,
|
|
4886
|
-
"schema": {
|
|
4887
|
-
"type": "boolean",
|
|
4888
|
-
"default": false
|
|
4889
|
-
}
|
|
4890
|
-
}
|
|
4891
|
-
},
|
|
4892
5225
|
"examples": {
|
|
4893
5226
|
"TaxEntity": {
|
|
4894
5227
|
"description": "Example of a Tax Rate entity",
|
|
@@ -5504,5 +5837,10 @@
|
|
|
5504
5837
|
}
|
|
5505
5838
|
}
|
|
5506
5839
|
}
|
|
5507
|
-
}
|
|
5840
|
+
},
|
|
5841
|
+
"servers": [
|
|
5842
|
+
{
|
|
5843
|
+
"url": "https://entity.sls.epilot.io"
|
|
5844
|
+
}
|
|
5845
|
+
]
|
|
5508
5846
|
}
|