@alwaysai/device-agent-schemas 1.2.0 → 2.0.0
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/README.md +8 -4
- package/development.md +37 -0
- package/docs/README.md +81 -0
- package/docs/agent-message-schema-defs-toclient.md +25 -0
- package/docs/agent-message-schema-defs-tocloud.md +25 -0
- package/docs/agent-message-schema-defs.md +15 -0
- package/docs/agent-message-schema-properties-deviceid.md +15 -0
- package/docs/agent-message-schema-properties-payload-oneof-app_install_status.md +66 -0
- package/docs/agent-message-schema-properties-payload-oneof-app_logs.md +66 -0
- package/docs/agent-message-schema-properties-payload-oneof-app_state.md +66 -0
- package/docs/agent-message-schema-properties-payload-oneof-device_stats.md +66 -0
- package/docs/agent-message-schema-properties-payload-oneof-signed_urls_request.md +85 -0
- package/docs/agent-message-schema-properties-payload.md +27 -0
- package/docs/agent-message-schema-properties-timestamp.md +15 -0
- package/docs/agent-message-schema-properties-topic-oneof-0.md +25 -0
- package/docs/agent-message-schema-properties-topic-oneof-1.md +25 -0
- package/docs/agent-message-schema-properties-topic.md +21 -0
- package/docs/agent-message-schema.md +138 -0
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload-properties-appsignedurl.md +15 -0
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md +39 -0
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appreleasehash.md +25 -0
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-models_install_payload.md +15 -0
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-projectid.md +25 -0
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse.md +116 -0
- package/docs/app-install-cloud-response-schema-properties-messagetype.md +23 -0
- package/docs/app-install-cloud-response-schema.md +66 -0
- package/docs/app-install-schema-properties-appreleasehash.md +25 -0
- package/docs/app-install-schema-properties-basecommand.md +23 -0
- package/docs/app-install-schema-properties-projectid.md +25 -0
- package/docs/app-install-schema.md +105 -0
- package/docs/app-install-status-schema-properties-appinstallstatus-properties-appreleasehash.md +25 -0
- package/docs/app-install-status-schema-properties-appinstallstatus-properties-message.md +15 -0
- package/docs/app-install-status-schema-properties-appinstallstatus-properties-status.md +26 -0
- package/docs/app-install-status-schema-properties-appinstallstatus.md +98 -0
- package/docs/app-install-status-schema-properties-messagetype.md +23 -0
- package/docs/app-install-status-schema.md +66 -0
- package/docs/app-logs-schema-properties-applogs-properties-logchunk.md +15 -0
- package/docs/app-logs-schema-properties-applogs-properties-projectid.md +25 -0
- package/docs/app-logs-schema-properties-applogs.md +68 -0
- package/docs/app-logs-schema-properties-messagetype.md +23 -0
- package/docs/app-logs-schema.md +66 -0
- package/docs/app-state-control-schema-properties-appstatecontrol-properties-basecommand.md +25 -0
- package/docs/app-state-control-schema-properties-appstatecontrol-properties-projectid.md +25 -0
- package/docs/app-state-control-schema-properties-appstatecontrol.md +78 -0
- package/docs/app-state-control-schema-properties-messagetype.md +23 -0
- package/docs/app-state-control-schema.md +66 -0
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-projectid.md +25 -0
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-version.md +25 -0
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails.md +78 -0
- package/docs/app-state-schema-properties-appstate-items-properties-services-items-properties-name.md +15 -0
- package/docs/app-state-schema-properties-appstate-items-properties-services-items-properties-state.md +25 -0
- package/docs/app-state-schema-properties-appstate-items-properties-services-items.md +68 -0
- package/docs/app-state-schema-properties-appstate-items-properties-services.md +15 -0
- package/docs/app-state-schema-properties-appstate-items.md +58 -0
- package/docs/app-state-schema-properties-appstate.md +15 -0
- package/docs/app-state-schema-properties-messagetype.md +23 -0
- package/docs/app-state-schema.md +66 -0
- package/docs/app-uninstall-schema-properties-basecommand.md +23 -0
- package/docs/app-uninstall-schema-properties-projectid.md +25 -0
- package/docs/app-uninstall-schema.md +76 -0
- package/docs/app-version-control-schema-properties-appversioncontrol.md +21 -0
- package/docs/app-version-control-schema-properties-messagetype.md +23 -0
- package/docs/app-version-control-schema.md +72 -0
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-appinstallpayload-properties-appsignedurl.md +15 -0
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-appinstallpayload.md +39 -0
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-appreleasehash.md +25 -0
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-modelsinstallpayload.md +15 -0
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-projectid.md +25 -0
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse.md +116 -0
- package/docs/app_install_cloud_response_schema-properties-messagetype.md +23 -0
- package/docs/app_install_cloud_response_schema.md +66 -0
- package/docs/app_install_schema-properties-appreleasehash.md +25 -0
- package/docs/app_install_schema-properties-basecommand.md +23 -0
- package/docs/app_install_schema-properties-projectid.md +25 -0
- package/docs/app_install_schema.md +105 -0
- package/docs/app_state_control_schema-properties-appstatecontrol-properties-basecommand.md +25 -0
- package/docs/app_state_control_schema-properties-appstatecontrol-properties-projectid.md +25 -0
- package/docs/app_state_control_schema-properties-appstatecontrol.md +78 -0
- package/docs/app_state_control_schema-properties-messagetype.md +23 -0
- package/docs/app_state_control_schema.md +66 -0
- package/docs/app_uninstall_schema-properties-basecommand.md +23 -0
- package/docs/app_uninstall_schema-properties-projectid.md +25 -0
- package/docs/app_uninstall_schema.md +76 -0
- package/docs/app_version_control_schema-properties-appversioncontrol.md +21 -0
- package/docs/app_version_control_schema-properties-messagetype.md +23 -0
- package/docs/app_version_control_schema.md +72 -0
- package/docs/client-message-schema-defs-message.md +25 -0
- package/docs/client-message-schema-defs.md +15 -0
- package/docs/client-message-schema-properties-payload-oneof-live_state_updates.md +66 -0
- package/docs/client-message-schema-properties-payload-oneof-models_install_cloud_response.md +66 -0
- package/docs/client-message-schema-properties-payload.md +27 -0
- package/docs/client-message-schema-properties-timestamp.md +15 -0
- package/docs/client-message-schema-properties-topic.md +25 -0
- package/docs/client-message-schema.md +112 -0
- package/docs/client_message_schema-defs-message.md +25 -0
- package/docs/client_message_schema-defs.md +15 -0
- package/docs/client_message_schema-properties-payload-oneof-3.md +66 -0
- package/docs/client_message_schema-properties-payload-oneof-4.md +66 -0
- package/docs/client_message_schema-properties-payload.md +27 -0
- package/docs/client_message_schema-properties-timestamp.md +15 -0
- package/docs/client_message_schema-properties-topic.md +25 -0
- package/docs/client_message_schema.md +112 -0
- package/docs/common-schema-defs-appreleasehash.md +25 -0
- package/docs/common-schema-defs-modelid.md +25 -0
- package/docs/common-schema-defs-projectid.md +25 -0
- package/docs/common-schema-defs.md +15 -0
- package/docs/common-schema.md +50 -0
- package/docs/device-status-schema-properties-devicestats-properties-cpuusage.md +15 -0
- package/docs/device-status-schema-properties-devicestats-properties-diskutil.md +15 -0
- package/docs/device-status-schema-properties-devicestats-properties-usedmemorypercentage.md +15 -0
- package/docs/device-status-schema-properties-devicestats.md +77 -0
- package/docs/device-status-schema-properties-messagetype.md +23 -0
- package/docs/device-status-schema.md +66 -0
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs-properties-projectid.md +25 -0
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs-properties-toggle.md +15 -0
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs.md +68 -0
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-appstate.md +15 -0
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-devicestats.md +15 -0
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles.md +77 -0
- package/docs/live-updates-toggle-schema-properties-messagetype.md +23 -0
- package/docs/live-updates-toggle-schema.md +66 -0
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-applogs-properties-projectid.md +25 -0
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-applogs-properties-toggle.md +15 -0
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-applogs.md +68 -0
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-appstate.md +15 -0
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-devicestats.md +15 -0
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles.md +77 -0
- package/docs/live_updates_toggle_schema-properties-messagetype.md +23 -0
- package/docs/live_updates_toggle_schema.md +66 -0
- package/docs/models-install-cloud-response-schema-properties-messagetype.md +23 -0
- package/docs/models-install-cloud-response-schema-properties-modelsinstallcloudresponse-properties-projectid.md +25 -0
- package/docs/models-install-cloud-response-schema-properties-modelsinstallcloudresponse.md +68 -0
- package/docs/models-install-cloud-response-schema.md +66 -0
- package/docs/models-install-payload-schema-items-properties-id.md +25 -0
- package/docs/models-install-payload-schema-items-properties-modelsignedurl.md +15 -0
- package/docs/models-install-payload-schema-items-properties-version.md +15 -0
- package/docs/models-install-payload-schema-items.md +87 -0
- package/docs/models-install-payload-schema.md +15 -0
- package/docs/models_install_cloud_response_schema-properties-messagetype.md +23 -0
- package/docs/models_install_cloud_response_schema-properties-modelsinstallcloudresponse-properties-projectid.md +25 -0
- package/docs/models_install_cloud_response_schema-properties-modelsinstallcloudresponse.md +68 -0
- package/docs/models_install_cloud_response_schema.md +66 -0
- package/docs/models_install_payload_schema-items-properties-id.md +25 -0
- package/docs/models_install_payload_schema-items-properties-modelsignedurl.md +15 -0
- package/docs/models_install_payload_schema-items-properties-version.md +15 -0
- package/docs/models_install_payload_schema-items.md +87 -0
- package/docs/models_install_payload_schema.md +15 -0
- package/docs/signed-urls-request-schema-properties-messagetype.md +23 -0
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models-patternproperties-a-za-z0-9_.md +15 -0
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models-patternproperties.md +15 -0
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md +39 -0
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-projectid.md +25 -0
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest.md +68 -0
- package/docs/signed-urls-request-schema-properties-signedurlsrequest-properties-appreleasehash.md +25 -0
- package/docs/signed-urls-request-schema-properties-signedurlsrequest-properties-projectid.md +25 -0
- package/docs/signed-urls-request-schema-properties-signedurlsrequest.md +78 -0
- package/docs/signed-urls-request-schema.md +85 -0
- package/lib/app-action-schema.d.ts +54 -0
- package/lib/app-action-schema.d.ts.map +1 -0
- package/lib/app-action-schema.js +3 -0
- package/lib/app-action-schema.js.map +1 -0
- package/lib/app-logs-schema.d.ts +11 -0
- package/lib/app-logs-schema.d.ts.map +1 -0
- package/lib/app-logs-schema.js +3 -0
- package/lib/app-logs-schema.js.map +1 -0
- package/lib/app-state-schema.d.ts +22 -0
- package/lib/app-state-schema.d.ts.map +1 -0
- package/lib/app-state-schema.js +3 -0
- package/lib/app-state-schema.js.map +1 -0
- package/lib/constants.d.ts +39 -14
- package/lib/constants.d.ts.map +1 -1
- package/lib/constants.js +10 -10
- package/lib/constants.js.map +1 -1
- package/lib/constants.test.d.ts +2 -0
- package/lib/constants.test.d.ts.map +1 -0
- package/lib/constants.test.js +21 -0
- package/lib/constants.test.js.map +1 -0
- package/lib/device-agent-action-schema.d.ts +15 -0
- package/lib/device-agent-action-schema.d.ts.map +1 -0
- package/lib/device-agent-action-schema.js +3 -0
- package/lib/device-agent-action-schema.js.map +1 -0
- package/lib/device-stats-schema.d.ts +12 -0
- package/lib/device-stats-schema.d.ts.map +1 -0
- package/lib/device-stats-schema.js +4 -0
- package/lib/device-stats-schema.js.map +1 -0
- package/lib/index.d.ts +10 -10
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/schemas/app-install-cloud-response-schema.json +41 -0
- package/lib/schemas/app-install-schema.json +20 -0
- package/lib/schemas/app-logs-schema.json +23 -0
- package/lib/schemas/app-state-control-schema.json +24 -0
- package/lib/schemas/app-state-schema.json +49 -0
- package/lib/schemas/app-uninstall-schema.json +17 -0
- package/lib/schemas/app-version-control-schema.json +20 -0
- package/lib/schemas/client-message-schema.json +117 -0
- package/lib/schemas/common-schema.json +27 -0
- package/lib/schemas/device-agent-message-schema.json +106 -0
- package/lib/schemas/device-stats-schema.json +29 -0
- package/lib/schemas/live-updates-toggle-schema.json +35 -0
- package/lib/schemas/models-install-cloud-response-schema.json +23 -0
- package/lib/schemas/models-install-payload-schema.json +22 -0
- package/lib/schemas/signed-urls-request-schema.json +42 -0
- package/lib/schemas/status-response-schema.json +23 -0
- package/lib/signed-urls-request-schema.d.ts +21 -0
- package/lib/signed-urls-request-schema.d.ts.map +1 -0
- package/lib/signed-urls-request-schema.js +3 -0
- package/lib/signed-urls-request-schema.js.map +1 -0
- package/lib/status-response-schema.d.ts +11 -0
- package/lib/status-response-schema.d.ts.map +1 -0
- package/lib/status-response-schema.js +3 -0
- package/lib/status-response-schema.js.map +1 -0
- package/lib/types.d.ts +20 -20
- package/lib/types.d.ts.map +1 -1
- package/lib/types.js +37 -91
- package/lib/types.js.map +1 -1
- package/lib/types.test.js +130 -41
- package/lib/types.test.js.map +1 -1
- package/lib/utils.d.ts +1 -0
- package/lib/utils.d.ts.map +1 -1
- package/lib/utils.js +6 -1
- package/lib/utils.js.map +1 -1
- package/package.json +6 -3
- package/src/app-action-schema.ts +71 -0
- package/src/app-logs-schema.ts +13 -0
- package/src/app-state-schema.ts +27 -0
- package/src/constants.test.ts +35 -0
- package/src/constants.ts +33 -12
- package/src/device-agent-action-schema.ts +16 -0
- package/src/device-stats-schema.ts +15 -0
- package/src/index.ts +67 -34
- package/src/schemas/app-install-cloud-response-schema.json +41 -0
- package/src/schemas/app-install-schema.json +20 -0
- package/src/schemas/app-logs-schema.json +23 -0
- package/src/schemas/app-state-control-schema.json +24 -0
- package/src/schemas/app-state-schema.json +49 -0
- package/src/schemas/app-uninstall-schema.json +17 -0
- package/src/schemas/app-version-control-schema.json +20 -0
- package/src/schemas/client-message-schema.json +117 -0
- package/src/schemas/common-schema.json +27 -0
- package/src/schemas/device-agent-message-schema.json +107 -0
- package/src/schemas/device-stats-schema.json +29 -0
- package/src/schemas/live-updates-toggle-schema.json +35 -0
- package/src/schemas/models-install-cloud-response-schema.json +23 -0
- package/src/schemas/models-install-payload-schema.json +22 -0
- package/src/schemas/signed-urls-request-schema.json +42 -0
- package/src/schemas/status-response-schema.json +23 -0
- package/src/signed-urls-request-schema.ts +22 -0
- package/src/status-response-schema.ts +12 -0
- package/src/types.test.ts +130 -43
- package/src/types.ts +109 -143
- package/src/utils.ts +6 -0
- package/lib/schemas/agent/app-install-status-schema.d.ts +0 -38
- package/lib/schemas/agent/app-install-status-schema.d.ts.map +0 -1
- package/lib/schemas/agent/app-install-status-schema.js +0 -32
- package/lib/schemas/agent/app-install-status-schema.js.map +0 -1
- package/lib/schemas/agent/application-logs-schema.d.ts +0 -34
- package/lib/schemas/agent/application-logs-schema.d.ts.map +0 -1
- package/lib/schemas/agent/application-logs-schema.js +0 -29
- package/lib/schemas/agent/application-logs-schema.js.map +0 -1
- package/lib/schemas/agent/application-state-schema.d.ts +0 -68
- package/lib/schemas/agent/application-state-schema.d.ts.map +0 -1
- package/lib/schemas/agent/application-state-schema.js +0 -56
- package/lib/schemas/agent/application-state-schema.js.map +0 -1
- package/lib/schemas/agent/device-status-schema.d.ts +0 -41
- package/lib/schemas/agent/device-status-schema.d.ts.map +0 -1
- package/lib/schemas/agent/device-status-schema.js +0 -35
- package/lib/schemas/agent/device-status-schema.js.map +0 -1
- package/lib/schemas/agent/request-data-from-cloud.d.ts +0 -60
- package/lib/schemas/agent/request-data-from-cloud.d.ts.map +0 -1
- package/lib/schemas/agent/request-data-from-cloud.js +0 -48
- package/lib/schemas/agent/request-data-from-cloud.js.map +0 -1
- package/lib/schemas/client/application-action-schema.d.ts +0 -247
- package/lib/schemas/client/application-action-schema.d.ts.map +0 -1
- package/lib/schemas/client/application-action-schema.js +0 -161
- package/lib/schemas/client/application-action-schema.js.map +0 -1
- package/lib/schemas/client/device-agent-action-schema.d.ts +0 -50
- package/lib/schemas/client/device-agent-action-schema.d.ts.map +0 -1
- package/lib/schemas/client/device-agent-action-schema.js +0 -41
- package/lib/schemas/client/device-agent-action-schema.js.map +0 -1
- package/lib/schemas/common-schema.d.ts +0 -22
- package/lib/schemas/common-schema.d.ts.map +0 -1
- package/lib/schemas/common-schema.js +0 -26
- package/lib/schemas/common-schema.js.map +0 -1
- package/src/schemas/agent/app-install-status-schema.ts +0 -39
- package/src/schemas/agent/application-logs-schema.ts +0 -37
- package/src/schemas/agent/application-state-schema.ts +0 -74
- package/src/schemas/agent/device-status-schema.ts +0 -44
- package/src/schemas/agent/request-data-from-cloud.ts +0 -61
- package/src/schemas/client/application-action-schema.ts +0 -225
- package/src/schemas/client/device-agent-action-schema.ts +0 -52
- package/src/schemas/common-schema.ts +0 -23
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in agent\_message Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/agent-message-schema.json#/properties/topic/oneOf/0
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
Messages sent from the agent itself to cloud backend
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## 0 Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## 0 Constraints
|
|
18
|
+
|
|
19
|
+
**pattern**: the string must match the following regular expression: 
|
|
20
|
+
|
|
21
|
+
```regexp
|
|
22
|
+
to-cloud/aai-device/([0-9a-z]+-+)+([0-9a-z])+
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=to-cloud%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in agent\_message Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/agent-message-schema.json#/properties/topic/oneOf/1
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
Messages sent from the agent itself to console client
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## 1 Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## 1 Constraints
|
|
18
|
+
|
|
19
|
+
**pattern**: the string must match the following regular expression: 
|
|
20
|
+
|
|
21
|
+
```regexp
|
|
22
|
+
to-client/aai-device/([0-9a-z]+-+)+([0-9a-z])+
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=to-client%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Untitled undefined type in agent\_message Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/agent-message-schema.json#/properties/topic
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## topic Type
|
|
14
|
+
|
|
15
|
+
merged type ([Details](agent-message-schema-properties-topic.md))
|
|
16
|
+
|
|
17
|
+
one (and only one) of
|
|
18
|
+
|
|
19
|
+
* [Untitled string in agent_message](agent-message-schema-properties-topic-oneof-0.md "check type definition")
|
|
20
|
+
|
|
21
|
+
* [Untitled string in agent_message](agent-message-schema-properties-topic-oneof-1.md "check type definition")
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# agent\_message Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/agent-message-schema.json
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The messaging payload structure for messages sent from device agent to clients
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [agent-message-schema.json](../out/agent-message-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## agent\_message Type
|
|
14
|
+
|
|
15
|
+
`object` ([agent\_message](agent-message-schema.md))
|
|
16
|
+
|
|
17
|
+
# agent\_message Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [timestamp](#timestamp) | `string` | Required | cannot be null | [agent\_message](agent-message-schema-properties-timestamp.md "https://alwaysai.co/agent-message-schema.json#/properties/timestamp") |
|
|
22
|
+
| [deviceId](#deviceid) | `string` | Required | cannot be null | [agent\_message](agent-message-schema-properties-deviceid.md "https://alwaysai.co/agent-message-schema.json#/properties/deviceId") |
|
|
23
|
+
| [topic](#topic) | Merged | Required | cannot be null | [agent\_message](agent-message-schema-properties-topic.md "https://alwaysai.co/agent-message-schema.json#/properties/topic") |
|
|
24
|
+
| [payload](#payload) | Merged | Required | cannot be null | [agent\_message](agent-message-schema-properties-payload.md "https://alwaysai.co/agent-message-schema.json#/properties/payload") |
|
|
25
|
+
|
|
26
|
+
## timestamp
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
`timestamp`
|
|
31
|
+
|
|
32
|
+
* is required
|
|
33
|
+
|
|
34
|
+
* Type: `string`
|
|
35
|
+
|
|
36
|
+
* cannot be null
|
|
37
|
+
|
|
38
|
+
* defined in: [agent\_message](agent-message-schema-properties-timestamp.md "https://alwaysai.co/agent-message-schema.json#/properties/timestamp")
|
|
39
|
+
|
|
40
|
+
### timestamp Type
|
|
41
|
+
|
|
42
|
+
`string`
|
|
43
|
+
|
|
44
|
+
## deviceId
|
|
45
|
+
|
|
46
|
+
Device UUID of device sending the message
|
|
47
|
+
|
|
48
|
+
`deviceId`
|
|
49
|
+
|
|
50
|
+
* is required
|
|
51
|
+
|
|
52
|
+
* Type: `string`
|
|
53
|
+
|
|
54
|
+
* cannot be null
|
|
55
|
+
|
|
56
|
+
* defined in: [agent\_message](agent-message-schema-properties-deviceid.md "https://alwaysai.co/agent-message-schema.json#/properties/deviceId")
|
|
57
|
+
|
|
58
|
+
### deviceId Type
|
|
59
|
+
|
|
60
|
+
`string`
|
|
61
|
+
|
|
62
|
+
## topic
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
`topic`
|
|
67
|
+
|
|
68
|
+
* is required
|
|
69
|
+
|
|
70
|
+
* Type: merged type ([Details](agent-message-schema-properties-topic.md))
|
|
71
|
+
|
|
72
|
+
* cannot be null
|
|
73
|
+
|
|
74
|
+
* defined in: [agent\_message](agent-message-schema-properties-topic.md "https://alwaysai.co/agent-message-schema.json#/properties/topic")
|
|
75
|
+
|
|
76
|
+
### topic Type
|
|
77
|
+
|
|
78
|
+
merged type ([Details](agent-message-schema-properties-topic.md))
|
|
79
|
+
|
|
80
|
+
one (and only one) of
|
|
81
|
+
|
|
82
|
+
* [Untitled string in agent_message](agent-message-schema-properties-topic-oneof-0.md "check type definition")
|
|
83
|
+
|
|
84
|
+
* [Untitled string in agent_message](agent-message-schema-properties-topic-oneof-1.md "check type definition")
|
|
85
|
+
|
|
86
|
+
## payload
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
`payload`
|
|
91
|
+
|
|
92
|
+
* is required
|
|
93
|
+
|
|
94
|
+
* Type: merged type ([Details](agent-message-schema-properties-payload.md))
|
|
95
|
+
|
|
96
|
+
* cannot be null
|
|
97
|
+
|
|
98
|
+
* defined in: [agent\_message](agent-message-schema-properties-payload.md "https://alwaysai.co/agent-message-schema.json#/properties/payload")
|
|
99
|
+
|
|
100
|
+
### payload Type
|
|
101
|
+
|
|
102
|
+
merged type ([Details](agent-message-schema-properties-payload.md))
|
|
103
|
+
|
|
104
|
+
one (and only one) of
|
|
105
|
+
|
|
106
|
+
* [device_stats](agent-message-schema-properties-payload-oneof-device_stats.md "check type definition")
|
|
107
|
+
|
|
108
|
+
* [app_state](agent-message-schema-properties-payload-oneof-app_state.md "check type definition")
|
|
109
|
+
|
|
110
|
+
* [app_logs](agent-message-schema-properties-payload-oneof-app_logs.md "check type definition")
|
|
111
|
+
|
|
112
|
+
* [app_install_status](agent-message-schema-properties-payload-oneof-app_install_status.md "check type definition")
|
|
113
|
+
|
|
114
|
+
* [signed_urls_request](agent-message-schema-properties-payload-oneof-signed_urls_request.md "check type definition")
|
|
115
|
+
|
|
116
|
+
# agent\_message Definitions
|
|
117
|
+
|
|
118
|
+
## Definitions group toCloud
|
|
119
|
+
|
|
120
|
+
Reference this group by using
|
|
121
|
+
|
|
122
|
+
```json
|
|
123
|
+
{"$ref":"https://alwaysai.co/agent-message-schema.json#/$defs/toCloud"}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
127
|
+
| :------- | :--- | :------- | :------- | :--------- |
|
|
128
|
+
|
|
129
|
+
## Definitions group toClient
|
|
130
|
+
|
|
131
|
+
Reference this group by using
|
|
132
|
+
|
|
133
|
+
```json
|
|
134
|
+
{"$ref":"https://alwaysai.co/agent-message-schema.json#/$defs/toClient"}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
138
|
+
| :------- | :--- | :------- | :------- | :--------- |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload/properties/appSignedUrl
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appSignedUrl Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Untitled object in app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appInstallPayload Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md))
|
|
16
|
+
|
|
17
|
+
# appInstallPayload Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
+
| [appSignedUrl](#appsignedurl) | `string` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload-properties-appsignedurl.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload/properties/appSignedUrl") |
|
|
22
|
+
|
|
23
|
+
## appSignedUrl
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
`appSignedUrl`
|
|
28
|
+
|
|
29
|
+
* is required
|
|
30
|
+
|
|
31
|
+
* Type: `string`
|
|
32
|
+
|
|
33
|
+
* cannot be null
|
|
34
|
+
|
|
35
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload-properties-appsignedurl.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload/properties/appSignedUrl")
|
|
36
|
+
|
|
37
|
+
### appSignedUrl Type
|
|
38
|
+
|
|
39
|
+
`string`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appReleaseHash
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The version of the project associated with the message payload.
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appReleaseHash Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## appReleaseHash Constraints
|
|
18
|
+
|
|
19
|
+
**pattern**: the string must match the following regular expression: 
|
|
20
|
+
|
|
21
|
+
```regexp
|
|
22
|
+
[0-9a-z]{64}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# models\_install\_payload Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/models-install-payload-schema.json#/properties/appInstallCloudResponse/properties/modelsInstallPayload
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## modelsInstallPayload Type
|
|
14
|
+
|
|
15
|
+
`object[]` ([Details](models-install-payload-schema-items.md))
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/projectId
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The specific project associated with the message payload.
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## projectId Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## projectId Constraints
|
|
18
|
+
|
|
19
|
+
**pattern**: the string must match the following regular expression: 
|
|
20
|
+
|
|
21
|
+
```regexp
|
|
22
|
+
([0-9a-z]+-+)+([0-9a-z])+
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Untitled object in app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appInstallCloudResponse Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-install-cloud-response-schema-properties-appinstallcloudresponse.md))
|
|
16
|
+
|
|
17
|
+
# appInstallCloudResponse Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-projectid.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/projectId") |
|
|
22
|
+
| [appReleaseHash](#appreleasehash) | `string` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appreleasehash.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appReleaseHash") |
|
|
23
|
+
| [appInstallPayload](#appinstallpayload) | `object` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload") |
|
|
24
|
+
| [modelsInstallPayload](#modelsinstallpayload) | `array` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-models_install_payload.md "https://alwaysai.co/models-install-payload-schema.json#/properties/appInstallCloudResponse/properties/modelsInstallPayload") |
|
|
25
|
+
|
|
26
|
+
## projectId
|
|
27
|
+
|
|
28
|
+
The specific project associated with the message payload.
|
|
29
|
+
|
|
30
|
+
`projectId`
|
|
31
|
+
|
|
32
|
+
* is required
|
|
33
|
+
|
|
34
|
+
* Type: `string`
|
|
35
|
+
|
|
36
|
+
* cannot be null
|
|
37
|
+
|
|
38
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-projectid.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/projectId")
|
|
39
|
+
|
|
40
|
+
### projectId Type
|
|
41
|
+
|
|
42
|
+
`string`
|
|
43
|
+
|
|
44
|
+
### projectId Constraints
|
|
45
|
+
|
|
46
|
+
**pattern**: the string must match the following regular expression: 
|
|
47
|
+
|
|
48
|
+
```regexp
|
|
49
|
+
([0-9a-z]+-+)+([0-9a-z])+
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|
|
53
|
+
|
|
54
|
+
## appReleaseHash
|
|
55
|
+
|
|
56
|
+
The version of the project associated with the message payload.
|
|
57
|
+
|
|
58
|
+
`appReleaseHash`
|
|
59
|
+
|
|
60
|
+
* is required
|
|
61
|
+
|
|
62
|
+
* Type: `string`
|
|
63
|
+
|
|
64
|
+
* cannot be null
|
|
65
|
+
|
|
66
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appreleasehash.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appReleaseHash")
|
|
67
|
+
|
|
68
|
+
### appReleaseHash Type
|
|
69
|
+
|
|
70
|
+
`string`
|
|
71
|
+
|
|
72
|
+
### appReleaseHash Constraints
|
|
73
|
+
|
|
74
|
+
**pattern**: the string must match the following regular expression: 
|
|
75
|
+
|
|
76
|
+
```regexp
|
|
77
|
+
[0-9a-z]{64}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")
|
|
81
|
+
|
|
82
|
+
## appInstallPayload
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
`appInstallPayload`
|
|
87
|
+
|
|
88
|
+
* is required
|
|
89
|
+
|
|
90
|
+
* Type: `object` ([Details](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md))
|
|
91
|
+
|
|
92
|
+
* cannot be null
|
|
93
|
+
|
|
94
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload")
|
|
95
|
+
|
|
96
|
+
### appInstallPayload Type
|
|
97
|
+
|
|
98
|
+
`object` ([Details](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md))
|
|
99
|
+
|
|
100
|
+
## modelsInstallPayload
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
`modelsInstallPayload`
|
|
105
|
+
|
|
106
|
+
* is required
|
|
107
|
+
|
|
108
|
+
* Type: `object[]` ([Details](models-install-payload-schema-items.md))
|
|
109
|
+
|
|
110
|
+
* cannot be null
|
|
111
|
+
|
|
112
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-models_install_payload.md "https://alwaysai.co/models-install-payload-schema.json#/properties/appInstallCloudResponse/properties/modelsInstallPayload")
|
|
113
|
+
|
|
114
|
+
### modelsInstallPayload Type
|
|
115
|
+
|
|
116
|
+
`object[]` ([Details](models-install-payload-schema-items.md))
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Untitled string in app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json#/properties/messageType
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-cloud-response-schema.json\*](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## messageType Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## messageType Constraints
|
|
18
|
+
|
|
19
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
20
|
+
|
|
21
|
+
| Value | Explanation |
|
|
22
|
+
| :----------------------------- | :---------- |
|
|
23
|
+
| `"app_install_cloud_response"` | |
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# app\_install\_cloud\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-cloud-response-schema.json
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [app-install-cloud-response-schema.json](../out/app-install-cloud-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## app\_install\_cloud\_response Type
|
|
14
|
+
|
|
15
|
+
`object` ([app\_install\_cloud\_response](app-install-cloud-response-schema.md))
|
|
16
|
+
|
|
17
|
+
# app\_install\_cloud\_response Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [messageType](#messagetype) | `string` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-messagetype.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/messageType") |
|
|
22
|
+
| [appInstallCloudResponse](#appinstallcloudresponse) | `object` | Required | cannot be null | [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse") |
|
|
23
|
+
|
|
24
|
+
## messageType
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`messageType`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: `string`
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-messagetype.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/messageType")
|
|
37
|
+
|
|
38
|
+
### messageType Type
|
|
39
|
+
|
|
40
|
+
`string`
|
|
41
|
+
|
|
42
|
+
### messageType Constraints
|
|
43
|
+
|
|
44
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
45
|
+
|
|
46
|
+
| Value | Explanation |
|
|
47
|
+
| :----------------------------- | :---------- |
|
|
48
|
+
| `"app_install_cloud_response"` | |
|
|
49
|
+
|
|
50
|
+
## appInstallCloudResponse
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
`appInstallCloudResponse`
|
|
55
|
+
|
|
56
|
+
* is required
|
|
57
|
+
|
|
58
|
+
* Type: `object` ([Details](app-install-cloud-response-schema-properties-appinstallcloudresponse.md))
|
|
59
|
+
|
|
60
|
+
* cannot be null
|
|
61
|
+
|
|
62
|
+
* defined in: [app\_install\_cloud\_response](app-install-cloud-response-schema-properties-appinstallcloudresponse.md "https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse")
|
|
63
|
+
|
|
64
|
+
### appInstallCloudResponse Type
|
|
65
|
+
|
|
66
|
+
`object` ([Details](app-install-cloud-response-schema-properties-appinstallcloudresponse.md))
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_install Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-schema.json#/properties/appReleaseHash
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The version of the project associated with the message payload.
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-schema.json\*](../out/app-install-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appReleaseHash Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## appReleaseHash Constraints
|
|
18
|
+
|
|
19
|
+
**pattern**: the string must match the following regular expression: 
|
|
20
|
+
|
|
21
|
+
```regexp
|
|
22
|
+
[0-9a-z]{64}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Untitled string in app\_install Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-schema.json#/properties/baseCommand
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-schema.json\*](../out/app-install-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## baseCommand Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## baseCommand Constraints
|
|
18
|
+
|
|
19
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
20
|
+
|
|
21
|
+
| Value | Explanation |
|
|
22
|
+
| :---------- | :---------- |
|
|
23
|
+
| `"install"` | |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_install Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-schema.json#/properties/projectId
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The specific project associated with the message payload.
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [app-install-schema.json\*](../out/app-install-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## projectId Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## projectId Constraints
|
|
18
|
+
|
|
19
|
+
**pattern**: the string must match the following regular expression: 
|
|
20
|
+
|
|
21
|
+
```regexp
|
|
22
|
+
([0-9a-z]+-+)+([0-9a-z])+
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|