@botpress/api 0.29.2 → 0.29.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/index.js +42 -42
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +42 -42
package/dist/index.js
CHANGED
|
@@ -273099,7 +273099,7 @@ var state = {
|
|
|
273099
273099
|
"createFile": {
|
|
273100
273100
|
"name": "createFile",
|
|
273101
273101
|
"path": "/v1/files",
|
|
273102
|
-
"description": "Creates a file.",
|
|
273102
|
+
"description": "Creates a file. Once the file is created, use the uploadUrl from the response body to upload the file content, using a PUT request.",
|
|
273103
273103
|
"method": "post",
|
|
273104
273104
|
"requestBody": {
|
|
273105
273105
|
"description": "The file to upload.",
|
|
@@ -273216,18 +273216,18 @@ var state = {
|
|
|
273216
273216
|
"status": {
|
|
273217
273217
|
"type": "string",
|
|
273218
273218
|
"enum": [
|
|
273219
|
-
"
|
|
273220
|
-
"
|
|
273221
|
-
"
|
|
273222
|
-
"
|
|
273223
|
-
"
|
|
273224
|
-
"
|
|
273219
|
+
"upload_pending",
|
|
273220
|
+
"upload_failed",
|
|
273221
|
+
"upload_completed",
|
|
273222
|
+
"indexing_pending",
|
|
273223
|
+
"indexing_failed",
|
|
273224
|
+
"indexing_completed"
|
|
273225
273225
|
],
|
|
273226
|
-
"description": 'Status of the file. If the status is "
|
|
273226
|
+
"description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
|
|
273227
273227
|
},
|
|
273228
273228
|
"failedStatusReason": {
|
|
273229
273229
|
"type": "string",
|
|
273230
|
-
"description": 'If the file status is "
|
|
273230
|
+
"description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
|
|
273231
273231
|
},
|
|
273232
273232
|
"uploadUrl": {
|
|
273233
273233
|
"type": "string",
|
|
@@ -273377,18 +273377,18 @@ var state = {
|
|
|
273377
273377
|
"status": {
|
|
273378
273378
|
"type": "string",
|
|
273379
273379
|
"enum": [
|
|
273380
|
-
"
|
|
273381
|
-
"
|
|
273382
|
-
"
|
|
273383
|
-
"
|
|
273384
|
-
"
|
|
273385
|
-
"
|
|
273380
|
+
"upload_pending",
|
|
273381
|
+
"upload_failed",
|
|
273382
|
+
"upload_completed",
|
|
273383
|
+
"indexing_pending",
|
|
273384
|
+
"indexing_failed",
|
|
273385
|
+
"indexing_completed"
|
|
273386
273386
|
],
|
|
273387
|
-
"description": 'Status of the file. If the status is "
|
|
273387
|
+
"description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
|
|
273388
273388
|
},
|
|
273389
273389
|
"failedStatusReason": {
|
|
273390
273390
|
"type": "string",
|
|
273391
|
-
"description": 'If the file status is "
|
|
273391
|
+
"description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
|
|
273392
273392
|
}
|
|
273393
273393
|
},
|
|
273394
273394
|
"required": [
|
|
@@ -273509,18 +273509,18 @@ var state = {
|
|
|
273509
273509
|
"status": {
|
|
273510
273510
|
"type": "string",
|
|
273511
273511
|
"enum": [
|
|
273512
|
-
"
|
|
273513
|
-
"
|
|
273514
|
-
"
|
|
273515
|
-
"
|
|
273516
|
-
"
|
|
273517
|
-
"
|
|
273512
|
+
"upload_pending",
|
|
273513
|
+
"upload_failed",
|
|
273514
|
+
"upload_completed",
|
|
273515
|
+
"indexing_pending",
|
|
273516
|
+
"indexing_failed",
|
|
273517
|
+
"indexing_completed"
|
|
273518
273518
|
],
|
|
273519
|
-
"description": 'Status of the file. If the status is "
|
|
273519
|
+
"description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
|
|
273520
273520
|
},
|
|
273521
273521
|
"failedStatusReason": {
|
|
273522
273522
|
"type": "string",
|
|
273523
|
-
"description": 'If the file status is "
|
|
273523
|
+
"description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
|
|
273524
273524
|
}
|
|
273525
273525
|
},
|
|
273526
273526
|
"required": [
|
|
@@ -273660,18 +273660,18 @@ var state = {
|
|
|
273660
273660
|
"status": {
|
|
273661
273661
|
"type": "string",
|
|
273662
273662
|
"enum": [
|
|
273663
|
-
"
|
|
273664
|
-
"
|
|
273665
|
-
"
|
|
273666
|
-
"
|
|
273667
|
-
"
|
|
273668
|
-
"
|
|
273663
|
+
"upload_pending",
|
|
273664
|
+
"upload_failed",
|
|
273665
|
+
"upload_completed",
|
|
273666
|
+
"indexing_pending",
|
|
273667
|
+
"indexing_failed",
|
|
273668
|
+
"indexing_completed"
|
|
273669
273669
|
],
|
|
273670
|
-
"description": 'Status of the file. If the status is "
|
|
273670
|
+
"description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
|
|
273671
273671
|
},
|
|
273672
273672
|
"failedStatusReason": {
|
|
273673
273673
|
"type": "string",
|
|
273674
|
-
"description": 'If the file status is "
|
|
273674
|
+
"description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
|
|
273675
273675
|
}
|
|
273676
273676
|
},
|
|
273677
273677
|
"required": [
|
|
@@ -274707,7 +274707,7 @@ var state = {
|
|
|
274707
274707
|
"title": "Botpress API",
|
|
274708
274708
|
"description": "API for Botpress Cloud",
|
|
274709
274709
|
"server": "https://api.botpress.cloud",
|
|
274710
|
-
"version": "0.29.
|
|
274710
|
+
"version": "0.29.3",
|
|
274711
274711
|
"prefix": "v1"
|
|
274712
274712
|
},
|
|
274713
274713
|
"errors": [
|
|
@@ -277224,18 +277224,18 @@ var state = {
|
|
|
277224
277224
|
"status": {
|
|
277225
277225
|
"type": "string",
|
|
277226
277226
|
"enum": [
|
|
277227
|
-
"
|
|
277228
|
-
"
|
|
277229
|
-
"
|
|
277230
|
-
"
|
|
277231
|
-
"
|
|
277232
|
-
"
|
|
277227
|
+
"upload_pending",
|
|
277228
|
+
"upload_failed",
|
|
277229
|
+
"upload_completed",
|
|
277230
|
+
"indexing_pending",
|
|
277231
|
+
"indexing_failed",
|
|
277232
|
+
"indexing_completed"
|
|
277233
277233
|
],
|
|
277234
|
-
"description": 'Status of the file. If the status is "
|
|
277234
|
+
"description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
|
|
277235
277235
|
},
|
|
277236
277236
|
"failedStatusReason": {
|
|
277237
277237
|
"type": "string",
|
|
277238
|
-
"description": 'If the file status is "
|
|
277238
|
+
"description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
|
|
277239
277239
|
}
|
|
277240
277240
|
},
|
|
277241
277241
|
"required": [
|