@epilot/entity-client 4.0.4 → 4.0.5

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/openapi.json CHANGED
@@ -14,9 +14,17 @@
14
14
  "name": "Entities",
15
15
  "description": "CRUD Access for Entities"
16
16
  },
17
+ {
18
+ "name": "Relations",
19
+ "description": "Entity Relationships"
20
+ },
17
21
  {
18
22
  "name": "Activity",
19
23
  "description": "Entity Events"
24
+ },
25
+ {
26
+ "name": "Export",
27
+ "description": "Export and Import entities via files"
20
28
  }
21
29
  ],
22
30
  "security": [
@@ -1240,6 +1248,40 @@
1240
1248
  }
1241
1249
  }
1242
1250
  }
1251
+ },
1252
+ "/v1/entity:export": {
1253
+ "post": {
1254
+ "operationId": "exportEntities",
1255
+ "summary": "exportEntities",
1256
+ "description": "create export file of entities",
1257
+ "tags": [
1258
+ "Export"
1259
+ ],
1260
+ "parameters": [
1261
+ {
1262
+ "in": "query",
1263
+ "name": "job_id",
1264
+ "description": "Export Job Id to get the result",
1265
+ "schema": {
1266
+ "$ref": "#/components/schemas/ExportJobId"
1267
+ }
1268
+ }
1269
+ ],
1270
+ "requestBody": {
1271
+ "content": {
1272
+ "application/json": {
1273
+ "schema": {
1274
+ "$ref": "#/components/schemas/EntitySearchParams"
1275
+ }
1276
+ }
1277
+ }
1278
+ },
1279
+ "responses": {
1280
+ "201": {
1281
+ "description": "created export url and download url"
1282
+ }
1283
+ }
1284
+ }
1243
1285
  }
1244
1286
  },
1245
1287
  "components": {
@@ -1258,6 +1300,10 @@
1258
1300
  }
1259
1301
  },
1260
1302
  "schemas": {
1303
+ "ExportJobId": {
1304
+ "description": "Export Job Id to get the result",
1305
+ "type": "string"
1306
+ },
1261
1307
  "SchemaId": {
1262
1308
  "description": "Generated uuid for schema",
1263
1309
  "type": "string",
@@ -2595,7 +2641,7 @@
2595
2641
  ]
2596
2642
  },
2597
2643
  "SummaryAttribute": {
2598
- "description": "Represents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n \"label\": \"Price components\"\n \"value\": \"{{item.prices.length}} price components\"\n \"show_as_tag\": true\n \"render_condition\": \"is_composite_price = \\\"true\\\"\"\n}\n```\nThe value field supports handlebar expressions from which you can pick any field from the entity state.\n",
2644
+ "description": "Represents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n \"label\": \"Price components\"\n \"value\": \"{{item.prices.length}} price components\"\n \"show_as_tag\": true\n \"render_condition\": \"is_composite_price = \"true\"\"\n}\n```\nThe value field supports handlebar expressions from which you can pick any field from the entity state.\n",
2599
2645
  "type": "object",
2600
2646
  "properties": {
2601
2647
  "label": {
@@ -3314,6 +3360,9 @@
3314
3360
  "type": "string",
3315
3361
  "example": "123"
3316
3362
  },
3363
+ "activity_id": {
3364
+ "$ref": "#/components/schemas/ActivityId"
3365
+ },
3317
3366
  "operation": {
3318
3367
  "type": "string",
3319
3368
  "enum": [