@epilot/entity-client 3.0.5 → 3.0.8

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 (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +189 -71
  3. package/dist/openapi.json +75 -17
  4. package/package-lock.json +18779 -0
  5. package/package.json +2 -2
package/dist/openapi.json CHANGED
@@ -32,7 +32,18 @@
32
32
  "get": {
33
33
  "operationId": "listSchemas",
34
34
  "summary": "listSchemas",
35
- "description": "List local versions of all available schemas",
35
+ "description": "Get the latest version of local schema",
36
+ "parameters": [
37
+ {
38
+ "in": "query",
39
+ "name": "unpublished",
40
+ "description": "Includes the unpublished version of unpublished schema",
41
+ "schema": {
42
+ "type": "boolean",
43
+ "default": false
44
+ }
45
+ }
46
+ ],
36
47
  "tags": [
37
48
  "Schemas"
38
49
  ],
@@ -92,7 +103,7 @@
92
103
  "get": {
93
104
  "operationId": "getSchemaVersions",
94
105
  "summary": "getSchemaVersions",
95
- "description": "Get all versions of this schema",
106
+ "description": "Get all versions of this schema ordered by the latest versions including drafts.",
96
107
  "tags": [
97
108
  "Schemas"
98
109
  ],
@@ -114,7 +125,13 @@
114
125
  "schema": {
115
126
  "type": "object",
116
127
  "properties": {
117
- "results": {
128
+ "versions": {
129
+ "type": "array",
130
+ "items": {
131
+ "$ref": "#/components/schemas/EntitySchemaItem"
132
+ }
133
+ },
134
+ "drafts": {
118
135
  "type": "array",
119
136
  "items": {
120
137
  "$ref": "#/components/schemas/EntitySchemaItem"
@@ -132,6 +149,7 @@
132
149
  "get": {
133
150
  "operationId": "getSchema",
134
151
  "summary": "getSchema",
152
+ "description": "By default gets the latest version of the Schema and to get the specific version of schema pass the id.",
135
153
  "tags": [
136
154
  "Schemas"
137
155
  ],
@@ -148,7 +166,7 @@
148
166
  "in": "query",
149
167
  "name": "id",
150
168
  "schema": {
151
- "type": "string"
169
+ "$ref": "#/components/schemas/SchemaId"
152
170
  }
153
171
  }
154
172
  ],
@@ -166,9 +184,9 @@
166
184
  }
167
185
  },
168
186
  "put": {
169
- "operationId": "putSchema",
170
- "summary": "putSchema",
171
- "description": "Create new version of the schema",
187
+ "operationId": "createNewSchemaVersion",
188
+ "summary": "createNewSchemaVersion",
189
+ "description": "Create new version of the schema and default draft is false.",
172
190
  "tags": [
173
191
  "Schemas"
174
192
  ],
@@ -213,8 +231,9 @@
213
231
  }
214
232
  },
215
233
  "delete": {
216
- "operationId": "deleteSchema",
217
- "summary": "deleteSchema",
234
+ "operationId": "deleteSchemaById",
235
+ "summary": "deleteSchemaById",
236
+ "description": "Delete schema by Id",
218
237
  "tags": [
219
238
  "Schemas"
220
239
  ],
@@ -230,8 +249,9 @@
230
249
  {
231
250
  "in": "query",
232
251
  "name": "id",
252
+ "required": true,
233
253
  "schema": {
234
- "type": "string"
254
+ "$ref": "#/components/schemas/SchemaId"
235
255
  }
236
256
  }
237
257
  ],
@@ -269,7 +289,7 @@
269
289
  }
270
290
  },
271
291
  "text/csv": {
272
- "schemas": {
292
+ "schema": {
273
293
  "type": "string"
274
294
  }
275
295
  }
@@ -1269,6 +1289,14 @@
1269
1289
  "type": "string",
1270
1290
  "example": "Contacts"
1271
1291
  },
1292
+ "published": {
1293
+ "type": "boolean",
1294
+ "example": false
1295
+ },
1296
+ "draft": {
1297
+ "type": "boolean",
1298
+ "example": false
1299
+ },
1272
1300
  "icon": {
1273
1301
  "type": "string",
1274
1302
  "example": "person"
@@ -1331,6 +1359,11 @@
1331
1359
  "type": "integer",
1332
1360
  "default": 0
1333
1361
  },
1362
+ "feature_flag": {
1363
+ "type": "string",
1364
+ "example": "FF_MY_FEATURE_FLAG",
1365
+ "description": "This schema should only be active when the feature flag is enabled"
1366
+ },
1334
1367
  "info_tooltip_title": {
1335
1368
  "type": "object",
1336
1369
  "properties": {
@@ -1447,6 +1480,26 @@
1447
1480
  "properties": {
1448
1481
  "id": {
1449
1482
  "$ref": "#/components/schemas/SchemaId"
1483
+ },
1484
+ "created_at": {
1485
+ "type": "string"
1486
+ },
1487
+ "updated_at": {
1488
+ "type": "string"
1489
+ },
1490
+ "comment": {
1491
+ "type": "string"
1492
+ },
1493
+ "source": {
1494
+ "type": "object",
1495
+ "properties": {
1496
+ "id": {
1497
+ "type": "string"
1498
+ },
1499
+ "type": {
1500
+ "type": "string"
1501
+ }
1502
+ }
1450
1503
  }
1451
1504
  }
1452
1505
  },
@@ -1613,7 +1666,8 @@
1613
1666
  "type": "boolean",
1614
1667
  "default": false
1615
1668
  },
1616
- "deletable": {
1669
+ "protected": {
1670
+ "description": "Setting to `true` prevents the attribute from being modified / deleted",
1617
1671
  "type": "boolean",
1618
1672
  "default": true
1619
1673
  }
@@ -1781,6 +1835,10 @@
1781
1835
  }
1782
1836
  ]
1783
1837
  }
1838
+ },
1839
+ "allow_any": {
1840
+ "type": "boolean",
1841
+ "description": "Allow arbitrary input values in addition to provided options"
1784
1842
  }
1785
1843
  }
1786
1844
  }
@@ -1822,8 +1880,7 @@
1822
1880
  }
1823
1881
  },
1824
1882
  "required": [
1825
- "type",
1826
- "attachments"
1883
+ "type"
1827
1884
  ]
1828
1885
  }
1829
1886
  ]
@@ -1920,8 +1977,8 @@
1920
1977
  "relation_type": {
1921
1978
  "type": "string",
1922
1979
  "enum": [
1923
- "belongs_to",
1924
- "has_many"
1980
+ "has_many",
1981
+ "has_one"
1925
1982
  ]
1926
1983
  },
1927
1984
  "delete_mode": {
@@ -2065,7 +2122,8 @@
2065
2122
  "phone",
2066
2123
  "email",
2067
2124
  "address",
2068
- "relation"
2125
+ "relation",
2126
+ "payment"
2069
2127
  ]
2070
2128
  },
2071
2129
  "enable_relation_picker": {