@alwaysai/device-agent-schemas 2.1.12 → 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 +11 -11
- package/lib/message-builders.d.ts.map +1 -1
- package/lib/message-builders.js +3 -4
- 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 -37
- 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
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled undefined type in shadow\_project\_update\_schema Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*/patternProperties/.*
|
|
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 | [shadow-project-update-schema.json\*](../out/shadow-project-update-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## .\* Type
|
|
14
|
+
|
|
15
|
+
`string`
|
package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled undefined type in shadow\_project\_update\_schema Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*/patternProperties
|
|
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 | [shadow-project-update-schema.json\*](../out/shadow-project-update-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## patternProperties Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Untitled object in shadow\_project\_update\_schema Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*
|
|
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 | [shadow-project-update-schema.json\*](../out/shadow-project-update-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## .\* Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](shadow-project-update-schema-properties-envvars-patternproperties-.md))
|
|
16
|
+
|
|
17
|
+
# .\* Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :------- | :------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
+
| `.*` | `string` | Optional | can be null | [shadow\_project\_update\_schema](shadow-project-update-schema-properties-envvars-patternproperties--patternproperties-.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*/patternProperties/.*") |
|
|
22
|
+
|
|
23
|
+
## Pattern: `.*`
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
`.*`
|
|
28
|
+
|
|
29
|
+
* is optional
|
|
30
|
+
|
|
31
|
+
* Type: `string`
|
|
32
|
+
|
|
33
|
+
* can be null
|
|
34
|
+
|
|
35
|
+
* defined in: [shadow\_project\_update\_schema](shadow-project-update-schema-properties-envvars-patternproperties--patternproperties-.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*/patternProperties/.*")
|
|
36
|
+
|
|
37
|
+
### .\* Type
|
|
38
|
+
|
|
39
|
+
`string`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled undefined type in shadow\_project\_update\_schema Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties
|
|
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 | [shadow-project-update-schema.json\*](../out/shadow-project-update-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## patternProperties Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Untitled object in shadow\_project\_update\_schema Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars
|
|
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 | [shadow-project-update-schema.json\*](../out/shadow-project-update-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## envVars Type
|
|
14
|
+
|
|
15
|
+
`object` ([Details](shadow-project-update-schema-properties-envvars.md))
|
|
16
|
+
|
|
17
|
+
# envVars Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| `.*` | `object` | Optional | cannot be null | [shadow\_project\_update\_schema](shadow-project-update-schema-properties-envvars-patternproperties-.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*") |
|
|
22
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
23
|
+
|
|
24
|
+
## Pattern: `.*`
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`.*`
|
|
29
|
+
|
|
30
|
+
* is optional
|
|
31
|
+
|
|
32
|
+
* Type: `object` ([Details](shadow-project-update-schema-properties-envvars-patternproperties-.md))
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [shadow\_project\_update\_schema](shadow-project-update-schema-properties-envvars-patternproperties-.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*")
|
|
37
|
+
|
|
38
|
+
### .\* Type
|
|
39
|
+
|
|
40
|
+
`object` ([Details](shadow-project-update-schema-properties-envvars-patternproperties-.md))
|
|
41
|
+
|
|
42
|
+
## Additional Properties
|
|
43
|
+
|
|
44
|
+
Additional properties are allowed and do not have to follow a specific schema
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# shadow\_project\_update\_schema Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-project-update-schema.json
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The messaging payload structure for a all properties of a single project shadow update
|
|
8
|
+
|
|
9
|
+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [shadow-project-update-schema.json](../out/shadow-project-update-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## shadow\_project\_update\_schema Type
|
|
14
|
+
|
|
15
|
+
`object` ([shadow\_project\_update\_schema](shadow-project-update-schema.md))
|
|
16
|
+
|
|
17
|
+
# shadow\_project\_update\_schema Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [appConfig](#appconfig) | `string` | Optional | cannot be null | [shadow\_project\_update\_schema](shadow-project-update-schema-properties-appconfig.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/appConfig") |
|
|
22
|
+
| [envVars](#envvars) | `object` | Optional | cannot be null | [shadow\_project\_update\_schema](shadow-project-update-schema-properties-envvars.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars") |
|
|
23
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
24
|
+
|
|
25
|
+
## appConfig
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
`appConfig`
|
|
30
|
+
|
|
31
|
+
* is optional
|
|
32
|
+
|
|
33
|
+
* Type: `string`
|
|
34
|
+
|
|
35
|
+
* cannot be null
|
|
36
|
+
|
|
37
|
+
* defined in: [shadow\_project\_update\_schema](shadow-project-update-schema-properties-appconfig.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/appConfig")
|
|
38
|
+
|
|
39
|
+
### appConfig Type
|
|
40
|
+
|
|
41
|
+
`string`
|
|
42
|
+
|
|
43
|
+
## envVars
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
`envVars`
|
|
48
|
+
|
|
49
|
+
* is optional
|
|
50
|
+
|
|
51
|
+
* Type: `object` ([Details](shadow-project-update-schema-properties-envvars.md))
|
|
52
|
+
|
|
53
|
+
* cannot be null
|
|
54
|
+
|
|
55
|
+
* defined in: [shadow\_project\_update\_schema](shadow-project-update-schema-properties-envvars.md "https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars")
|
|
56
|
+
|
|
57
|
+
### envVars Type
|
|
58
|
+
|
|
59
|
+
`object` ([Details](shadow-project-update-schema-properties-envvars.md))
|
|
60
|
+
|
|
61
|
+
## Additional Properties
|
|
62
|
+
|
|
63
|
+
Additional properties are allowed and do not have to follow a specific schema
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled undefined type in shadow-projects-update-all Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-projects-update-all-schema.json#/patternProperties
|
|
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 | [shadow-projects-update-all-schema.json\*](../out/shadow-projects-update-all-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## patternProperties Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Untitled string in shadow-projects-update-all Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-projects-update-all-schema.json#/propertyNames
|
|
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 | [shadow-projects-update-all-schema.json\*](../out/shadow-projects-update-all-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## propertyNames Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
16
|
+
|
|
17
|
+
## propertyNames 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,44 @@
|
|
|
1
|
+
# shadow-projects-update-all Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/shadow-projects-update-all-schema.json
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
The messaging payload structure for shadow's projects update delta
|
|
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 | [shadow-projects-update-all-schema.json](../out/shadow-projects-update-all-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## shadow-projects-update-all Type
|
|
14
|
+
|
|
15
|
+
`object` ([shadow-projects-update-all](shadow-projects-update-all-schema.md))
|
|
16
|
+
|
|
17
|
+
# shadow-projects-update-all Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| `.*` | `object` | Optional | cannot be null | [shadow-projects-update-all](shadow-projects-update-all-schema-patternproperties-shadow_project_update_schema.md "https://alwaysai.co/shadow-project-update-schema.json#/patternProperties/.*") |
|
|
22
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
23
|
+
|
|
24
|
+
## Pattern: `.*`
|
|
25
|
+
|
|
26
|
+
The messaging payload structure for a all properties of a single project shadow update
|
|
27
|
+
|
|
28
|
+
`.*`
|
|
29
|
+
|
|
30
|
+
* is optional
|
|
31
|
+
|
|
32
|
+
* Type: `object` ([shadow\_project\_update\_schema](shadow-projects-update-all-schema-patternproperties-shadow_project_update_schema.md))
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [shadow-projects-update-all](shadow-projects-update-all-schema-patternproperties-shadow_project_update_schema.md "https://alwaysai.co/shadow-project-update-schema.json#/patternProperties/.*")
|
|
37
|
+
|
|
38
|
+
### .\* Type
|
|
39
|
+
|
|
40
|
+
`object` ([shadow\_project\_update\_schema](shadow-projects-update-all-schema-patternproperties-shadow_project_update_schema.md))
|
|
41
|
+
|
|
42
|
+
## Additional Properties
|
|
43
|
+
|
|
44
|
+
Additional properties are allowed and do not have to follow a specific schema
|
|
@@ -16,10 +16,10 @@ https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRe
|
|
|
16
16
|
|
|
17
17
|
# modelsOnlyUrlsRequest Properties
|
|
18
18
|
|
|
19
|
-
| Property | Type | Required | Nullable | Defined by
|
|
20
|
-
| :---------------------- | :------- | :------- | :------------- |
|
|
21
|
-
| [projectId](#projectid) | `string` | Required | cannot be null | [signed\_urls\_request](
|
|
22
|
-
| [models](#models) | `object` | Required | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/models")
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [signed\_urls\_request](common-schema-defs-projectid.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/projectId") |
|
|
22
|
+
| [models](#models) | `object` | Required | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/models") |
|
|
23
23
|
|
|
24
24
|
## projectId
|
|
25
25
|
|
|
@@ -33,7 +33,7 @@ The specific project associated with the message payload.
|
|
|
33
33
|
|
|
34
34
|
* cannot be null
|
|
35
35
|
|
|
36
|
-
* defined in: [signed\_urls\_request](
|
|
36
|
+
* defined in: [signed\_urls\_request](common-schema-defs-projectid.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/projectId")
|
|
37
37
|
|
|
38
38
|
### projectId Type
|
|
39
39
|
|
|
@@ -44,10 +44,10 @@ The specific project associated with the message payload.
|
|
|
44
44
|
**pattern**: the string must match the following regular expression: 
|
|
45
45
|
|
|
46
46
|
```regexp
|
|
47
|
-
|
|
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
|
-
[try pattern](https://regexr.com/?expression
|
|
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
51
|
|
|
52
52
|
## models
|
|
53
53
|
|
|
@@ -16,10 +16,10 @@ https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsReques
|
|
|
16
16
|
|
|
17
17
|
# signedUrlsRequest Properties
|
|
18
18
|
|
|
19
|
-
| Property | Type | Required | Nullable | Defined by
|
|
20
|
-
| :-------------------------------- | :------- | :------- | :------------- |
|
|
21
|
-
| [projectId](#projectid) | `string` | Required | cannot be null | [signed\_urls\_request](
|
|
22
|
-
| [appReleaseHash](#appreleasehash) | `string` | Required | cannot be null | [signed\_urls\_request](
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [projectId](#projectid) | `string` | Required | cannot be null | [signed\_urls\_request](common-schema-defs-projectid.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest/properties/projectId") |
|
|
22
|
+
| [appReleaseHash](#appreleasehash) | `string` | Required | cannot be null | [signed\_urls\_request](common-schema-defs-appreleasehash.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest/properties/appReleaseHash") |
|
|
23
23
|
|
|
24
24
|
## projectId
|
|
25
25
|
|
|
@@ -33,7 +33,7 @@ The specific project associated with the message payload.
|
|
|
33
33
|
|
|
34
34
|
* cannot be null
|
|
35
35
|
|
|
36
|
-
* defined in: [signed\_urls\_request](
|
|
36
|
+
* defined in: [signed\_urls\_request](common-schema-defs-projectid.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest/properties/projectId")
|
|
37
37
|
|
|
38
38
|
### projectId Type
|
|
39
39
|
|
|
@@ -44,10 +44,10 @@ The specific project associated with the message payload.
|
|
|
44
44
|
**pattern**: the string must match the following regular expression: 
|
|
45
45
|
|
|
46
46
|
```regexp
|
|
47
|
-
|
|
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
|
-
[try pattern](https://regexr.com/?expression
|
|
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
51
|
|
|
52
52
|
## appReleaseHash
|
|
53
53
|
|
|
@@ -61,7 +61,7 @@ The version of the project associated with the message payload.
|
|
|
61
61
|
|
|
62
62
|
* cannot be null
|
|
63
63
|
|
|
64
|
-
* defined in: [signed\_urls\_request](
|
|
64
|
+
* defined in: [signed\_urls\_request](common-schema-defs-appreleasehash.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest/properties/appReleaseHash")
|
|
65
65
|
|
|
66
66
|
### appReleaseHash Type
|
|
67
67
|
|
|
@@ -16,37 +16,10 @@ https://alwaysai.co/signed-urls-request-schema.json
|
|
|
16
16
|
|
|
17
17
|
# signed\_urls\_request Properties
|
|
18
18
|
|
|
19
|
-
| Property | Type
|
|
20
|
-
| :---------------------------------------------- |
|
|
21
|
-
| [
|
|
22
|
-
| [
|
|
23
|
-
| [modelsOnlyUrlsRequest](#modelsonlyurlsrequest) | `object` | Optional | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-modelsonlyurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest") |
|
|
24
|
-
|
|
25
|
-
## messageType
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
`messageType`
|
|
30
|
-
|
|
31
|
-
* is required
|
|
32
|
-
|
|
33
|
-
* Type: unknown
|
|
34
|
-
|
|
35
|
-
* cannot be null
|
|
36
|
-
|
|
37
|
-
* defined in: [signed\_urls\_request](signed-urls-request-schema-properties-messagetype.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/messageType")
|
|
38
|
-
|
|
39
|
-
### messageType Type
|
|
40
|
-
|
|
41
|
-
unknown
|
|
42
|
-
|
|
43
|
-
### messageType Constraints
|
|
44
|
-
|
|
45
|
-
**constant**: the value of this property must be equal to:
|
|
46
|
-
|
|
47
|
-
```json
|
|
48
|
-
"signed_urls_request"
|
|
49
|
-
```
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :---------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
+
| [signedUrlsRequest](#signedurlsrequest) | `object` | Optional | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-signedurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest") |
|
|
22
|
+
| [modelsOnlyUrlsRequest](#modelsonlyurlsrequest) | `object` | Optional | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-modelsonlyurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest") |
|
|
50
23
|
|
|
51
24
|
## signedUrlsRequest
|
|
52
25
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in status\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/status-response-schema.json#/properties/message
|
|
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 | [status-response-schema.json\*](../out/status-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## message Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Untitled undefined type in status\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/status-response-schema.json#/properties/status
|
|
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 | [status-response-schema.json\*](../out/status-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## status Type
|
|
14
|
+
|
|
15
|
+
unknown
|
|
16
|
+
|
|
17
|
+
## status Constraints
|
|
18
|
+
|
|
19
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
20
|
+
|
|
21
|
+
| Value | Explanation |
|
|
22
|
+
| :------------------ | :---------- |
|
|
23
|
+
| `"requested"` | |
|
|
24
|
+
| `"in_progress"` | |
|
|
25
|
+
| `"failure"` | |
|
|
26
|
+
| `"success"` | |
|
|
27
|
+
| `"connection_lost"` | |
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# status\_response Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/status-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 | [status-response-schema.json](../out/status-response-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## status\_response Type
|
|
14
|
+
|
|
15
|
+
`object` ([status\_response](status-response-schema.md))
|
|
16
|
+
|
|
17
|
+
# status\_response Properties
|
|
18
|
+
|
|
19
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
+
| :------------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| [status](#status) | Not specified | Required | cannot be null | [status\_response](status-response-schema-properties-status.md "https://alwaysai.co/status-response-schema.json#/properties/status") |
|
|
22
|
+
| [message](#message) | `string` | Optional | cannot be null | [status\_response](status-response-schema-properties-message.md "https://alwaysai.co/status-response-schema.json#/properties/message") |
|
|
23
|
+
|
|
24
|
+
## status
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
`status`
|
|
29
|
+
|
|
30
|
+
* is required
|
|
31
|
+
|
|
32
|
+
* Type: unknown
|
|
33
|
+
|
|
34
|
+
* cannot be null
|
|
35
|
+
|
|
36
|
+
* defined in: [status\_response](status-response-schema-properties-status.md "https://alwaysai.co/status-response-schema.json#/properties/status")
|
|
37
|
+
|
|
38
|
+
### status Type
|
|
39
|
+
|
|
40
|
+
unknown
|
|
41
|
+
|
|
42
|
+
### status Constraints
|
|
43
|
+
|
|
44
|
+
**enum**: the value of this property must be equal to one of the following values:
|
|
45
|
+
|
|
46
|
+
| Value | Explanation |
|
|
47
|
+
| :------------------ | :---------- |
|
|
48
|
+
| `"requested"` | |
|
|
49
|
+
| `"in_progress"` | |
|
|
50
|
+
| `"failure"` | |
|
|
51
|
+
| `"success"` | |
|
|
52
|
+
| `"connection_lost"` | |
|
|
53
|
+
|
|
54
|
+
## message
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
`message`
|
|
59
|
+
|
|
60
|
+
* is optional
|
|
61
|
+
|
|
62
|
+
* Type: `string`
|
|
63
|
+
|
|
64
|
+
* cannot be null
|
|
65
|
+
|
|
66
|
+
* defined in: [status\_response](status-response-schema-properties-message.md "https://alwaysai.co/status-response-schema.json#/properties/message")
|
|
67
|
+
|
|
68
|
+
### message Type
|
|
69
|
+
|
|
70
|
+
`string`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in system-information Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/system-information-schema.json#/properties/cpu/properties/brand
|
|
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 | [system-information-schema.json\*](../out/system-information-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## brand Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled number in system-information Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/system-information-schema.json#/properties/cpu/properties/cores
|
|
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 | [system-information-schema.json\*](../out/system-information-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## cores Type
|
|
14
|
+
|
|
15
|
+
`number`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled number in system-information Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/system-information-schema.json#/properties/cpu/properties/efficiencyCores
|
|
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 | [system-information-schema.json\*](../out/system-information-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## efficiencyCores Type
|
|
14
|
+
|
|
15
|
+
`number`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in system-information Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/system-information-schema.json#/properties/cpu/properties/manufacturer
|
|
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 | [system-information-schema.json\*](../out/system-information-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## manufacturer Type
|
|
14
|
+
|
|
15
|
+
`string`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Untitled string in system-information Schema
|
|
2
|
+
|
|
3
|
+
```txt
|
|
4
|
+
https://alwaysai.co/system-information-schema.json#/properties/cpu/properties/model
|
|
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 | [system-information-schema.json\*](../out/system-information-schema.json "open original schema") |
|
|
12
|
+
|
|
13
|
+
## model Type
|
|
14
|
+
|
|
15
|
+
`string`
|