@epilot/entity-client 4.16.1 → 4.17.0

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.
Files changed (12) hide show
  1. package/dist/client.d.ts +0 -0
  2. package/dist/client.js +0 -0
  3. package/dist/definition.d.ts +0 -0
  4. package/dist/definition.js +1 -1
  5. package/dist/index.d.ts +0 -0
  6. package/dist/index.js +0 -0
  7. package/dist/openapi-runtime.json +149 -222
  8. package/dist/openapi.d.ts +206 -460
  9. package/dist/openapi.json +233 -587
  10. package/dist/schema-model.d.ts +0 -0
  11. package/dist/schema-model.js +0 -0
  12. package/package.json +1 -1
package/dist/openapi.json CHANGED
@@ -95,12 +95,7 @@
95
95
  ],
96
96
  "parameters": [
97
97
  {
98
- "in": "path",
99
- "name": "slug",
100
- "required": true,
101
- "schema": {
102
- "$ref": "#/components/schemas/EntitySlug"
103
- }
98
+ "$ref": "#/components/parameters/EntitySlugPathParam"
104
99
  },
105
100
  {
106
101
  "in": "query",
@@ -132,12 +127,7 @@
132
127
  ],
133
128
  "parameters": [
134
129
  {
135
- "in": "path",
136
- "name": "slug",
137
- "required": true,
138
- "schema": {
139
- "$ref": "#/components/schemas/EntitySlug"
140
- }
130
+ "$ref": "#/components/parameters/EntitySlugPathParam"
141
131
  },
142
132
  {
143
133
  "in": "query",
@@ -179,12 +169,7 @@
179
169
  ],
180
170
  "parameters": [
181
171
  {
182
- "in": "path",
183
- "name": "slug",
184
- "required": true,
185
- "schema": {
186
- "$ref": "#/components/schemas/EntitySlug"
187
- }
172
+ "$ref": "#/components/parameters/EntitySlugPathParam"
188
173
  }
189
174
  ],
190
175
  "responses": {
@@ -204,12 +189,7 @@
204
189
  ],
205
190
  "parameters": [
206
191
  {
207
- "in": "path",
208
- "name": "slug",
209
- "required": true,
210
- "schema": {
211
- "$ref": "#/components/schemas/EntitySlug"
212
- }
192
+ "$ref": "#/components/parameters/EntitySlugPathParam"
213
193
  },
214
194
  {
215
195
  "in": "query",
@@ -308,20 +288,10 @@
308
288
  ],
309
289
  "parameters": [
310
290
  {
311
- "in": "path",
312
- "name": "slug",
313
- "required": true,
314
- "schema": {
315
- "$ref": "#/components/schemas/EntitySlug"
316
- }
291
+ "$ref": "#/components/parameters/EntitySlugPathParam"
317
292
  },
318
293
  {
319
- "in": "path",
320
- "name": "taxonomySlug",
321
- "required": true,
322
- "schema": {
323
- "$ref": "#/components/schemas/TaxonomySlug"
324
- }
294
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
325
295
  },
326
296
  {
327
297
  "in": "query",
@@ -406,32 +376,13 @@
406
376
  ],
407
377
  "parameters": [
408
378
  {
409
- "in": "path",
410
- "name": "slug",
411
- "description": "Entity Schema",
412
- "required": true,
413
- "schema": {
414
- "$ref": "#/components/schemas/EntitySlug"
415
- }
379
+ "$ref": "#/components/parameters/EntitySlugPathParam"
416
380
  },
417
381
  {
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
- }
382
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
425
383
  },
426
384
  {
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
- }
385
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
435
386
  }
436
387
  ],
437
388
  "requestBody": {
@@ -502,42 +453,16 @@
502
453
  ],
503
454
  "parameters": [
504
455
  {
505
- "in": "path",
506
- "name": "slug",
507
- "description": "Entity Schema",
508
- "required": true,
509
- "schema": {
510
- "$ref": "#/components/schemas/EntitySlug"
511
- }
456
+ "$ref": "#/components/parameters/EntitySlugPathParam"
512
457
  },
513
458
  {
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
- }
459
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
521
460
  },
522
461
  {
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
- }
462
+ "$ref": "#/components/parameters/DryRunQueryParam"
531
463
  },
532
464
  {
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
- }
465
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
541
466
  }
542
467
  ],
543
468
  "requestBody": {
@@ -605,31 +530,13 @@
605
530
  ],
606
531
  "parameters": [
607
532
  {
608
- "in": "path",
609
- "name": "slug",
610
- "description": "Entity Type",
611
- "required": true,
612
- "schema": {
613
- "$ref": "#/components/schemas/EntitySlug"
614
- }
533
+ "$ref": "#/components/parameters/EntityIdPathParam"
615
534
  },
616
535
  {
617
- "in": "path",
618
- "name": "id",
619
- "description": "Entity id",
620
- "required": true,
621
- "schema": {
622
- "$ref": "#/components/schemas/EntityId"
623
- }
536
+ "$ref": "#/components/parameters/EntitySlugPathParam"
624
537
  },
625
538
  {
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
- }
539
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
633
540
  }
634
541
  ],
635
542
  "responses": {
@@ -665,41 +572,16 @@
665
572
  ],
666
573
  "parameters": [
667
574
  {
668
- "in": "path",
669
- "name": "slug",
670
- "description": "Entity Type",
671
- "required": true,
672
- "schema": {
673
- "$ref": "#/components/schemas/EntitySlug"
674
- }
575
+ "$ref": "#/components/parameters/EntitySlugPathParam"
675
576
  },
676
577
  {
677
- "in": "path",
678
- "name": "id",
679
- "description": "Entity id",
680
- "required": true,
681
- "schema": {
682
- "$ref": "#/components/schemas/EntityId"
683
- }
578
+ "$ref": "#/components/parameters/EntityIdPathParam"
684
579
  },
685
580
  {
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
- }
581
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
693
582
  },
694
583
  {
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
- }
584
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
703
585
  }
704
586
  ],
705
587
  "requestBody": {
@@ -734,51 +616,19 @@
734
616
  ],
735
617
  "parameters": [
736
618
  {
737
- "in": "path",
738
- "name": "slug",
739
- "description": "Entity Schema",
740
- "required": true,
741
- "schema": {
742
- "$ref": "#/components/schemas/EntitySlug"
743
- }
619
+ "$ref": "#/components/parameters/EntitySlugPathParam"
744
620
  },
745
621
  {
746
- "in": "path",
747
- "name": "id",
748
- "description": "Entity Id",
749
- "required": true,
750
- "schema": {
751
- "$ref": "#/components/schemas/EntityId"
752
- }
622
+ "$ref": "#/components/parameters/EntityIdPathParam"
753
623
  },
754
624
  {
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
- }
625
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
762
626
  },
763
627
  {
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
- }
628
+ "$ref": "#/components/parameters/DryRunQueryParam"
772
629
  },
773
630
  {
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
- }
631
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
782
632
  }
783
633
  ],
784
634
  "requestBody": {
@@ -817,30 +667,13 @@
817
667
  ],
818
668
  "parameters": [
819
669
  {
820
- "in": "path",
821
- "name": "slug",
822
- "description": "Entity Type",
823
- "required": true,
824
- "schema": {
825
- "$ref": "#/components/schemas/EntitySlug"
826
- }
670
+ "$ref": "#/components/parameters/EntitySlugPathParam"
827
671
  },
828
672
  {
829
- "in": "path",
830
- "name": "id",
831
- "required": true,
832
- "schema": {
833
- "$ref": "#/components/schemas/EntityId"
834
- }
673
+ "$ref": "#/components/parameters/EntityIdPathParam"
835
674
  },
836
675
  {
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
- }
676
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
844
677
  }
845
678
  ],
846
679
  "responses": {
@@ -993,13 +826,7 @@
993
826
  ],
994
827
  "parameters": [
995
828
  {
996
- "in": "path",
997
- "name": "id",
998
- "description": "Activity Id",
999
- "required": true,
1000
- "schema": {
1001
- "$ref": "#/components/schemas/ActivityId"
1002
- }
829
+ "$ref": "#/components/parameters/ActivityIdPathParam"
1003
830
  },
1004
831
  {
1005
832
  "in": "query",
@@ -1047,13 +874,7 @@
1047
874
  ],
1048
875
  "parameters": [
1049
876
  {
1050
- "in": "path",
1051
- "name": "id",
1052
- "description": "Activity Id",
1053
- "required": true,
1054
- "schema": {
1055
- "$ref": "#/components/schemas/ActivityId"
1056
- }
877
+ "$ref": "#/components/parameters/ActivityIdPathParam"
1057
878
  },
1058
879
  {
1059
880
  "in": "query",
@@ -1093,22 +914,10 @@
1093
914
  ],
1094
915
  "parameters": [
1095
916
  {
1096
- "in": "path",
1097
- "name": "slug",
1098
- "description": "Entity Type",
1099
- "required": true,
1100
- "schema": {
1101
- "$ref": "#/components/schemas/EntitySlug"
1102
- }
917
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1103
918
  },
1104
919
  {
1105
- "in": "path",
1106
- "name": "id",
1107
- "description": "Entity id",
1108
- "required": true,
1109
- "schema": {
1110
- "$ref": "#/components/schemas/EntityId"
1111
- }
920
+ "$ref": "#/components/parameters/EntityIdPathParam"
1112
921
  },
1113
922
  {
1114
923
  "in": "query",
@@ -1129,14 +938,7 @@
1129
938
  }
1130
939
  },
1131
940
  {
1132
- "in": "query",
1133
- "name": "from",
1134
- "description": "start from page",
1135
- "schema": {
1136
- "type": "integer",
1137
- "minimum": 0,
1138
- "default": 0
1139
- }
941
+ "$ref": "#/components/parameters/FromPageQueryParam"
1140
942
  },
1141
943
  {
1142
944
  "in": "query",
@@ -1203,50 +1005,19 @@
1203
1005
  ],
1204
1006
  "parameters": [
1205
1007
  {
1206
- "in": "path",
1207
- "name": "slug",
1208
- "description": "Entity Type",
1209
- "required": true,
1210
- "schema": {
1211
- "$ref": "#/components/schemas/EntitySlug"
1212
- }
1008
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1213
1009
  },
1214
1010
  {
1215
- "in": "path",
1216
- "name": "id",
1217
- "description": "Entity id",
1218
- "required": true,
1219
- "schema": {
1220
- "$ref": "#/components/schemas/EntityId"
1221
- }
1011
+ "$ref": "#/components/parameters/EntityIdPathParam"
1222
1012
  },
1223
1013
  {
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
- }
1014
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
1231
1015
  },
1232
1016
  {
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
- }
1017
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
1240
1018
  },
1241
1019
  {
1242
- "in": "query",
1243
- "name": "from",
1244
- "description": "Starting page number",
1245
- "schema": {
1246
- "type": "integer",
1247
- "minimum": 0,
1248
- "default": 0
1249
- }
1020
+ "$ref": "#/components/parameters/FromPageQueryParam"
1250
1021
  },
1251
1022
  {
1252
1023
  "in": "query",
@@ -1261,32 +1032,10 @@
1261
1032
  }
1262
1033
  },
1263
1034
  {
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
- }
1035
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
1276
1036
  },
1277
1037
  {
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
- }
1038
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
1290
1039
  }
1291
1040
  ],
1292
1041
  "responses": {
@@ -1346,41 +1095,16 @@
1346
1095
  ],
1347
1096
  "parameters": [
1348
1097
  {
1349
- "in": "path",
1350
- "name": "slug",
1351
- "description": "Entity Type",
1352
- "required": true,
1353
- "schema": {
1354
- "$ref": "#/components/schemas/EntitySlug"
1355
- }
1098
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1356
1099
  },
1357
1100
  {
1358
- "in": "path",
1359
- "name": "id",
1360
- "description": "Entity id",
1361
- "required": true,
1362
- "schema": {
1363
- "$ref": "#/components/schemas/EntityId"
1364
- }
1101
+ "$ref": "#/components/parameters/EntityIdPathParam"
1365
1102
  },
1366
1103
  {
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
- }
1104
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
1375
1105
  },
1376
1106
  {
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
- }
1107
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
1384
1108
  }
1385
1109
  ],
1386
1110
  "requestBody": {
@@ -1436,31 +1160,13 @@
1436
1160
  ],
1437
1161
  "parameters": [
1438
1162
  {
1439
- "in": "path",
1440
- "name": "slug",
1441
- "description": "Entity Type",
1442
- "required": true,
1443
- "schema": {
1444
- "$ref": "#/components/schemas/EntitySlug"
1445
- }
1163
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1446
1164
  },
1447
1165
  {
1448
- "in": "path",
1449
- "name": "id",
1450
- "description": "Entity id",
1451
- "required": true,
1452
- "schema": {
1453
- "$ref": "#/components/schemas/EntityId"
1454
- }
1166
+ "$ref": "#/components/parameters/EntityIdPathParam"
1455
1167
  },
1456
1168
  {
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
- }
1169
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
1464
1170
  },
1465
1171
  {
1466
1172
  "in": "query",
@@ -1471,23 +1177,10 @@
1471
1177
  }
1472
1178
  },
1473
1179
  {
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
- }
1180
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
1481
1181
  },
1482
1182
  {
1483
- "in": "query",
1484
- "name": "from",
1485
- "description": "Starting page number",
1486
- "schema": {
1487
- "type": "integer",
1488
- "minimum": 0,
1489
- "default": 0
1490
- }
1183
+ "$ref": "#/components/parameters/FromPageQueryParam"
1491
1184
  },
1492
1185
  {
1493
1186
  "in": "query",
@@ -1496,6 +1189,7 @@
1496
1189
  "schema": {
1497
1190
  "type": "integer",
1498
1191
  "minimum": 1,
1192
+ "maximum": 1000,
1499
1193
  "default": 50
1500
1194
  }
1501
1195
  },
@@ -1540,50 +1234,19 @@
1540
1234
  ],
1541
1235
  "parameters": [
1542
1236
  {
1543
- "in": "path",
1544
- "name": "slug",
1545
- "description": "Entity Type",
1546
- "required": true,
1547
- "schema": {
1548
- "$ref": "#/components/schemas/EntitySlug"
1549
- }
1237
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1550
1238
  },
1551
1239
  {
1552
- "in": "path",
1553
- "name": "id",
1554
- "description": "Entity id",
1555
- "required": true,
1556
- "schema": {
1557
- "$ref": "#/components/schemas/EntityId"
1558
- }
1240
+ "$ref": "#/components/parameters/EntityIdPathParam"
1559
1241
  },
1560
1242
  {
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
- }
1243
+ "$ref": "#/components/parameters/HydrateEntitiesQueryParam"
1568
1244
  },
1569
1245
  {
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
- }
1246
+ "$ref": "#/components/parameters/IncludeReverseQueryParam"
1577
1247
  },
1578
1248
  {
1579
- "in": "query",
1580
- "name": "from",
1581
- "description": "Starting page number",
1582
- "schema": {
1583
- "type": "integer",
1584
- "minimum": 0,
1585
- "default": 0
1586
- }
1249
+ "$ref": "#/components/parameters/FromPageQueryParam"
1587
1250
  },
1588
1251
  {
1589
1252
  "in": "query",
@@ -1598,32 +1261,10 @@
1598
1261
  }
1599
1262
  },
1600
1263
  {
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
- }
1264
+ "$ref": "#/components/parameters/IncludeSchemasQueryParam"
1613
1265
  },
1614
1266
  {
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
- }
1267
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
1627
1268
  }
1628
1269
  ],
1629
1270
  "responses": {
@@ -1650,37 +1291,13 @@
1650
1291
  ],
1651
1292
  "parameters": [
1652
1293
  {
1653
- "in": "path",
1654
- "name": "slug",
1655
- "description": "Entity Schema",
1656
- "required": true,
1657
- "schema": {
1658
- "$ref": "#/components/schemas/EntitySlug"
1659
- }
1294
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1660
1295
  },
1661
1296
  {
1662
- "in": "path",
1663
- "name": "id",
1664
- "description": "Entity id",
1665
- "required": true,
1666
- "schema": {
1667
- "$ref": "#/components/schemas/EntityId"
1668
- }
1297
+ "$ref": "#/components/parameters/EntityIdPathParam"
1669
1298
  },
1670
1299
  {
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
- }
1300
+ "$ref": "#/components/parameters/ExcludeSchemasQueryParam"
1684
1301
  }
1685
1302
  ],
1686
1303
  "responses": {
@@ -1707,22 +1324,10 @@
1707
1324
  ],
1708
1325
  "parameters": [
1709
1326
  {
1710
- "in": "path",
1711
- "name": "slug",
1712
- "description": "Entity Type",
1713
- "required": true,
1714
- "schema": {
1715
- "$ref": "#/components/schemas/EntitySlug"
1716
- }
1327
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1717
1328
  },
1718
1329
  {
1719
- "in": "path",
1720
- "name": "id",
1721
- "description": "Entity id",
1722
- "required": true,
1723
- "schema": {
1724
- "$ref": "#/components/schemas/EntityId"
1725
- }
1330
+ "$ref": "#/components/parameters/EntityIdPathParam"
1726
1331
  },
1727
1332
  {
1728
1333
  "in": "path",
@@ -1743,23 +1348,10 @@
1743
1348
  }
1744
1349
  },
1745
1350
  {
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
- }
1351
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
1754
1352
  },
1755
1353
  {
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
- }
1354
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
1763
1355
  }
1764
1356
  ],
1765
1357
  "requestBody": {
@@ -1807,22 +1399,10 @@
1807
1399
  ],
1808
1400
  "parameters": [
1809
1401
  {
1810
- "in": "path",
1811
- "name": "slug",
1812
- "description": "Entity Type",
1813
- "required": true,
1814
- "schema": {
1815
- "$ref": "#/components/schemas/EntitySlug"
1816
- }
1402
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1817
1403
  },
1818
1404
  {
1819
- "in": "path",
1820
- "name": "id",
1821
- "description": "Entity id",
1822
- "required": true,
1823
- "schema": {
1824
- "$ref": "#/components/schemas/EntityId"
1825
- }
1405
+ "$ref": "#/components/parameters/EntityIdPathParam"
1826
1406
  },
1827
1407
  {
1828
1408
  "in": "path",
@@ -1843,23 +1423,10 @@
1843
1423
  }
1844
1424
  },
1845
1425
  {
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
- }
1426
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
1854
1427
  },
1855
1428
  {
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
- }
1429
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
1863
1430
  }
1864
1431
  ],
1865
1432
  "responses": {
@@ -2024,13 +1591,7 @@
2024
1591
  ],
2025
1592
  "parameters": [
2026
1593
  {
2027
- "in": "path",
2028
- "name": "id",
2029
- "description": "View id",
2030
- "required": true,
2031
- "schema": {
2032
- "$ref": "#/components/schemas/SavedViewId"
2033
- }
1594
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
2034
1595
  }
2035
1596
  ],
2036
1597
  "responses": {
@@ -2060,13 +1621,7 @@
2060
1621
  ],
2061
1622
  "parameters": [
2062
1623
  {
2063
- "in": "path",
2064
- "name": "id",
2065
- "description": "View id",
2066
- "required": true,
2067
- "schema": {
2068
- "$ref": "#/components/schemas/SavedViewId"
2069
- }
1624
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
2070
1625
  }
2071
1626
  ],
2072
1627
  "requestBody": {
@@ -2097,13 +1652,7 @@
2097
1652
  "description": "Deletes a saved view",
2098
1653
  "parameters": [
2099
1654
  {
2100
- "in": "path",
2101
- "name": "id",
2102
- "description": "View id",
2103
- "required": true,
2104
- "schema": {
2105
- "$ref": "#/components/schemas/SavedViewId"
2106
- }
1655
+ "$ref": "#/components/parameters/SavedViewIdPathParam"
2107
1656
  }
2108
1657
  ],
2109
1658
  "tags": [
@@ -2186,13 +1735,7 @@
2186
1735
  ],
2187
1736
  "parameters": [
2188
1737
  {
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
1738
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
2196
1739
  }
2197
1740
  ],
2198
1741
  "responses": {
@@ -2219,13 +1762,7 @@
2219
1762
  ],
2220
1763
  "parameters": [
2221
1764
  {
2222
- "in": "path",
2223
- "name": "taxonomySlug",
2224
- "description": "Limit results to slug",
2225
- "schema": {
2226
- "type": "string"
2227
- },
2228
- "required": true
1765
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
2229
1766
  },
2230
1767
  {
2231
1768
  "in": "query",
@@ -2276,13 +1813,7 @@
2276
1813
  ],
2277
1814
  "parameters": [
2278
1815
  {
2279
- "in": "query",
2280
- "name": "taxonomySlug",
2281
- "description": "Taxonomy slug",
2282
- "schema": {
2283
- "type": "string"
2284
- },
2285
- "required": true
1816
+ "$ref": "#/components/parameters/TaxonomySlugQueryParam"
2286
1817
  }
2287
1818
  ],
2288
1819
  "requestBody": {
@@ -2334,13 +1865,7 @@
2334
1865
  ],
2335
1866
  "parameters": [
2336
1867
  {
2337
- "in": "path",
2338
- "name": "taxonomySlug",
2339
- "description": "Taxonomy slug",
2340
- "schema": {
2341
- "type": "string"
2342
- },
2343
- "required": true
1868
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
2344
1869
  }
2345
1870
  ],
2346
1871
  "requestBody": {
@@ -2516,6 +2041,19 @@
2516
2041
  }
2517
2042
  ]
2518
2043
  },
2044
+ "single_view": {
2045
+ "anyOf": [
2046
+ {
2047
+ "$ref": "#/components/schemas/EntityDefaultEdit"
2048
+ },
2049
+ {
2050
+ "$ref": "#/components/schemas/RedirectEntityView"
2051
+ },
2052
+ {
2053
+ "$ref": "#/components/schemas/EntityViewDisabled"
2054
+ }
2055
+ ]
2056
+ },
2519
2057
  "list_item": {
2520
2058
  "type": "object",
2521
2059
  "properties": {
@@ -4194,16 +3732,9 @@
4194
3732
  "row_actions": {
4195
3733
  "type": "array",
4196
3734
  "items": {
4197
- "anyOf": [
3735
+ "oneOf": [
4198
3736
  {
4199
- "type": "string",
4200
- "enum": [
4201
- "view",
4202
- "edit",
4203
- "duplicate",
4204
- "delete",
4205
- "share"
4206
- ]
3737
+ "type": "string"
4207
3738
  },
4208
3739
  {
4209
3740
  "$ref": "#/components/schemas/EntityAction"
@@ -4267,17 +3798,6 @@
4267
3798
  "additionalProperties": {
4268
3799
  "type": "string"
4269
3800
  }
4270
- },
4271
- "table_menu_options": {
4272
- "type": "object",
4273
- "properties": {
4274
- "icon": {
4275
- "type": "string"
4276
- },
4277
- "label": {
4278
- "type": "string"
4279
- }
4280
- }
4281
3801
  }
4282
3802
  }
4283
3803
  },
@@ -4296,17 +3816,6 @@
4296
3816
  "type": "string"
4297
3817
  }
4298
3818
  },
4299
- "table_menu_options": {
4300
- "type": "object",
4301
- "properties": {
4302
- "icon": {
4303
- "type": "string"
4304
- },
4305
- "label": {
4306
- "type": "string"
4307
- }
4308
- }
4309
- },
4310
3819
  "summary_attributes": {
4311
3820
  "description": "List of attribute names that we show in the summary header",
4312
3821
  "type": "array",
@@ -5238,6 +4747,148 @@
5238
4747
  }
5239
4748
  }
5240
4749
  },
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
+ },
5241
4892
  "examples": {
5242
4893
  "TaxEntity": {
5243
4894
  "description": "Example of a Tax Rate entity",
@@ -5853,10 +5504,5 @@
5853
5504
  }
5854
5505
  }
5855
5506
  }
5856
- },
5857
- "servers": [
5858
- {
5859
- "url": "https://entity.sls.epilot.io"
5860
- }
5861
- ]
5507
+ }
5862
5508
  }