@epilot/entity-client 4.3.1 → 4.3.3
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.d.ts +245 -2
- package/dist/openapi.json +358 -3
- package/package.json +2 -2
- package/package-lock.json +0 -18853
package/dist/openapi.json
CHANGED
|
@@ -29,6 +29,10 @@
|
|
|
29
29
|
{
|
|
30
30
|
"name": "Saved Views",
|
|
31
31
|
"description": "Saved Views for Entities"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "Taxonomy",
|
|
35
|
+
"description": "Entity classification with Taxonomies"
|
|
32
36
|
}
|
|
33
37
|
],
|
|
34
38
|
"security": [
|
|
@@ -1286,6 +1290,14 @@
|
|
|
1286
1290
|
"schema": {
|
|
1287
1291
|
"$ref": "#/components/schemas/IsTemplate"
|
|
1288
1292
|
}
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"in": "query",
|
|
1296
|
+
"name": "language",
|
|
1297
|
+
"description": "Export headers translation language",
|
|
1298
|
+
"schema": {
|
|
1299
|
+
"$ref": "#/components/schemas/Language"
|
|
1300
|
+
}
|
|
1289
1301
|
}
|
|
1290
1302
|
],
|
|
1291
1303
|
"requestBody": {
|
|
@@ -1500,6 +1512,218 @@
|
|
|
1500
1512
|
}
|
|
1501
1513
|
}
|
|
1502
1514
|
}
|
|
1515
|
+
},
|
|
1516
|
+
"/v1/entity/listTaxonomies": {
|
|
1517
|
+
"get": {
|
|
1518
|
+
"operationId": "listTaxonomies",
|
|
1519
|
+
"summary": "listTaxonomies",
|
|
1520
|
+
"description": "List taxonomies in an organisation",
|
|
1521
|
+
"tags": [
|
|
1522
|
+
"Taxonomy"
|
|
1523
|
+
],
|
|
1524
|
+
"responses": {
|
|
1525
|
+
"200": {
|
|
1526
|
+
"description": "Returns list of taxonomies in an organisation",
|
|
1527
|
+
"content": {
|
|
1528
|
+
"application/json": {
|
|
1529
|
+
"schema": {
|
|
1530
|
+
"type": "object",
|
|
1531
|
+
"properties": {
|
|
1532
|
+
"results": {
|
|
1533
|
+
"type": "array",
|
|
1534
|
+
"items": {
|
|
1535
|
+
"$ref": "#/components/schemas/Taxonomy"
|
|
1536
|
+
}
|
|
1537
|
+
}
|
|
1538
|
+
}
|
|
1539
|
+
}
|
|
1540
|
+
}
|
|
1541
|
+
}
|
|
1542
|
+
}
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1545
|
+
},
|
|
1546
|
+
"/v1/entity/taxonomies/{taxonomySlug}": {
|
|
1547
|
+
"get": {
|
|
1548
|
+
"operationId": "getTaxonomy",
|
|
1549
|
+
"summary": "getTaxonomy",
|
|
1550
|
+
"description": "Get taxonomy by slug",
|
|
1551
|
+
"tags": [
|
|
1552
|
+
"Taxonomy"
|
|
1553
|
+
],
|
|
1554
|
+
"parameters": [
|
|
1555
|
+
{
|
|
1556
|
+
"in": "path",
|
|
1557
|
+
"name": "taxonomySlug",
|
|
1558
|
+
"description": "Taxonomy slug to return taxonomy for",
|
|
1559
|
+
"schema": {
|
|
1560
|
+
"$ref": "#/components/schemas/TaxonomySlug"
|
|
1561
|
+
},
|
|
1562
|
+
"required": true
|
|
1563
|
+
}
|
|
1564
|
+
],
|
|
1565
|
+
"responses": {
|
|
1566
|
+
"200": {
|
|
1567
|
+
"description": "Taxonomy",
|
|
1568
|
+
"content": {
|
|
1569
|
+
"application/json": {
|
|
1570
|
+
"schema": {
|
|
1571
|
+
"$ref": "#/components/schemas/Taxonomy"
|
|
1572
|
+
}
|
|
1573
|
+
}
|
|
1574
|
+
}
|
|
1575
|
+
}
|
|
1576
|
+
}
|
|
1577
|
+
}
|
|
1578
|
+
},
|
|
1579
|
+
"/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
|
|
1580
|
+
"get": {
|
|
1581
|
+
"operationId": "taxonomiesAutocomplete",
|
|
1582
|
+
"summary": "taxonomiesAutocomplete",
|
|
1583
|
+
"description": "Taxonomies autocomplete",
|
|
1584
|
+
"tags": [
|
|
1585
|
+
"Taxonomy"
|
|
1586
|
+
],
|
|
1587
|
+
"parameters": [
|
|
1588
|
+
{
|
|
1589
|
+
"in": "path",
|
|
1590
|
+
"name": "taxonomySlug",
|
|
1591
|
+
"description": "Limit results to slug",
|
|
1592
|
+
"schema": {
|
|
1593
|
+
"type": "string"
|
|
1594
|
+
},
|
|
1595
|
+
"required": true
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"in": "query",
|
|
1599
|
+
"name": "query",
|
|
1600
|
+
"description": "Input to autocomplete",
|
|
1601
|
+
"schema": {
|
|
1602
|
+
"type": "string"
|
|
1603
|
+
}
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"in": "query",
|
|
1607
|
+
"name": "size",
|
|
1608
|
+
"description": "Minimum number of results to return",
|
|
1609
|
+
"schema": {
|
|
1610
|
+
"type": "number"
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
],
|
|
1614
|
+
"responses": {
|
|
1615
|
+
"200": {
|
|
1616
|
+
"description": "Taxonomy classifications",
|
|
1617
|
+
"content": {
|
|
1618
|
+
"application/json": {
|
|
1619
|
+
"schema": {
|
|
1620
|
+
"type": "object",
|
|
1621
|
+
"properties": {
|
|
1622
|
+
"results": {
|
|
1623
|
+
"type": "array",
|
|
1624
|
+
"items": {
|
|
1625
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
}
|
|
1629
|
+
}
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
}
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
"/v1/entity/taxonomies/{taxonomySlug}/classifications": {
|
|
1637
|
+
"get": {
|
|
1638
|
+
"operationId": "getTaxonomyClassifications",
|
|
1639
|
+
"summary": "getTaxonomyClassifications",
|
|
1640
|
+
"description": "List taxonomy classifications in an organisation based on taxonomy slug",
|
|
1641
|
+
"tags": [
|
|
1642
|
+
"Taxonomy"
|
|
1643
|
+
],
|
|
1644
|
+
"parameters": [
|
|
1645
|
+
{
|
|
1646
|
+
"in": "path",
|
|
1647
|
+
"name": "taxonomySlug",
|
|
1648
|
+
"description": "Taxonomy slug",
|
|
1649
|
+
"schema": {
|
|
1650
|
+
"type": "string"
|
|
1651
|
+
},
|
|
1652
|
+
"required": true
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"in": "query",
|
|
1656
|
+
"name": "classificationIds",
|
|
1657
|
+
"description": "Classification id(s)",
|
|
1658
|
+
"schema": {
|
|
1659
|
+
"type": "array",
|
|
1660
|
+
"items": {
|
|
1661
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
1662
|
+
}
|
|
1663
|
+
}
|
|
1664
|
+
}
|
|
1665
|
+
],
|
|
1666
|
+
"responses": {
|
|
1667
|
+
"200": {
|
|
1668
|
+
"description": "Returns list of taxonomy classifications",
|
|
1669
|
+
"content": {
|
|
1670
|
+
"application/json": {
|
|
1671
|
+
"schema": {
|
|
1672
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
1673
|
+
}
|
|
1674
|
+
}
|
|
1675
|
+
}
|
|
1676
|
+
}
|
|
1677
|
+
}
|
|
1678
|
+
},
|
|
1679
|
+
"post": {
|
|
1680
|
+
"operationId": "updateClassificationsForTaxonomy",
|
|
1681
|
+
"summary": "updateClassificationsForTaxonomy",
|
|
1682
|
+
"description": "Update taxonomies in an organisation based in taxonomy slug",
|
|
1683
|
+
"tags": [
|
|
1684
|
+
"Taxonomy"
|
|
1685
|
+
],
|
|
1686
|
+
"parameters": [
|
|
1687
|
+
{
|
|
1688
|
+
"in": "path",
|
|
1689
|
+
"name": "taxonomySlug",
|
|
1690
|
+
"description": "Taxonomy slug",
|
|
1691
|
+
"schema": {
|
|
1692
|
+
"type": "string"
|
|
1693
|
+
},
|
|
1694
|
+
"required": true
|
|
1695
|
+
}
|
|
1696
|
+
],
|
|
1697
|
+
"requestBody": {
|
|
1698
|
+
"content": {
|
|
1699
|
+
"application/json": {
|
|
1700
|
+
"schema": {
|
|
1701
|
+
"$ref": "#/components/schemas/ClassificationsUpdate"
|
|
1702
|
+
}
|
|
1703
|
+
}
|
|
1704
|
+
}
|
|
1705
|
+
},
|
|
1706
|
+
"responses": {
|
|
1707
|
+
"200": {
|
|
1708
|
+
"description": "Taxonomies classifications",
|
|
1709
|
+
"content": {
|
|
1710
|
+
"application/json": {
|
|
1711
|
+
"schema": {
|
|
1712
|
+
"type": "object",
|
|
1713
|
+
"properties": {
|
|
1714
|
+
"results": {
|
|
1715
|
+
"type": "array",
|
|
1716
|
+
"items": {
|
|
1717
|
+
"$ref": "#/components/schemas/Taxonomy"
|
|
1718
|
+
}
|
|
1719
|
+
}
|
|
1720
|
+
}
|
|
1721
|
+
}
|
|
1722
|
+
}
|
|
1723
|
+
}
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
}
|
|
1503
1727
|
}
|
|
1504
1728
|
},
|
|
1505
1729
|
"components": {
|
|
@@ -1522,6 +1746,10 @@
|
|
|
1522
1746
|
"description": "Export Job Id to get the result",
|
|
1523
1747
|
"type": "string"
|
|
1524
1748
|
},
|
|
1749
|
+
"Language": {
|
|
1750
|
+
"description": "Export headers translation Language",
|
|
1751
|
+
"type": "string"
|
|
1752
|
+
},
|
|
1525
1753
|
"IsTemplate": {
|
|
1526
1754
|
"description": "Pass 'true' to generate import template",
|
|
1527
1755
|
"type": "boolean"
|
|
@@ -3106,7 +3334,7 @@
|
|
|
3106
3334
|
"$ref": "#/components/schemas/EntityDefaultEdit"
|
|
3107
3335
|
},
|
|
3108
3336
|
{
|
|
3109
|
-
"$ref": "#/components/schemas/
|
|
3337
|
+
"$ref": "#/components/schemas/EntityDefaultTable"
|
|
3110
3338
|
},
|
|
3111
3339
|
{
|
|
3112
3340
|
"$ref": "#/components/schemas/RedirectEntityView"
|
|
@@ -3130,7 +3358,7 @@
|
|
|
3130
3358
|
}
|
|
3131
3359
|
}
|
|
3132
3360
|
},
|
|
3133
|
-
"
|
|
3361
|
+
"EntityDefaultTable": {
|
|
3134
3362
|
"type": "object",
|
|
3135
3363
|
"properties": {
|
|
3136
3364
|
"view_type": {
|
|
@@ -3203,6 +3431,42 @@
|
|
|
3203
3431
|
"type": "string"
|
|
3204
3432
|
}
|
|
3205
3433
|
},
|
|
3434
|
+
"navbar_actions": {
|
|
3435
|
+
"type": "array",
|
|
3436
|
+
"items": {
|
|
3437
|
+
"type": "object",
|
|
3438
|
+
"properties": {
|
|
3439
|
+
"type": {
|
|
3440
|
+
"type": "string"
|
|
3441
|
+
},
|
|
3442
|
+
"options": {
|
|
3443
|
+
"type": "array",
|
|
3444
|
+
"items": {
|
|
3445
|
+
"type": "object",
|
|
3446
|
+
"properties": {
|
|
3447
|
+
"label": {
|
|
3448
|
+
"type": "string"
|
|
3449
|
+
},
|
|
3450
|
+
"params": {
|
|
3451
|
+
"type": "object"
|
|
3452
|
+
}
|
|
3453
|
+
},
|
|
3454
|
+
"required": [
|
|
3455
|
+
"label"
|
|
3456
|
+
]
|
|
3457
|
+
}
|
|
3458
|
+
}
|
|
3459
|
+
},
|
|
3460
|
+
"required": [
|
|
3461
|
+
"type"
|
|
3462
|
+
]
|
|
3463
|
+
}
|
|
3464
|
+
},
|
|
3465
|
+
"enable_thumbnails": {
|
|
3466
|
+
"description": "Enable the thumbnail column",
|
|
3467
|
+
"type": "boolean",
|
|
3468
|
+
"default": false
|
|
3469
|
+
},
|
|
3206
3470
|
"classic_view": {
|
|
3207
3471
|
"type": "string",
|
|
3208
3472
|
"format": "uri"
|
|
@@ -3928,6 +4192,97 @@
|
|
|
3928
4192
|
"created_by",
|
|
3929
4193
|
"ui_config"
|
|
3930
4194
|
]
|
|
4195
|
+
},
|
|
4196
|
+
"Taxonomy": {
|
|
4197
|
+
"type": "object",
|
|
4198
|
+
"properties": {
|
|
4199
|
+
"slug": {
|
|
4200
|
+
"$ref": "#/components/schemas/TaxonomySlug"
|
|
4201
|
+
},
|
|
4202
|
+
"name": {
|
|
4203
|
+
"type": "string",
|
|
4204
|
+
"description": "A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag",
|
|
4205
|
+
"example": "Purpose"
|
|
4206
|
+
},
|
|
4207
|
+
"plural": {
|
|
4208
|
+
"type": "string",
|
|
4209
|
+
"description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags",
|
|
4210
|
+
"example": "Purposes"
|
|
4211
|
+
},
|
|
4212
|
+
"created_at": {
|
|
4213
|
+
"type": "string",
|
|
4214
|
+
"format": "date-time"
|
|
4215
|
+
},
|
|
4216
|
+
"updated_at": {
|
|
4217
|
+
"type": "string",
|
|
4218
|
+
"format": "date-time"
|
|
4219
|
+
}
|
|
4220
|
+
},
|
|
4221
|
+
"required": [
|
|
4222
|
+
"slug",
|
|
4223
|
+
"name"
|
|
4224
|
+
]
|
|
4225
|
+
},
|
|
4226
|
+
"TaxonomyClassification": {
|
|
4227
|
+
"type": "object",
|
|
4228
|
+
"properties": {
|
|
4229
|
+
"id": {
|
|
4230
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
4231
|
+
},
|
|
4232
|
+
"name": {
|
|
4233
|
+
"type": "string",
|
|
4234
|
+
"example": "Wallbox PV"
|
|
4235
|
+
},
|
|
4236
|
+
"parents": {
|
|
4237
|
+
"type": "array",
|
|
4238
|
+
"items": {
|
|
4239
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
4240
|
+
}
|
|
4241
|
+
},
|
|
4242
|
+
"created_at": {
|
|
4243
|
+
"type": "string",
|
|
4244
|
+
"format": "date-time"
|
|
4245
|
+
},
|
|
4246
|
+
"updated_at": {
|
|
4247
|
+
"type": "string",
|
|
4248
|
+
"format": "date-time"
|
|
4249
|
+
}
|
|
4250
|
+
},
|
|
4251
|
+
"required": [
|
|
4252
|
+
"name"
|
|
4253
|
+
]
|
|
4254
|
+
},
|
|
4255
|
+
"ClassificationId": {
|
|
4256
|
+
"type": "string",
|
|
4257
|
+
"format": "uuid"
|
|
4258
|
+
},
|
|
4259
|
+
"TaxonomySlug": {
|
|
4260
|
+
"type": "string",
|
|
4261
|
+
"description": "URL-friendly name for taxonomy",
|
|
4262
|
+
"example": "purpose"
|
|
4263
|
+
},
|
|
4264
|
+
"ClassificationsUpdate": {
|
|
4265
|
+
"type": "object",
|
|
4266
|
+
"properties": {
|
|
4267
|
+
"create": {
|
|
4268
|
+
"type": "array",
|
|
4269
|
+
"items": {
|
|
4270
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
4271
|
+
}
|
|
4272
|
+
},
|
|
4273
|
+
"update": {
|
|
4274
|
+
"type": "array",
|
|
4275
|
+
"items": {
|
|
4276
|
+
"$ref": "#/components/schemas/TaxonomyClassification"
|
|
4277
|
+
}
|
|
4278
|
+
},
|
|
4279
|
+
"delete": {
|
|
4280
|
+
"type": "array",
|
|
4281
|
+
"items": {
|
|
4282
|
+
"$ref": "#/components/schemas/ClassificationId"
|
|
4283
|
+
}
|
|
4284
|
+
}
|
|
4285
|
+
}
|
|
3931
4286
|
}
|
|
3932
4287
|
},
|
|
3933
4288
|
"examples": {
|
|
@@ -4548,7 +4903,7 @@
|
|
|
4548
4903
|
},
|
|
4549
4904
|
"servers": [
|
|
4550
4905
|
{
|
|
4551
|
-
"url": "
|
|
4906
|
+
"url": "null"
|
|
4552
4907
|
}
|
|
4553
4908
|
]
|
|
4554
4909
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "4.3.
|
|
3
|
+
"version": "4.3.3",
|
|
4
4
|
"description": "JavaScript client library for the epilot Core Entity API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"test": "jest",
|
|
25
25
|
"typescript": "tsc",
|
|
26
26
|
"bundle-definition": "webpack",
|
|
27
|
-
"openapi": "../../scripts/update-openapi.sh
|
|
27
|
+
"openapi": "../../scripts/update-openapi.sh ./openapi.yml",
|
|
28
28
|
"typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
|
|
29
29
|
"build": "tsc && npm run bundle-definition",
|
|
30
30
|
"build:watch": "npm run build && tsc -w",
|