@epilot/entity-client 4.16.0-rc2 → 4.16.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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +115 -0
- package/dist/openapi.d.ts +474 -18
- package/dist/openapi.json +367 -14
- package/package.json +1 -1
package/dist/openapi.json
CHANGED
|
@@ -1237,6 +1237,56 @@
|
|
|
1237
1237
|
"default": false,
|
|
1238
1238
|
"type": "boolean"
|
|
1239
1239
|
}
|
|
1240
|
+
},
|
|
1241
|
+
{
|
|
1242
|
+
"in": "query",
|
|
1243
|
+
"name": "from",
|
|
1244
|
+
"description": "Starting page number",
|
|
1245
|
+
"schema": {
|
|
1246
|
+
"type": "integer",
|
|
1247
|
+
"minimum": 0,
|
|
1248
|
+
"default": 0
|
|
1249
|
+
}
|
|
1250
|
+
},
|
|
1251
|
+
{
|
|
1252
|
+
"in": "query",
|
|
1253
|
+
"name": "size",
|
|
1254
|
+
"description": "Number of results to return per page",
|
|
1255
|
+
"required": false,
|
|
1256
|
+
"schema": {
|
|
1257
|
+
"type": "integer",
|
|
1258
|
+
"minimum": 1,
|
|
1259
|
+
"maximum": 1000,
|
|
1260
|
+
"default": 100
|
|
1261
|
+
}
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
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
|
+
}
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
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
|
+
}
|
|
1240
1290
|
}
|
|
1241
1291
|
],
|
|
1242
1292
|
"responses": {
|
|
@@ -1322,6 +1372,15 @@
|
|
|
1322
1372
|
"type": "boolean",
|
|
1323
1373
|
"default": false
|
|
1324
1374
|
}
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
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
|
+
}
|
|
1325
1384
|
}
|
|
1326
1385
|
],
|
|
1327
1386
|
"requestBody": {
|
|
@@ -1471,6 +1530,173 @@
|
|
|
1471
1530
|
}
|
|
1472
1531
|
}
|
|
1473
1532
|
},
|
|
1533
|
+
"/v3/entity/{slug}/{id}/relations": {
|
|
1534
|
+
"get": {
|
|
1535
|
+
"operationId": "getRelationsV3",
|
|
1536
|
+
"summary": "getRelationsV3",
|
|
1537
|
+
"description": "Returns 1st level direct relations for an entity with pagination.\n\nYou can control whether to return the full entity or just the relation item with the `?hydrate` query param.\n\nReverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.\n",
|
|
1538
|
+
"tags": [
|
|
1539
|
+
"Relations"
|
|
1540
|
+
],
|
|
1541
|
+
"parameters": [
|
|
1542
|
+
{
|
|
1543
|
+
"in": "path",
|
|
1544
|
+
"name": "slug",
|
|
1545
|
+
"description": "Entity Type",
|
|
1546
|
+
"required": true,
|
|
1547
|
+
"schema": {
|
|
1548
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1549
|
+
}
|
|
1550
|
+
},
|
|
1551
|
+
{
|
|
1552
|
+
"in": "path",
|
|
1553
|
+
"name": "id",
|
|
1554
|
+
"description": "Entity id",
|
|
1555
|
+
"required": true,
|
|
1556
|
+
"schema": {
|
|
1557
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1558
|
+
}
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
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
|
+
}
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
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
|
+
}
|
|
1577
|
+
},
|
|
1578
|
+
{
|
|
1579
|
+
"in": "query",
|
|
1580
|
+
"name": "from",
|
|
1581
|
+
"description": "Starting page number",
|
|
1582
|
+
"schema": {
|
|
1583
|
+
"type": "integer",
|
|
1584
|
+
"minimum": 0,
|
|
1585
|
+
"default": 0
|
|
1586
|
+
}
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"in": "query",
|
|
1590
|
+
"name": "size",
|
|
1591
|
+
"description": "Number of results to return per page",
|
|
1592
|
+
"required": false,
|
|
1593
|
+
"schema": {
|
|
1594
|
+
"type": "integer",
|
|
1595
|
+
"minimum": 1,
|
|
1596
|
+
"maximum": 1000,
|
|
1597
|
+
"default": 100
|
|
1598
|
+
}
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
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
|
+
}
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
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
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
],
|
|
1629
|
+
"responses": {
|
|
1630
|
+
"200": {
|
|
1631
|
+
"description": "Success",
|
|
1632
|
+
"content": {
|
|
1633
|
+
"application/json": {
|
|
1634
|
+
"schema": {
|
|
1635
|
+
"$ref": "#/components/schemas/GetRelationsRespWithPagination"
|
|
1636
|
+
}
|
|
1637
|
+
}
|
|
1638
|
+
}
|
|
1639
|
+
}
|
|
1640
|
+
}
|
|
1641
|
+
}
|
|
1642
|
+
},
|
|
1643
|
+
"/v2/entity/{slug}/{id}/relations/count": {
|
|
1644
|
+
"get": {
|
|
1645
|
+
"operationId": "getRelatedEntitiesCount",
|
|
1646
|
+
"summary": "getRelatedEntitiesCount",
|
|
1647
|
+
"description": "Returns the amount of unique related entities for an entity - includes direct and reverse relations.\n",
|
|
1648
|
+
"tags": [
|
|
1649
|
+
"Relations"
|
|
1650
|
+
],
|
|
1651
|
+
"parameters": [
|
|
1652
|
+
{
|
|
1653
|
+
"in": "path",
|
|
1654
|
+
"name": "slug",
|
|
1655
|
+
"description": "Entity Schema",
|
|
1656
|
+
"required": true,
|
|
1657
|
+
"schema": {
|
|
1658
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1659
|
+
}
|
|
1660
|
+
},
|
|
1661
|
+
{
|
|
1662
|
+
"in": "path",
|
|
1663
|
+
"name": "id",
|
|
1664
|
+
"description": "Entity id",
|
|
1665
|
+
"required": true,
|
|
1666
|
+
"schema": {
|
|
1667
|
+
"$ref": "#/components/schemas/EntityId"
|
|
1668
|
+
}
|
|
1669
|
+
},
|
|
1670
|
+
{
|
|
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
|
+
}
|
|
1684
|
+
}
|
|
1685
|
+
],
|
|
1686
|
+
"responses": {
|
|
1687
|
+
"200": {
|
|
1688
|
+
"description": "Success",
|
|
1689
|
+
"content": {
|
|
1690
|
+
"application/json": {
|
|
1691
|
+
"schema": {
|
|
1692
|
+
"$ref": "#/components/schemas/GetRelatedEntitiesCount"
|
|
1693
|
+
}
|
|
1694
|
+
}
|
|
1695
|
+
}
|
|
1696
|
+
}
|
|
1697
|
+
}
|
|
1698
|
+
}
|
|
1699
|
+
},
|
|
1474
1700
|
"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
|
|
1475
1701
|
"put": {
|
|
1476
1702
|
"operationId": "updateRelation",
|
|
@@ -1525,6 +1751,15 @@
|
|
|
1525
1751
|
"type": "boolean",
|
|
1526
1752
|
"default": false
|
|
1527
1753
|
}
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
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
|
+
}
|
|
1528
1763
|
}
|
|
1529
1764
|
],
|
|
1530
1765
|
"requestBody": {
|
|
@@ -1616,6 +1851,15 @@
|
|
|
1616
1851
|
"type": "boolean",
|
|
1617
1852
|
"default": false
|
|
1618
1853
|
}
|
|
1854
|
+
},
|
|
1855
|
+
{
|
|
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
|
+
}
|
|
1619
1863
|
}
|
|
1620
1864
|
],
|
|
1621
1865
|
"responses": {
|
|
@@ -1872,6 +2116,36 @@
|
|
|
1872
2116
|
}
|
|
1873
2117
|
}
|
|
1874
2118
|
},
|
|
2119
|
+
"/v1/entity/views/favorites": {
|
|
2120
|
+
"get": {
|
|
2121
|
+
"operationId": "listFavoriteViewsForUser",
|
|
2122
|
+
"summary": "listFavoriteViewsForUser",
|
|
2123
|
+
"description": "Get the Favorite Saved Views for user based on the schema",
|
|
2124
|
+
"tags": [
|
|
2125
|
+
"Saved Views"
|
|
2126
|
+
],
|
|
2127
|
+
"responses": {
|
|
2128
|
+
"200": {
|
|
2129
|
+
"description": "Success",
|
|
2130
|
+
"content": {
|
|
2131
|
+
"application/json": {
|
|
2132
|
+
"schema": {
|
|
2133
|
+
"type": "object",
|
|
2134
|
+
"properties": {
|
|
2135
|
+
"results": {
|
|
2136
|
+
"type": "array",
|
|
2137
|
+
"items": {
|
|
2138
|
+
"$ref": "#/components/schemas/SavedViewItem"
|
|
2139
|
+
}
|
|
2140
|
+
}
|
|
2141
|
+
}
|
|
2142
|
+
}
|
|
2143
|
+
}
|
|
2144
|
+
}
|
|
2145
|
+
}
|
|
2146
|
+
}
|
|
2147
|
+
}
|
|
2148
|
+
},
|
|
1875
2149
|
"/v1/entity/listTaxonomies": {
|
|
1876
2150
|
"get": {
|
|
1877
2151
|
"operationId": "listTaxonomies",
|
|
@@ -2242,19 +2516,6 @@
|
|
|
2242
2516
|
}
|
|
2243
2517
|
]
|
|
2244
2518
|
},
|
|
2245
|
-
"single_view": {
|
|
2246
|
-
"anyOf": [
|
|
2247
|
-
{
|
|
2248
|
-
"$ref": "#/components/schemas/EntityDefaultEdit"
|
|
2249
|
-
},
|
|
2250
|
-
{
|
|
2251
|
-
"$ref": "#/components/schemas/RedirectEntityView"
|
|
2252
|
-
},
|
|
2253
|
-
{
|
|
2254
|
-
"$ref": "#/components/schemas/EntityViewDisabled"
|
|
2255
|
-
}
|
|
2256
|
-
]
|
|
2257
|
-
},
|
|
2258
2519
|
"list_item": {
|
|
2259
2520
|
"type": "object",
|
|
2260
2521
|
"properties": {
|
|
@@ -2272,6 +2533,12 @@
|
|
|
2272
2533
|
}
|
|
2273
2534
|
]
|
|
2274
2535
|
}
|
|
2536
|
+
},
|
|
2537
|
+
"quick_actions": {
|
|
2538
|
+
"type": "array",
|
|
2539
|
+
"items": {
|
|
2540
|
+
"$ref": "#/components/schemas/EntityAction"
|
|
2541
|
+
}
|
|
2275
2542
|
}
|
|
2276
2543
|
}
|
|
2277
2544
|
},
|
|
@@ -2567,6 +2834,9 @@
|
|
|
2567
2834
|
},
|
|
2568
2835
|
{
|
|
2569
2836
|
"$ref": "#/components/schemas/PurposeAttribute"
|
|
2837
|
+
},
|
|
2838
|
+
{
|
|
2839
|
+
"$ref": "#/components/schemas/PartnerOrganisationAttribute"
|
|
2570
2840
|
}
|
|
2571
2841
|
]
|
|
2572
2842
|
},
|
|
@@ -2591,6 +2861,11 @@
|
|
|
2591
2861
|
"description": "Render as a column in table views. When defined, overrides `hidden`",
|
|
2592
2862
|
"type": "boolean"
|
|
2593
2863
|
},
|
|
2864
|
+
"sortable": {
|
|
2865
|
+
"description": "Allow sorting by this attribute in table views if `show_in_table` is true",
|
|
2866
|
+
"type": "boolean",
|
|
2867
|
+
"default": true
|
|
2868
|
+
},
|
|
2594
2869
|
"required": {
|
|
2595
2870
|
"type": "boolean",
|
|
2596
2871
|
"default": false
|
|
@@ -3124,6 +3399,34 @@
|
|
|
3124
3399
|
}
|
|
3125
3400
|
}
|
|
3126
3401
|
},
|
|
3402
|
+
"EntityAction": {
|
|
3403
|
+
"type": "object",
|
|
3404
|
+
"description": "An entity action configured from the entity schema",
|
|
3405
|
+
"properties": {
|
|
3406
|
+
"action": {
|
|
3407
|
+
"type": "string",
|
|
3408
|
+
"description": "A unique action name",
|
|
3409
|
+
"example": "preview_file"
|
|
3410
|
+
},
|
|
3411
|
+
"label": {
|
|
3412
|
+
"type": "string",
|
|
3413
|
+
"example": "Preview File"
|
|
3414
|
+
},
|
|
3415
|
+
"icon": {
|
|
3416
|
+
"type": "string",
|
|
3417
|
+
"example": "visibility"
|
|
3418
|
+
},
|
|
3419
|
+
"permission": {
|
|
3420
|
+
"type": "string",
|
|
3421
|
+
"example": "entity:edit",
|
|
3422
|
+
"description": "Permission required to show the action.\nIf not provided, the action will be shown to all users.\n"
|
|
3423
|
+
}
|
|
3424
|
+
},
|
|
3425
|
+
"required": [
|
|
3426
|
+
"action",
|
|
3427
|
+
"label"
|
|
3428
|
+
]
|
|
3429
|
+
},
|
|
3127
3430
|
"RelationAttribute": {
|
|
3128
3431
|
"allOf": [
|
|
3129
3432
|
{
|
|
@@ -3314,6 +3617,25 @@
|
|
|
3314
3617
|
}
|
|
3315
3618
|
]
|
|
3316
3619
|
},
|
|
3620
|
+
"PartnerOrganisationAttribute": {
|
|
3621
|
+
"allOf": [
|
|
3622
|
+
{
|
|
3623
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
3624
|
+
},
|
|
3625
|
+
{
|
|
3626
|
+
"type": "object",
|
|
3627
|
+
"description": "Shared Partner Organisations",
|
|
3628
|
+
"properties": {
|
|
3629
|
+
"type": {
|
|
3630
|
+
"type": "string",
|
|
3631
|
+
"enum": [
|
|
3632
|
+
"partner_organisation"
|
|
3633
|
+
]
|
|
3634
|
+
}
|
|
3635
|
+
}
|
|
3636
|
+
}
|
|
3637
|
+
]
|
|
3638
|
+
},
|
|
3317
3639
|
"AddressRelationAttribute": {
|
|
3318
3640
|
"allOf": [
|
|
3319
3641
|
{
|
|
@@ -3872,7 +4194,21 @@
|
|
|
3872
4194
|
"row_actions": {
|
|
3873
4195
|
"type": "array",
|
|
3874
4196
|
"items": {
|
|
3875
|
-
"
|
|
4197
|
+
"anyOf": [
|
|
4198
|
+
{
|
|
4199
|
+
"type": "string",
|
|
4200
|
+
"enum": [
|
|
4201
|
+
"view",
|
|
4202
|
+
"edit",
|
|
4203
|
+
"duplicate",
|
|
4204
|
+
"delete",
|
|
4205
|
+
"share"
|
|
4206
|
+
]
|
|
4207
|
+
},
|
|
4208
|
+
{
|
|
4209
|
+
"$ref": "#/components/schemas/EntityAction"
|
|
4210
|
+
}
|
|
4211
|
+
]
|
|
3876
4212
|
}
|
|
3877
4213
|
},
|
|
3878
4214
|
"navbar_actions": {
|
|
@@ -4268,6 +4604,15 @@
|
|
|
4268
4604
|
}
|
|
4269
4605
|
}
|
|
4270
4606
|
},
|
|
4607
|
+
"GetRelatedEntitiesCount": {
|
|
4608
|
+
"type": "object",
|
|
4609
|
+
"properties": {
|
|
4610
|
+
"hits": {
|
|
4611
|
+
"type": "integer",
|
|
4612
|
+
"example": 1
|
|
4613
|
+
}
|
|
4614
|
+
}
|
|
4615
|
+
},
|
|
4271
4616
|
"RelationEntity": {
|
|
4272
4617
|
"allOf": [
|
|
4273
4618
|
{
|
|
@@ -4739,6 +5084,14 @@
|
|
|
4739
5084
|
"type": "boolean",
|
|
4740
5085
|
"example": true
|
|
4741
5086
|
},
|
|
5087
|
+
"isFavoritedBy": {
|
|
5088
|
+
"description": "List of users (IDs) that have favorited the view",
|
|
5089
|
+
"type": "array",
|
|
5090
|
+
"items": {
|
|
5091
|
+
"type": "string",
|
|
5092
|
+
"example": 11701
|
|
5093
|
+
}
|
|
5094
|
+
},
|
|
4742
5095
|
"created_by": {
|
|
4743
5096
|
"anyOf": [
|
|
4744
5097
|
{
|