@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,78 @@
|
|
|
1
|
+
# Untitled object in app\_state\_control Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl
|
|
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-state-control-schema.json\*](../out/app-state-control-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appStateControl Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-state-control-schema-properties-appstatecontrol.md))
|
|
16
|
+
|
|
17
|
+
# appStateControl Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [baseCommand](#basecommand) | `string` | Required | cannot be null | [app\_state\_control](app-state-control-schema-properties-appstatecontrol-properties-basecommand.md "https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl/properties/baseCommand") |
|
|
22
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [app\_state\_control](app-state-control-schema-properties-appstatecontrol-properties-projectid.md "https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl/properties/projectId") |
|
|
23
|
+
|
|
24
|
+
## baseCommand
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`baseCommand`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: `string`
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_state\_control](app-state-control-schema-properties-appstatecontrol-properties-basecommand.md "https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl/properties/baseCommand")
|
|
37
|
+
|
|
38
|
+
### baseCommand Type
|
|
39
|
+
|
|
40
|
+
`string`
|
|
41
|
+
|
|
42
|
+
### baseCommand Constraints
|
|
43
|
+
|
|
44
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
45
|
+
|
|
46
|
+
| Value | Explanation |
|
|
47
|
+
| :---------- | :---------- |
|
|
48
|
+
| `"start"` | |
|
|
49
|
+
| `"stop"` | |
|
|
50
|
+
| `"restart"` | |
|
|
51
|
+
|
|
52
|
+
## projectId
|
|
53
|
+
|
|
54
|
+
The specific project associated with the message payload.
|
|
55
|
+
|
|
56
|
+
`projectId`
|
|
57
|
+
|
|
58
|
+
* is required
|
|
59
|
+
|
|
60
|
+
* Type: `string`
|
|
61
|
+
|
|
62
|
+
* cannot be null
|
|
63
|
+
|
|
64
|
+
* defined in: [app\_state\_control](app-state-control-schema-properties-appstatecontrol-properties-projectid.md "https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl/properties/projectId")
|
|
65
|
+
|
|
66
|
+
### projectId Type
|
|
67
|
+
|
|
68
|
+
`string`
|
|
69
|
+
|
|
70
|
+
### projectId Constraints
|
|
71
|
+
|
|
72
|
+
**pattern**: the string must match the following regular expression: 
|
|
73
|
+
|
|
74
|
+
```regexp
|
|
75
|
+
([0-9a-z]+-+)+([0-9a-z])+
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
[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,23 @@
|
|
|
1
|
+
# Untitled undefined type in app\_state\_control Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-control-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-state-control-schema.json\*](../out/app-state-control-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## messageType Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
16
|
+
|
|
17
|
+
## messageType Constraints
|
|
18
|
+
|
|
19
|
+
**constant**: the value of this property must be equal to:
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
"app_state_control"
|
|
23
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# app\_state\_control Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-control-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-state-control-schema.json](../out/app-state-control-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## app\_state\_control Type
|
|
14
|
+
|
|
15
|
+
`object` ([app\_state\_control](app-state-control-schema.md))
|
|
16
|
+
|
|
17
|
+
# app\_state\_control Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
+
| [messageType](#messagetype) | Not specified | Required | cannot be null | [app\_state\_control](app-state-control-schema-properties-messagetype.md "https://alwaysai.co/app-state-control-schema.json#/properties/messageType") |
|
|
22
|
+
| [appStateControl](#appstatecontrol) | `object` | Required | cannot be null | [app\_state\_control](app-state-control-schema-properties-appstatecontrol.md "https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl") |
|
|
23
|
+
|
|
24
|
+
## messageType
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`messageType`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: unknown
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_state\_control](app-state-control-schema-properties-messagetype.md "https://alwaysai.co/app-state-control-schema.json#/properties/messageType")
|
|
37
|
+
|
|
38
|
+
### messageType Type
|
|
39
|
+
|
|
40
|
+
unknown
|
|
41
|
+
|
|
42
|
+
### messageType Constraints
|
|
43
|
+
|
|
44
|
+
**constant**: the value of this property must be equal to:
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
"app_state_control"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## appStateControl
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
`appStateControl`
|
|
55
|
+
|
|
56
|
+
* is required
|
|
57
|
+
|
|
58
|
+
* Type: `object` ([Details](app-state-control-schema-properties-appstatecontrol.md))
|
|
59
|
+
|
|
60
|
+
* cannot be null
|
|
61
|
+
|
|
62
|
+
* defined in: [app\_state\_control](app-state-control-schema-properties-appstatecontrol.md "https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl")
|
|
63
|
+
|
|
64
|
+
### appStateControl Type
|
|
65
|
+
|
|
66
|
+
`object` ([Details](app-state-control-schema-properties-appstatecontrol.md))
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails/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-state-schema.json\*](../out/app-state-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")
|
package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-version.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails/properties/version
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## version Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## version 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,78 @@
|
|
|
1
|
+
# Untitled object in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appDetails Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-state-schema-properties-appstate-items-properties-appdetails.md))
|
|
16
|
+
|
|
17
|
+
# appDetails Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [app\_state](app-state-schema-properties-appstate-items-properties-appdetails-properties-projectid.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails/properties/projectId") |
|
|
22
|
+
| [version](#version) | `string` | Required | cannot be null | [app\_state](app-state-schema-properties-appstate-items-properties-appdetails-properties-version.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails/properties/version") |
|
|
23
|
+
|
|
24
|
+
## projectId
|
|
25
|
+
|
|
26
|
+
The specific project associated with the message payload.
|
|
27
|
+
|
|
28
|
+
`projectId`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: `string`
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_state](app-state-schema-properties-appstate-items-properties-appdetails-properties-projectid.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails/properties/projectId")
|
|
37
|
+
|
|
38
|
+
### projectId Type
|
|
39
|
+
|
|
40
|
+
`string`
|
|
41
|
+
|
|
42
|
+
### projectId Constraints
|
|
43
|
+
|
|
44
|
+
**pattern**: the string must match the following regular expression: 
|
|
45
|
+
|
|
46
|
+
```regexp
|
|
47
|
+
([0-9a-z]+-+)+([0-9a-z])+
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|
|
51
|
+
|
|
52
|
+
## version
|
|
53
|
+
|
|
54
|
+
The version of the project associated with the message payload.
|
|
55
|
+
|
|
56
|
+
`version`
|
|
57
|
+
|
|
58
|
+
* is required
|
|
59
|
+
|
|
60
|
+
* Type: `string`
|
|
61
|
+
|
|
62
|
+
* cannot be null
|
|
63
|
+
|
|
64
|
+
* defined in: [app\_state](app-state-schema-properties-appstate-items-properties-appdetails-properties-version.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails/properties/version")
|
|
65
|
+
|
|
66
|
+
### version Type
|
|
67
|
+
|
|
68
|
+
`string`
|
|
69
|
+
|
|
70
|
+
### version Constraints
|
|
71
|
+
|
|
72
|
+
**pattern**: the string must match the following regular expression: 
|
|
73
|
+
|
|
74
|
+
```regexp
|
|
75
|
+
[0-9a-z]{64}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")
|
package/docs/app-state-schema-properties-appstate-items-properties-services-items-properties-name.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items/properties/name
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## name Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled undefined type in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items/properties/state
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## state Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
16
|
+
|
|
17
|
+
## state Constraints
|
|
18
|
+
|
|
19
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
20
|
+
|
|
21
|
+
| Value | Explanation |
|
|
22
|
+
| :------------- | :---------- |
|
|
23
|
+
| `"up"` | |
|
|
24
|
+
| `"stopped"` | |
|
|
25
|
+
| `"restarting"` | |
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Untitled object in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## items Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-state-schema-properties-appstate-items-properties-services-items.md))
|
|
16
|
+
|
|
17
|
+
# items Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [name](#name) | `string` | Required | cannot be null | [app\_state](app-state-schema-properties-appstate-items-properties-services-items-properties-name.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items/properties/name") |
|
|
22
|
+
| [state](#state) | Not specified | Required | cannot be null | [app\_state](app-state-schema-properties-appstate-items-properties-services-items-properties-state.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items/properties/state") |
|
|
23
|
+
|
|
24
|
+
## name
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`name`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: `string`
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_state](app-state-schema-properties-appstate-items-properties-services-items-properties-name.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items/properties/name")
|
|
37
|
+
|
|
38
|
+
### name Type
|
|
39
|
+
|
|
40
|
+
`string`
|
|
41
|
+
|
|
42
|
+
## state
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
`state`
|
|
47
|
+
|
|
48
|
+
* is required
|
|
49
|
+
|
|
50
|
+
* Type: unknown
|
|
51
|
+
|
|
52
|
+
* cannot be null
|
|
53
|
+
|
|
54
|
+
* defined in: [app\_state](app-state-schema-properties-appstate-items-properties-services-items-properties-state.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items/properties/state")
|
|
55
|
+
|
|
56
|
+
### state Type
|
|
57
|
+
|
|
58
|
+
unknown
|
|
59
|
+
|
|
60
|
+
### state Constraints
|
|
61
|
+
|
|
62
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
63
|
+
|
|
64
|
+
| Value | Explanation |
|
|
65
|
+
| :------------- | :---------- |
|
|
66
|
+
| `"up"` | |
|
|
67
|
+
| `"stopped"` | |
|
|
68
|
+
| `"restarting"` | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled array in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## services Type
|
|
14
|
+
|
|
15
|
+
`object[]` ([Details](app-state-schema-properties-appstate-items-properties-services-items.md))
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Untitled object in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState/items
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## items Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-state-schema-properties-appstate-items.md))
|
|
16
|
+
|
|
17
|
+
# items Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :------------------------ | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [appDetails](#appdetails) | `object` | Required | cannot be null | [app\_state](app-state-schema-properties-appstate-items-properties-appdetails.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails") |
|
|
22
|
+
| [services](#services) | `array` | Required | cannot be null | [app\_state](app-state-schema-properties-appstate-items-properties-services.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services") |
|
|
23
|
+
|
|
24
|
+
## appDetails
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`appDetails`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: `object` ([Details](app-state-schema-properties-appstate-items-properties-appdetails.md))
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_state](app-state-schema-properties-appstate-items-properties-appdetails.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails")
|
|
37
|
+
|
|
38
|
+
### appDetails Type
|
|
39
|
+
|
|
40
|
+
`object` ([Details](app-state-schema-properties-appstate-items-properties-appdetails.md))
|
|
41
|
+
|
|
42
|
+
## services
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
`services`
|
|
47
|
+
|
|
48
|
+
* is required
|
|
49
|
+
|
|
50
|
+
* Type: `object[]` ([Details](app-state-schema-properties-appstate-items-properties-services-items.md))
|
|
51
|
+
|
|
52
|
+
* cannot be null
|
|
53
|
+
|
|
54
|
+
* defined in: [app\_state](app-state-schema-properties-appstate-items-properties-services.md "https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services")
|
|
55
|
+
|
|
56
|
+
### services Type
|
|
57
|
+
|
|
58
|
+
`object[]` ([Details](app-state-schema-properties-appstate-items-properties-services-items.md))
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled array in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-schema.json#/properties/appState
|
|
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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appState Type
|
|
14
|
+
|
|
15
|
+
`object[]` ([Details](app-state-schema-properties-appstate-items.md))
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Untitled undefined type in app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-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-state-schema.json\*](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## messageType Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
16
|
+
|
|
17
|
+
## messageType Constraints
|
|
18
|
+
|
|
19
|
+
**constant**: the value of this property must be equal to:
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
"app_state"
|
|
23
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# app\_state Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-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-state-schema.json](../out/app-state-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## app\_state Type
|
|
14
|
+
|
|
15
|
+
`object` ([app\_state](app-state-schema.md))
|
|
16
|
+
|
|
17
|
+
# app\_state Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------------- | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [messageType](#messagetype) | Not specified | Required | cannot be null | [app\_state](app-state-schema-properties-messagetype.md "https://alwaysai.co/app-state-schema.json#/properties/messageType") |
|
|
22
|
+
| [appState](#appstate) | `array` | Required | cannot be null | [app\_state](app-state-schema-properties-appstate.md "https://alwaysai.co/app-state-schema.json#/properties/appState") |
|
|
23
|
+
|
|
24
|
+
## messageType
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`messageType`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: unknown
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [app\_state](app-state-schema-properties-messagetype.md "https://alwaysai.co/app-state-schema.json#/properties/messageType")
|
|
37
|
+
|
|
38
|
+
### messageType Type
|
|
39
|
+
|
|
40
|
+
unknown
|
|
41
|
+
|
|
42
|
+
### messageType Constraints
|
|
43
|
+
|
|
44
|
+
**constant**: the value of this property must be equal to:
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
"app_state"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## appState
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
`appState`
|
|
55
|
+
|
|
56
|
+
* is required
|
|
57
|
+
|
|
58
|
+
* Type: `object[]` ([Details](app-state-schema-properties-appstate-items.md))
|
|
59
|
+
|
|
60
|
+
* cannot be null
|
|
61
|
+
|
|
62
|
+
* defined in: [app\_state](app-state-schema-properties-appstate.md "https://alwaysai.co/app-state-schema.json#/properties/appState")
|
|
63
|
+
|
|
64
|
+
### appState Type
|
|
65
|
+
|
|
66
|
+
`object[]` ([Details](app-state-schema-properties-appstate-items.md))
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Untitled string in app\_uninstall Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-uninstall-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-uninstall-schema.json\*](../out/app-uninstall-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
|
+
| `"uninstall"` | |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_uninstall Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-uninstall-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-uninstall-schema.json\*](../out/app-uninstall-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")
|