docs/_schemas.md in losant_rest-1.4.0 vs docs/_schemas.md in losant_rest-1.4.1
- old
+ new
@@ -31,10 +31,11 @@
* [Data Table Post](#data-table-post)
* [Data Table Query](#data-table-query)
* [Data Table Row](#data-table-row)
* [Data Table Row Insert/Update](#data-table-row-insert/update)
* [Data Table Rows](#data-table-rows)
+* [Data Table Rows Delete](#data-table-rows-delete)
* [Data Table Export](#data-table-export)
* [Data Tables](#data-tables)
* [Device](#device)
* [Device Command](#device-command)
* [Device Commands](#device-commands)
@@ -361,11 +362,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -446,10 +447,91 @@
"status"
],
"additionalProperties": false
},
"maxItems": 100
+ },
+ "archiveConfig": {
+ "type": "object",
+ "properties": {
+ "directory": {
+ "type": "string",
+ "max": 255
+ },
+ "whiteList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "blackList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "s3": {
+ "type": "object",
+ "properties": {
+ "bucket": {
+ "type": "string",
+ "max": 255
+ },
+ "accessKeyId": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "secretAccessKey": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "region": {
+ "type": "string",
+ "max": 128
+ }
+ },
+ "required": [
+ "bucket",
+ "accessKeyId",
+ "secretAccessKey",
+ "region"
+ ],
+ "additionalProperties": false
+ },
+ "gcs": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "keyJson": {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ "bucket": {
+ "type": "string",
+ "max": 255
+ }
+ },
+ "required": [
+ "projectId",
+ "keyJson",
+ "bucket"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "additionalProperties": false
}
}
}
```
### <a name="application-example"></a> Example
@@ -469,10 +551,22 @@
"flowCount": 2,
"webhookCount": 0,
"eventCount": 0,
"keyCount": 1,
"deviceRecipeCount": 0
+ },
+ "archiveConfig": {
+ "s3": {
+ "bucket": "bucketName",
+ "accessKeyId": "awsAccessKey",
+ "accessSecretKey": "awsSecretKey",
+ "region": "us-west-1"
+ },
+ "blackList": [
+ "575ec8687ae143cd83dc4a95",
+ "575ec8687ae143cd83dc4a91"
+ ]
}
}
```
<br/>
@@ -567,10 +661,13 @@
"dataTableRow.get",
"dataTableRow.patch",
"dataTableRows.get",
"dataTableRows.post",
"dataTableRows.query",
+ "dataTableRows.export",
+ "dataTableRows.delete",
+ "dataTableRows.truncate",
"dataTables.get",
"dataTables.post",
"device.delete",
"device.export",
"device.get",
@@ -1153,11 +1250,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -1191,10 +1288,91 @@
"status"
],
"additionalProperties": false
},
"maxItems": 100
+ },
+ "archiveConfig": {
+ "type": "object",
+ "properties": {
+ "directory": {
+ "type": "string",
+ "max": 255
+ },
+ "whiteList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "blackList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "s3": {
+ "type": "object",
+ "properties": {
+ "bucket": {
+ "type": "string",
+ "max": 255
+ },
+ "accessKeyId": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "secretAccessKey": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "region": {
+ "type": "string",
+ "max": 128
+ }
+ },
+ "required": [
+ "bucket",
+ "accessKeyId",
+ "secretAccessKey",
+ "region"
+ ],
+ "additionalProperties": false
+ },
+ "gcs": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "keyJson": {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ "bucket": {
+ "type": "string",
+ "max": 255
+ }
+ },
+ "required": [
+ "projectId",
+ "keyJson",
+ "bucket"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "additionalProperties": false
}
},
"additionalProperties": false
}
```
@@ -1257,19 +1435,100 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
"json"
]
}
+ },
+ "archiveConfig": {
+ "type": "object",
+ "properties": {
+ "directory": {
+ "type": "string",
+ "max": 255
+ },
+ "whiteList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "blackList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "s3": {
+ "type": "object",
+ "properties": {
+ "bucket": {
+ "type": "string",
+ "max": 255
+ },
+ "accessKeyId": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "secretAccessKey": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "region": {
+ "type": "string",
+ "max": 128
+ }
+ },
+ "required": [
+ "bucket",
+ "accessKeyId",
+ "secretAccessKey",
+ "region"
+ ],
+ "additionalProperties": false
+ },
+ "gcs": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "keyJson": {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ "bucket": {
+ "type": "string",
+ "max": 255
+ }
+ },
+ "required": [
+ "projectId",
+ "keyJson",
+ "bucket"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"name"
@@ -1365,11 +1624,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -1450,10 +1709,91 @@
"status"
],
"additionalProperties": false
},
"maxItems": 100
+ },
+ "archiveConfig": {
+ "type": "object",
+ "properties": {
+ "directory": {
+ "type": "string",
+ "max": 255
+ },
+ "whiteList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "blackList": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "max": 100
+ },
+ "s3": {
+ "type": "object",
+ "properties": {
+ "bucket": {
+ "type": "string",
+ "max": 255
+ },
+ "accessKeyId": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "secretAccessKey": {
+ "type": "string",
+ "min": 16,
+ "max": 128
+ },
+ "region": {
+ "type": "string",
+ "max": 128
+ }
+ },
+ "required": [
+ "bucket",
+ "accessKeyId",
+ "secretAccessKey",
+ "region"
+ ],
+ "additionalProperties": false
+ },
+ "gcs": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "keyJson": {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ "bucket": {
+ "type": "string",
+ "max": 255
+ }
+ },
+ "required": [
+ "projectId",
+ "keyJson",
+ "bucket"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "additionalProperties": false
}
}
}
},
"count": {
@@ -1506,10 +1846,22 @@
"flowCount": 2,
"webhookCount": 0,
"eventCount": 0,
"keyCount": 1,
"deviceRecipeCount": 0
+ },
+ "archiveConfig": {
+ "s3": {
+ "bucket": "bucketName",
+ "accessKeyId": "awsAccessKey",
+ "accessSecretKey": "awsSecretKey",
+ "region": "us-west-1"
+ },
+ "blackList": [
+ "575ec8687ae143cd83dc4a95",
+ "575ec8687ae143cd83dc4a91"
+ ]
}
}
],
"count": 1,
"totalCount": 8,
@@ -3961,10 +4313,37 @@
}
```
<br/>
+## Data Table Rows Delete
+
+Schema for response to data table rows removal
+
+### <a name="data-table-rows-delete-schema"></a> Schema
+
+```json
+{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "type": "object",
+ "properties": {
+ "removed": {
+ "type": "Number"
+ }
+ }
+}
+```
+### <a name="data-table-rows-delete-example"></a> Example
+
+```json
+{
+ "removed": 100
+}
+```
+
+<br/>
+
## Data Table Export
Schema for the body of a data table export
### <a name="data-table-export-schema"></a> Schema
@@ -6660,23 +7039,44 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sslKey": {
- "type": "string",
- "maxLength": 32767,
- "minLength": 50
+ "$oneOf": [
+ {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ {
+ "type": null
+ }
+ ]
},
"sslCert": {
- "type": "string",
- "maxLength": 32767,
- "minLength": 50
+ "$oneOf": [
+ {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ {
+ "type": null
+ }
+ ]
},
"sslBundle": {
- "type": "string",
- "maxLength": 32767,
- "minLength": 50
+ "$oneOf": [
+ {
+ "type": "string",
+ "maxLength": 32767,
+ "minLength": 50
+ },
+ {
+ "type": null
+ }
+ ]
},
"domainName": {
"type": "string",
"maxLength": 1024,
"minLength": 3
@@ -8702,11 +9102,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -8986,11 +9386,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -9142,11 +9542,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -9429,11 +9829,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -9626,11 +10026,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -9816,11 +10216,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -10062,11 +10462,11 @@
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"json": {
"type": "string",
"minLength": 1,
- "maxLength": 2048
+ "maxLength": 32767
}
},
"additionalProperties": false,
"required": [
"key",
@@ -14716,11 +15116,12 @@
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
- "twilio"
+ "twilio",
+ "alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
@@ -14781,11 +15182,12 @@
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
- "twilio"
+ "twilio",
+ "alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
@@ -14841,11 +15243,12 @@
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
- "twilio"
+ "twilio",
+ "alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
@@ -14934,10 +15337,11 @@
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
- "twilio"
+ "twilio",
+ "alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767