@alwaysai/device-agent-schemas 2.1.13 → 2.2.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/.eslintrc +1 -21
- package/docs/README.md +47 -21
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload-properties-appsignedurl.md +15 -0
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md +39 -0
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-appreleasehash.md +25 -0
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-models_install_payload.md +15 -0
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-projectid.md +25 -0
- package/docs/app-install-response-schema-properties-appinstallresponse.md +116 -0
- package/docs/app-install-response-schema.md +39 -0
- package/docs/app-install-schema-properties-projectid.md +2 -2
- package/docs/app-install-schema.md +2 -2
- package/docs/app-logs-schema-properties-logchunk.md +15 -0
- package/docs/app-logs-schema-properties-projectid.md +25 -0
- package/docs/app-logs-schema.md +23 -21
- package/docs/app-state-control-schema-properties-basecommand.md +25 -0
- package/docs/app-state-control-schema-properties-projectid.md +25 -0
- package/docs/app-state-control-schema.md +34 -22
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-projectid.md +2 -2
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails.md +2 -2
- package/docs/app-state-schema.md +3 -30
- package/docs/app-uninstall-schema-properties-projectid.md +2 -2
- package/docs/app-uninstall-schema.md +2 -2
- package/docs/app-version-control-schema.md +5 -56
- package/docs/common-schema-defs-appreleasehash.md +5 -5
- package/docs/common-schema-defs-projectid.md +7 -7
- package/docs/common-schema-defs-txid.md +29 -0
- package/docs/common-schema.md +11 -0
- package/docs/device-action-schema-properties-action.md +23 -0
- package/docs/device-action-schema.md +47 -0
- package/docs/device-stats-schema-properties-cpudetails-properties-temperature.md +15 -0
- package/docs/device-stats-schema-properties-cpudetails-properties-usedperc.md +15 -0
- package/docs/device-stats-schema-properties-cpudetails.md +58 -0
- package/docs/device-stats-schema-properties-cpuusage.md +15 -0
- package/docs/device-stats-schema-properties-diskdetails-properties-freegb.md +15 -0
- package/docs/device-stats-schema-properties-diskdetails-properties-usedgb.md +15 -0
- package/docs/device-stats-schema-properties-diskdetails.md +58 -0
- package/docs/device-stats-schema-properties-diskutil.md +15 -0
- package/docs/device-stats-schema-properties-memdetails-properties-freemb.md +15 -0
- package/docs/device-stats-schema-properties-memdetails-properties-usedmb.md +15 -0
- package/docs/device-stats-schema-properties-memdetails.md +58 -0
- package/docs/device-stats-schema-properties-usedmemorypercentage.md +15 -0
- package/docs/device-stats-schema.md +134 -0
- package/docs/live-updates-toggle-schema-properties-applogs-properties-toggle.md +15 -0
- package/docs/live-updates-toggle-schema-properties-applogs.md +68 -0
- package/docs/live-updates-toggle-schema-properties-appstate.md +15 -0
- package/docs/live-updates-toggle-schema-properties-devicestats.md +15 -0
- package/docs/live-updates-toggle-schema.md +34 -23
- package/docs/models-install-response-schema-properties-modelsinstallresponse.md +68 -0
- package/docs/models-install-response-schema.md +39 -0
- package/docs/shadow-project-update-schema-properties-appconfig.md +15 -0
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties-.md +15 -0
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties.md +15 -0
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties-.md +39 -0
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties.md +15 -0
- package/docs/shadow-project-update-schema-properties-envvars.md +44 -0
- package/docs/shadow-project-update-schema.md +63 -0
- package/docs/shadow-projects-update-all-schema-patternproperties.md +15 -0
- package/docs/shadow-projects-update-all-schema-propertynames.md +25 -0
- package/docs/shadow-projects-update-all-schema.md +44 -0
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest.md +7 -7
- package/docs/signed-urls-request-schema-properties-signedurlsrequest.md +8 -8
- package/docs/signed-urls-request-schema.md +4 -31
- package/docs/status-response-schema-properties-message.md +15 -0
- package/docs/status-response-schema-properties-status.md +27 -0
- package/docs/status-response-schema.md +70 -0
- package/docs/system-information-schema-properties-cpu-properties-brand.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-cores.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-efficiencycores.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-manufacturer.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-model.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-physicalcores.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-processors.md +15 -0
- package/docs/system-information-schema-properties-cpu-properties-vendor.md +15 -0
- package/docs/system-information-schema-properties-cpu.md +172 -0
- package/docs/system-information-schema-properties-device-properties-manufacturer.md +15 -0
- package/docs/system-information-schema-properties-device-properties-model.md +15 -0
- package/docs/system-information-schema-properties-device-properties-serial.md +15 -0
- package/docs/system-information-schema-properties-device-properties-version.md +15 -0
- package/docs/system-information-schema-properties-device-properties-virtual.md +15 -0
- package/docs/system-information-schema-properties-device.md +115 -0
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-device.md +15 -0
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-name.md +15 -0
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-size.md +15 -0
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-type.md +15 -0
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-vendor.md +15 -0
- package/docs/system-information-schema-properties-disk-properties-drives-items.md +115 -0
- package/docs/system-information-schema-properties-disk-properties-drives.md +15 -0
- package/docs/system-information-schema-properties-disk.md +39 -0
- package/docs/system-information-schema-properties-network-properties-ipv4address.md +15 -0
- package/docs/system-information-schema-properties-network-properties-ipv6address.md +15 -0
- package/docs/system-information-schema-properties-network-properties-macaddress.md +15 -0
- package/docs/system-information-schema-properties-network.md +77 -0
- package/docs/system-information-schema-properties-os-properties-architecture.md +15 -0
- package/docs/system-information-schema-properties-os-properties-distro.md +15 -0
- package/docs/system-information-schema-properties-os-properties-hostname.md +15 -0
- package/docs/system-information-schema-properties-os-properties-kernel.md +15 -0
- package/docs/system-information-schema-properties-os-properties-platform.md +15 -0
- package/docs/system-information-schema-properties-os-properties-release.md +15 -0
- package/docs/system-information-schema-properties-os.md +134 -0
- package/docs/system-information-schema-properties-versions-properties-agent.md +15 -0
- package/docs/system-information-schema-properties-versions-properties-deviceagentschemas.md +15 -0
- package/docs/system-information-schema-properties-versions.md +58 -0
- package/docs/system-information-schema.md +134 -0
- package/docs/to-client-message-schema-allof-0-if-properties-messagetype.md +23 -0
- package/docs/to-client-message-schema-allof-0-if-properties.md +15 -0
- package/docs/to-client-message-schema-allof-0-if.md +47 -0
- package/docs/to-client-message-schema-allof-0-then-properties.md +15 -0
- package/docs/to-client-message-schema-allof-0-then.md +39 -0
- package/docs/to-client-message-schema-allof-0.md +15 -0
- package/docs/to-client-message-schema-allof-1-if-properties-messagetype.md +23 -0
- package/docs/to-client-message-schema-allof-1-if-properties.md +15 -0
- package/docs/to-client-message-schema-allof-1-if.md +47 -0
- package/docs/to-client-message-schema-allof-1-then-properties.md +15 -0
- package/docs/to-client-message-schema-allof-1-then.md +39 -0
- package/docs/to-client-message-schema-allof-1.md +15 -0
- package/docs/to-client-message-schema-allof-2-if-properties-messagetype.md +23 -0
- package/docs/to-client-message-schema-allof-2-if-properties.md +15 -0
- package/docs/to-client-message-schema-allof-2-if.md +47 -0
- package/docs/to-client-message-schema-allof-2-then-properties.md +15 -0
- package/docs/to-client-message-schema-allof-2-then.md +39 -0
- package/docs/to-client-message-schema-allof-2.md +15 -0
- package/docs/to-client-message-schema-allof-3-if-properties-messagetype.md +23 -0
- package/docs/to-client-message-schema-allof-3-if-properties.md +15 -0
- package/docs/to-client-message-schema-allof-3-if.md +47 -0
- package/docs/to-client-message-schema-allof-3-then-properties.md +15 -0
- package/docs/to-client-message-schema-allof-3-then.md +39 -0
- package/docs/to-client-message-schema-allof-3.md +15 -0
- package/docs/to-client-message-schema-defs-toclient.md +25 -0
- package/docs/to-client-message-schema-defs.md +15 -0
- package/docs/to-client-message-schema-properties-deviceid.md +15 -0
- package/docs/to-client-message-schema-properties-messagetype.md +26 -0
- package/docs/to-client-message-schema-properties-payload.md +25 -0
- package/docs/to-client-message-schema-properties-timestamp.md +15 -0
- package/docs/to-client-message-schema-properties-topic-oneof-0.md +25 -0
- package/docs/to-client-message-schema-properties-topic.md +19 -0
- package/docs/to-client-message-schema.md +196 -0
- package/docs/to-cloud-message-schema-allof-0-if-properties-messagetype.md +23 -0
- package/docs/to-cloud-message-schema-allof-0-if-properties.md +15 -0
- package/docs/to-cloud-message-schema-allof-0-if.md +47 -0
- package/docs/to-cloud-message-schema-allof-0-then-properties.md +15 -0
- package/docs/to-cloud-message-schema-allof-0-then.md +39 -0
- package/docs/to-cloud-message-schema-allof-0.md +15 -0
- package/docs/to-cloud-message-schema-defs-tocloud.md +25 -0
- package/docs/to-cloud-message-schema-defs.md +15 -0
- package/docs/to-cloud-message-schema-properties-deviceid.md +15 -0
- package/docs/to-cloud-message-schema-properties-messagetype.md +23 -0
- package/docs/to-cloud-message-schema-properties-payload.md +19 -0
- package/docs/to-cloud-message-schema-properties-timestamp.md +15 -0
- package/docs/to-cloud-message-schema-properties-topic-oneof-0.md +25 -0
- package/docs/to-cloud-message-schema-properties-topic.md +19 -0
- package/docs/to-cloud-message-schema.md +181 -0
- package/docs/to-device-agent-message-schema-allof-0-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-0-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-0-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-0-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-0-then.md +39 -0
- package/docs/to-device-agent-message-schema-allof-0.md +15 -0
- package/docs/to-device-agent-message-schema-allof-1-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-1-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-1-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-1-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-1-then.md +45 -0
- package/docs/to-device-agent-message-schema-allof-1.md +15 -0
- package/docs/to-device-agent-message-schema-allof-2-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-2-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-2-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-2-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-2-then.md +39 -0
- package/docs/to-device-agent-message-schema-allof-2.md +15 -0
- package/docs/to-device-agent-message-schema-allof-3-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-3-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-3-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-3-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-3-then.md +39 -0
- package/docs/to-device-agent-message-schema-allof-3.md +15 -0
- package/docs/to-device-agent-message-schema-allof-4-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-4-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-4-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-4-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-4-then.md +39 -0
- package/docs/to-device-agent-message-schema-allof-4.md +15 -0
- package/docs/to-device-agent-message-schema-allof-5-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-5-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-5-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-5-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-5-then.md +39 -0
- package/docs/to-device-agent-message-schema-allof-5.md +15 -0
- package/docs/to-device-agent-message-schema-allof-6-if-properties-messagetype.md +23 -0
- package/docs/to-device-agent-message-schema-allof-6-if-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-6-if.md +47 -0
- package/docs/to-device-agent-message-schema-allof-6-then-properties.md +15 -0
- package/docs/to-device-agent-message-schema-allof-6-then.md +39 -0
- package/docs/to-device-agent-message-schema-allof-6.md +15 -0
- package/docs/to-device-agent-message-schema-defs-todevice.md +25 -0
- package/docs/to-device-agent-message-schema-defs.md +15 -0
- package/docs/to-device-agent-message-schema-properties-messagetype.md +29 -0
- package/docs/to-device-agent-message-schema-properties-payload.md +35 -0
- package/docs/to-device-agent-message-schema-properties-timestamp.md +15 -0
- package/docs/to-device-agent-message-schema-properties-topic.md +25 -0
- package/docs/to-device-agent-message-schema.md +202 -0
- 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.js.map +1 -1
- package/lib/device-agent-action-schema.d.ts.map +1 -1
- package/lib/index.d.ts +2 -2
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +11 -1
- package/lib/index.js.map +1 -1
- package/lib/message-builders.d.ts +1 -1
- package/lib/message-builders.d.ts.map +1 -1
- package/lib/message-builders.js +3 -3
- package/lib/message-builders.js.map +1 -1
- package/lib/schemas/shadow-project-update-schema.json +30 -0
- package/lib/schemas/shadow-projects-update-all-schema.json +17 -0
- package/lib/shadow-schema.d.ts +104 -0
- package/lib/shadow-schema.d.ts.map +1 -0
- package/lib/shadow-schema.js +75 -0
- package/lib/shadow-schema.js.map +1 -0
- package/lib/shadow-schema.test.d.ts +2 -0
- package/lib/shadow-schema.test.d.ts.map +1 -0
- package/lib/shadow-schema.test.js +148 -0
- package/lib/shadow-schema.test.js.map +1 -0
- package/lib/status-response-schema.d.ts.map +1 -1
- package/lib/types.d.ts.map +1 -1
- package/lib/types.js +1 -3
- package/lib/types.js.map +1 -1
- package/lib/types.test.js +92 -92
- package/lib/types.test.js.map +1 -1
- package/package.json +2 -4
- package/src/app-action-schema.ts +1 -1
- package/src/constants.test.ts +7 -5
- package/src/constants.ts +30 -19
- package/src/device-agent-action-schema.ts +2 -1
- package/src/index.ts +38 -13
- package/src/message-builders.ts +48 -36
- package/src/schemas/shadow-project-update-schema.json +30 -0
- package/src/schemas/shadow-projects-update-all-schema.json +17 -0
- package/src/shadow-schema.test.ts +172 -0
- package/src/shadow-schema.ts +172 -0
- package/src/status-response-schema.ts +2 -1
- package/src/types.test.ts +97 -94
- package/src/types.ts +30 -19
- package/lib/system-information-schema.d.ts +0 -45
- package/lib/system-information-schema.d.ts.map +0 -1
- package/lib/system-information-schema.js +0 -3
- package/lib/system-information-schema.js.map +0 -1
- package/src/system-information-schema.ts +0 -44
package/.eslintrc
CHANGED
|
@@ -1,25 +1,5 @@
|
|
|
1
1
|
{
|
|
2
2
|
"extends": [
|
|
3
3
|
"@alwaysai/eslint-config"
|
|
4
|
-
]
|
|
5
|
-
"settings": {
|
|
6
|
-
"import/resolver": {
|
|
7
|
-
"node": {
|
|
8
|
-
"extensions": [".ts", ".js"],
|
|
9
|
-
"moduleDirectory": ["src", "node_modules"]
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
},
|
|
13
|
-
"rules": {
|
|
14
|
-
"import/extensions": [
|
|
15
|
-
"error",
|
|
16
|
-
"ignorePackages",
|
|
17
|
-
{
|
|
18
|
-
"js": "never",
|
|
19
|
-
"ts": "never"
|
|
20
|
-
}
|
|
21
|
-
],
|
|
22
|
-
"no-shadow": "off",
|
|
23
|
-
"@typescript-eslint/no-shadow": ["error"]
|
|
24
|
-
}
|
|
4
|
+
]
|
|
25
5
|
}
|
package/docs/README.md
CHANGED
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Top-level Schemas
|
|
4
4
|
|
|
5
|
-
* [agent\_message](./agent-message-schema.md "The messaging payload structure for messages sent from device agent to clients") – `https://alwaysai.co/agent-message-schema.json`
|
|
6
|
-
|
|
7
5
|
* [app\_install](./app-install-schema.md) – `https://alwaysai.co/app-install-schema.json`
|
|
8
6
|
|
|
9
|
-
* [app\_install\
|
|
10
|
-
|
|
11
|
-
* [app\_install\_status](./app-install-status-schema.md) – `https://alwaysai.co/app-install-status-schema.json`
|
|
7
|
+
* [app\_install\_response](./app-install-response-schema.md) – `https://alwaysai.co/app-install-response-schema.json`
|
|
12
8
|
|
|
13
9
|
* [app\_logs](./app-logs-schema.md) – `https://alwaysai.co/app-logs-schema.json`
|
|
14
10
|
|
|
@@ -20,31 +16,41 @@
|
|
|
20
16
|
|
|
21
17
|
* [app\_version\_control](./app-version-control-schema.md) – `https://alwaysai.co/app-version-control-schema.json`
|
|
22
18
|
|
|
23
|
-
* [
|
|
19
|
+
* [cloud\_message](./to-cloud-message-schema.md "The messaging payload structure for messages sent from device agent to the cloud") – `https://alwaysai.co/cloud-message-schema.json`
|
|
24
20
|
|
|
25
21
|
* [common](./common-schema.md) – `https://alwaysai.co/common-schema.json`
|
|
26
22
|
|
|
27
|
-
* [device\
|
|
23
|
+
* [device\_action](./device-action-schema.md) – `https://alwaysai.co/device-action-schema.json`
|
|
28
24
|
|
|
29
|
-
* [
|
|
25
|
+
* [device\_stats](./device-stats-schema.md) – `https://alwaysai.co/device-stats-schema.json`
|
|
30
26
|
|
|
31
|
-
* [
|
|
27
|
+
* [live\_state\_updates](./live-updates-toggle-schema.md) – `https://alwaysai.co/live-updates-toggle-schema.json`
|
|
32
28
|
|
|
33
29
|
* [models\_install\_payload](./models-install-payload-schema.md) – `https://alwaysai.co/models-install-payload-schema.json`
|
|
34
30
|
|
|
31
|
+
* [models\_install\_response](./models-install-response-schema.md) – `https://alwaysai.co/models-install-response-schema.json`
|
|
32
|
+
|
|
33
|
+
* [shadow-projects-update-all](./shadow-projects-update-all-schema.md "The messaging payload structure for shadow's projects update delta") – `https://alwaysai.co/shadow-projects-update-all-schema.json`
|
|
34
|
+
|
|
35
|
+
* [shadow\_project\_update\_schema](./shadow-project-update-schema.md "The messaging payload structure for a all properties of a single project shadow update") – `https://alwaysai.co/shadow-project-update-schema.json`
|
|
36
|
+
|
|
35
37
|
* [signed\_urls\_request](./signed-urls-request-schema.md) – `https://alwaysai.co/signed-urls-request-schema.json`
|
|
36
38
|
|
|
37
|
-
|
|
39
|
+
* [status\_response](./status-response-schema.md) – `https://alwaysai.co/status-response-schema.json`
|
|
38
40
|
|
|
39
|
-
|
|
41
|
+
* [system-information](./system-information-schema.md) – `https://alwaysai.co/system-information-schema.json`
|
|
42
|
+
|
|
43
|
+
* [to\_client\_message](./to-client-message-schema.md "The messaging payload structure for messages sent from device agent to clients") – `https://alwaysai.co/to-client-message-schema.json`
|
|
40
44
|
|
|
41
|
-
* [
|
|
45
|
+
* [to\_device\_agent\_message](./to-device-agent-message-schema.md "A schema that describes the message payload structure for messages sent from clients to device agent") – `https://alwaysai.co/to-device-agent-message-schema.json`
|
|
42
46
|
|
|
43
|
-
|
|
47
|
+
## Other Schemas
|
|
48
|
+
|
|
49
|
+
### Objects
|
|
44
50
|
|
|
45
|
-
* [Untitled object in app\_install\
|
|
51
|
+
* [Untitled object in app\_install\_response](./app-install-response-schema-properties-appinstallresponse.md) – `https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse`
|
|
46
52
|
|
|
47
|
-
* [Untitled object in app\
|
|
53
|
+
* [Untitled object in app\_install\_response](./app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md) – `https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/appInstallPayload`
|
|
48
54
|
|
|
49
55
|
* [Untitled object in app\_state](./app-state-schema-properties-appstate-items.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items`
|
|
50
56
|
|
|
@@ -52,30 +58,50 @@
|
|
|
52
58
|
|
|
53
59
|
* [Untitled object in app\_state](./app-state-schema-properties-appstate-items-properties-services-items.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items`
|
|
54
60
|
|
|
55
|
-
* [Untitled object in
|
|
61
|
+
* [Untitled object in device\_stats](./device-stats-schema-properties-cpudetails.md "CPU utilization information") – `https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails`
|
|
56
62
|
|
|
57
|
-
* [Untitled object in device\_stats](./device-
|
|
63
|
+
* [Untitled object in device\_stats](./device-stats-schema-properties-diskdetails.md "Disk utilization information") – `https://alwaysai.co/device-stats-schema.json#/properties/diskDetails`
|
|
58
64
|
|
|
59
|
-
* [Untitled object in
|
|
65
|
+
* [Untitled object in device\_stats](./device-stats-schema-properties-memdetails.md "Memory utilization information") – `https://alwaysai.co/device-stats-schema.json#/properties/memDetails`
|
|
60
66
|
|
|
61
|
-
* [Untitled object in live\_state\_updates](./live-updates-toggle-schema-properties-
|
|
62
|
-
|
|
63
|
-
* [Untitled object in models\_install\_cloud\_response](./models-install-cloud-response-schema-properties-modelsinstallcloudresponse.md) – `https://alwaysai.co/models-install-cloud-response-schema.json#/properties/modelsInstallCloudResponse`
|
|
67
|
+
* [Untitled object in live\_state\_updates](./live-updates-toggle-schema-properties-applogs.md) – `https://alwaysai.co/live-updates-toggle-schema.json#/properties/appLogs`
|
|
64
68
|
|
|
65
69
|
* [Untitled object in models\_install\_payload](./models-install-payload-schema-items.md) – `https://alwaysai.co/models-install-payload-schema.json#/items`
|
|
66
70
|
|
|
71
|
+
* [Untitled object in models\_install\_response](./models-install-response-schema-properties-modelsinstallresponse.md) – `https://alwaysai.co/models-install-response-schema.json#/properties/modelsInstallResponse`
|
|
72
|
+
|
|
73
|
+
* [Untitled object in shadow\_project\_update\_schema](./shadow-project-update-schema-properties-envvars.md) – `https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars`
|
|
74
|
+
|
|
75
|
+
* [Untitled object in shadow\_project\_update\_schema](./shadow-project-update-schema-properties-envvars-patternproperties-.md) – `https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*`
|
|
76
|
+
|
|
67
77
|
* [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-signedurlsrequest.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest`
|
|
68
78
|
|
|
69
79
|
* [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-modelsonlyurlsrequest.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest`
|
|
70
80
|
|
|
71
81
|
* [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/models`
|
|
72
82
|
|
|
83
|
+
* [Untitled object in system-information](./system-information-schema-properties-os.md) – `https://alwaysai.co/system-information-schema.json#/properties/os`
|
|
84
|
+
|
|
85
|
+
* [Untitled object in system-information](./system-information-schema-properties-cpu.md) – `https://alwaysai.co/system-information-schema.json#/properties/cpu`
|
|
86
|
+
|
|
87
|
+
* [Untitled object in system-information](./system-information-schema-properties-disk.md) – `https://alwaysai.co/system-information-schema.json#/properties/disk`
|
|
88
|
+
|
|
89
|
+
* [Untitled object in system-information](./system-information-schema-properties-disk-properties-drives-items.md) – `https://alwaysai.co/system-information-schema.json#/properties/disk/properties/drives/items`
|
|
90
|
+
|
|
91
|
+
* [Untitled object in system-information](./system-information-schema-properties-device.md) – `https://alwaysai.co/system-information-schema.json#/properties/device`
|
|
92
|
+
|
|
93
|
+
* [Untitled object in system-information](./system-information-schema-properties-network.md) – `https://alwaysai.co/system-information-schema.json#/properties/network`
|
|
94
|
+
|
|
95
|
+
* [Untitled object in system-information](./system-information-schema-properties-versions.md) – `https://alwaysai.co/system-information-schema.json#/properties/versions`
|
|
96
|
+
|
|
73
97
|
### Arrays
|
|
74
98
|
|
|
75
99
|
* [Untitled array in app\_state](./app-state-schema-properties-appstate.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState`
|
|
76
100
|
|
|
77
101
|
* [Untitled array in app\_state](./app-state-schema-properties-appstate-items-properties-services.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services`
|
|
78
102
|
|
|
103
|
+
* [Untitled array in system-information](./system-information-schema-properties-disk-properties-drives.md) – `https://alwaysai.co/system-information-schema.json#/properties/disk/properties/drives`
|
|
104
|
+
|
|
79
105
|
## Version Note
|
|
80
106
|
|
|
81
107
|
The schemas linked above follow the JSON Schema Spec version: `https://json-schema.org/draft/2019-09/schema`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in app\_install\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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-response-schema.json\*](../out/app-install-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appSignedUrl Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Untitled object in app\_install\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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-response-schema.json\*](../out/app-install-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appInstallPayload Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-install-response-schema-properties-appinstallresponse-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\_response](app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload-properties-appsignedurl.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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\_response](app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload-properties-appsignedurl.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/appInstallPayload/properties/appSignedUrl")
|
|
36
|
+
|
|
37
|
+
### appSignedUrl Type
|
|
38
|
+
|
|
39
|
+
`string`
|
package/docs/app-install-response-schema-properties-appinstallresponse-properties-appreleasehash.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_install\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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-response-schema.json\*](../out/app-install-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/appInstallResponse/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-response-schema.json\*](../out/app-install-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## modelsInstallPayload Type
|
|
14
|
+
|
|
15
|
+
`object[]` ([Details](models-install-payload-schema-items.md))
|
package/docs/app-install-response-schema-properties-appinstallresponse-properties-projectid.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_install\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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-response-schema.json\*](../out/app-install-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-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Untitled object in app\_install\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse
|
|
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-response-schema.json\*](../out/app-install-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## appInstallResponse Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](app-install-response-schema-properties-appinstallresponse.md))
|
|
16
|
+
|
|
17
|
+
# appInstallResponse Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------------------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [app\_install\_response](app-install-response-schema-properties-appinstallresponse-properties-projectid.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/projectId") |
|
|
22
|
+
| [appReleaseHash](#appreleasehash) | `string` | Required | cannot be null | [app\_install\_response](app-install-response-schema-properties-appinstallresponse-properties-appreleasehash.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/appReleaseHash") |
|
|
23
|
+
| [appInstallPayload](#appinstallpayload) | `object` | Required | cannot be null | [app\_install\_response](app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/appInstallPayload") |
|
|
24
|
+
| [modelsInstallPayload](#modelsinstallpayload) | `array` | Required | cannot be null | [app\_install\_response](app-install-response-schema-properties-appinstallresponse-properties-models_install_payload.md "https://alwaysai.co/models-install-payload-schema.json#/properties/appInstallResponse/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\_response](app-install-response-schema-properties-appinstallresponse-properties-projectid.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "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\_response](app-install-response-schema-properties-appinstallresponse-properties-appreleasehash.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/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-response-schema-properties-appinstallresponse-properties-appinstallpayload.md))
|
|
91
|
+
|
|
92
|
+
* cannot be null
|
|
93
|
+
|
|
94
|
+
* defined in: [app\_install\_response](app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/appInstallPayload")
|
|
95
|
+
|
|
96
|
+
### appInstallPayload Type
|
|
97
|
+
|
|
98
|
+
`object` ([Details](app-install-response-schema-properties-appinstallresponse-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\_response](app-install-response-schema-properties-appinstallresponse-properties-models_install_payload.md "https://alwaysai.co/models-install-payload-schema.json#/properties/appInstallResponse/properties/modelsInstallPayload")
|
|
113
|
+
|
|
114
|
+
### modelsInstallPayload Type
|
|
115
|
+
|
|
116
|
+
`object[]` ([Details](models-install-payload-schema-items.md))
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# app\_install\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-install-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-response-schema.json](../out/app-install-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## app\_install\_response Type
|
|
14
|
+
|
|
15
|
+
`object` ([app\_install\_response](app-install-response-schema.md))
|
|
16
|
+
|
|
17
|
+
# app\_install\_response Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [appInstallResponse](#appinstallresponse) | `object` | Required | cannot be null | [app\_install\_response](app-install-response-schema-properties-appinstallresponse.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse") |
|
|
22
|
+
|
|
23
|
+
## appInstallResponse
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
`appInstallResponse`
|
|
28
|
+
|
|
29
|
+
* is required
|
|
30
|
+
|
|
31
|
+
* Type: `object` ([Details](app-install-response-schema-properties-appinstallresponse.md))
|
|
32
|
+
|
|
33
|
+
* cannot be null
|
|
34
|
+
|
|
35
|
+
* defined in: [app\_install\_response](app-install-response-schema-properties-appinstallresponse.md "https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse")
|
|
36
|
+
|
|
37
|
+
### appInstallResponse Type
|
|
38
|
+
|
|
39
|
+
`object` ([Details](app-install-response-schema-properties-appinstallresponse.md))
|
|
@@ -19,7 +19,7 @@ The specific project associated with the message payload.
|
|
|
19
19
|
**pattern**: the string must match the following regular expression: 
|
|
20
20
|
|
|
21
21
|
```regexp
|
|
22
|
-
|
|
22
|
+
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
[try pattern](https://regexr.com/?expression
|
|
25
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
|
@@ -71,10 +71,10 @@ The specific project associated with the message payload.
|
|
|
71
71
|
**pattern**: the string must match the following regular expression: 
|
|
72
72
|
|
|
73
73
|
```regexp
|
|
74
|
-
|
|
74
|
+
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
[try pattern](https://regexr.com/?expression
|
|
77
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
|
78
78
|
|
|
79
79
|
## appReleaseHash
|
|
80
80
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in app\_logs Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-logs-schema.json#/properties/logChunk
|
|
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-logs-schema.json\*](../out/app-logs-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## logChunk Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_logs Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-logs-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-logs-schema.json\*](../out/app-logs-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-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
package/docs/app-logs-schema.md
CHANGED
|
@@ -16,51 +16,53 @@ https://alwaysai.co/app-logs-schema.json
|
|
|
16
16
|
|
|
17
17
|
# app\_logs Properties
|
|
18
18
|
|
|
19
|
-
| Property
|
|
20
|
-
|
|
|
21
|
-
| [
|
|
22
|
-
| [
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [app\_logs](app-logs-schema-properties-projectid.md "https://alwaysai.co/app-logs-schema.json#/properties/projectId") |
|
|
22
|
+
| [logChunk](#logchunk) | `string` | Required | cannot be null | [app\_logs](app-logs-schema-properties-logchunk.md "https://alwaysai.co/app-logs-schema.json#/properties/logChunk") |
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## projectId
|
|
25
25
|
|
|
26
|
+
The specific project associated with the message payload.
|
|
26
27
|
|
|
27
|
-
|
|
28
|
-
`messageType`
|
|
28
|
+
`projectId`
|
|
29
29
|
|
|
30
30
|
* is required
|
|
31
31
|
|
|
32
|
-
* Type:
|
|
32
|
+
* Type: `string`
|
|
33
33
|
|
|
34
34
|
* cannot be null
|
|
35
35
|
|
|
36
|
-
* defined in: [app\_logs](app-logs-schema-properties-
|
|
36
|
+
* defined in: [app\_logs](app-logs-schema-properties-projectid.md "https://alwaysai.co/app-logs-schema.json#/properties/projectId")
|
|
37
37
|
|
|
38
|
-
###
|
|
38
|
+
### projectId Type
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
`string`
|
|
41
41
|
|
|
42
|
-
###
|
|
42
|
+
### projectId Constraints
|
|
43
43
|
|
|
44
|
-
**
|
|
44
|
+
**pattern**: the string must match the following regular expression: 
|
|
45
45
|
|
|
46
|
-
```
|
|
47
|
-
|
|
46
|
+
```regexp
|
|
47
|
+
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
|
51
|
+
|
|
52
|
+
## logChunk
|
|
51
53
|
|
|
52
54
|
|
|
53
55
|
|
|
54
|
-
`
|
|
56
|
+
`logChunk`
|
|
55
57
|
|
|
56
58
|
* is required
|
|
57
59
|
|
|
58
|
-
* Type: `
|
|
60
|
+
* Type: `string`
|
|
59
61
|
|
|
60
62
|
* cannot be null
|
|
61
63
|
|
|
62
|
-
* defined in: [app\_logs](app-logs-schema-properties-
|
|
64
|
+
* defined in: [app\_logs](app-logs-schema-properties-logchunk.md "https://alwaysai.co/app-logs-schema.json#/properties/logChunk")
|
|
63
65
|
|
|
64
|
-
###
|
|
66
|
+
### logChunk Type
|
|
65
67
|
|
|
66
|
-
`
|
|
68
|
+
`string`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in app\_state\_control Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/app-state-control-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-state-control-schema.json\*](../out/app-state-control-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
|
+
| `"start"` | |
|
|
24
|
+
| `"stop"` | |
|
|
25
|
+
| `"restart"` | |
|