@fleetless/contracts 1.2.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -1
- package/artifacts/constants.json +30 -4
- package/artifacts/openapi.json +882 -80
- package/artifacts/routes.json +217 -7
- package/artifacts/schema/app-deletion-summary.schema.json +51 -0
- package/artifacts/schema/apply-error.schema.json +2 -1
- package/artifacts/schema/asset-list-response.schema.json +77 -12
- package/artifacts/schema/asset-sync-status.schema.json +35 -8
- package/artifacts/schema/asset.schema.json +2 -3
- package/artifacts/schema/assets-clear-response.schema.json +23 -0
- package/artifacts/schema/bridge-asset-progress.schema.json +14 -8
- package/artifacts/schema/bridge-config-applied.schema.json +2 -1
- package/artifacts/schema/bridge-link-mode.schema.json +36 -0
- package/artifacts/schema/bridge-state.schema.json +6 -1
- package/artifacts/schema/client-robot-list-item.schema.json +6 -1
- package/artifacts/schema/client-robot-list-response.schema.json +6 -1
- package/artifacts/schema/cloud-config.schema.json +90 -5
- package/artifacts/schema/cloud-hello-ok.schema.json +45 -0
- package/artifacts/schema/cloud-ping.schema.json +27 -1
- package/artifacts/schema/config-draft-response.schema.json +90 -5
- package/artifacts/schema/config-state.schema.json +2 -1
- package/artifacts/schema/config-version-response.schema.json +90 -5
- package/artifacts/schema/datapoint-config.schema.json +5 -0
- package/artifacts/schema/datapoint-frame.schema.json +4 -0
- package/artifacts/schema/datapoint-list-response.schema.json +2 -2
- package/artifacts/schema/joint-state-put-request.schema.json +23 -0
- package/artifacts/schema/joint-state-put-response.schema.json +24 -0
- package/artifacts/schema/org-quota-usage-counts.schema.json +0 -5
- package/artifacts/schema/org-quota-usage.schema.json +1 -12
- package/artifacts/schema/org-quotas.schema.json +1 -7
- package/artifacts/schema/put-app-auth-mcp-request.schema.json +27 -0
- package/artifacts/schema/put-app-auth-registration-request.schema.json +36 -0
- package/artifacts/schema/put-app-auth-urls-request.schema.json +48 -0
- package/artifacts/schema/robot-config-doc.schema.json +90 -5
- package/artifacts/schema/robot-deletion-summary.schema.json +2 -1
- package/artifacts/schema/robot-detail-response.schema.json +63 -2
- package/artifacts/schema/robot-list-item.schema.json +15 -1
- package/artifacts/schema/robot-list-response.schema.json +15 -1
- package/artifacts/schema/robot-token-rotate-response.schema.json +15 -0
- package/artifacts/schema-outgoing/bridge-asset-progress.schema.json +14 -8
- package/artifacts/schema-outgoing/bridge-config-applied.schema.json +2 -1
- package/artifacts/schema-outgoing/bridge-link-mode.schema.json +37 -0
- package/artifacts/schema-outgoing/datapoint-frame.schema.json +4 -0
- package/dist/app-users.d.ts +25 -7
- package/dist/app-users.js +24 -6
- package/dist/apps.d.ts +22 -0
- package/dist/apps.js +33 -0
- package/dist/assets.d.ts +85 -50
- package/dist/assets.js +152 -62
- package/dist/audit.d.ts +1 -1
- package/dist/audit.js +1 -1
- package/dist/client-robots.d.ts +2 -0
- package/dist/common.d.ts +10 -0
- package/dist/common.js +16 -1
- package/dist/config.d.ts +69 -1
- package/dist/config.js +86 -6
- package/dist/errors.d.ts +1 -1
- package/dist/errors.js +1 -8
- package/dist/index.d.ts +12 -12
- package/dist/index.js +6 -6
- package/dist/protocol.d.ts +150 -71
- package/dist/protocol.js +144 -87
- package/dist/rest.d.ts +139 -35
- package/dist/rest.js +100 -66
- package/dist/routes.js +129 -21
- package/package.json +1 -1
- package/artifacts/schema/bridge-pressure.schema.json +0 -292
- package/artifacts/schema/put-app-auth-config-request.schema.json +0 -93
|
@@ -118,6 +118,11 @@
|
|
|
118
118
|
0.5
|
|
119
119
|
]
|
|
120
120
|
},
|
|
121
|
+
"low_bandwidth": {
|
|
122
|
+
"description": "`keep` exempts this datapoint from the low-bandwidth rate cap; its backfill still pauses.",
|
|
123
|
+
"type": "string",
|
|
124
|
+
"const": "keep"
|
|
125
|
+
},
|
|
121
126
|
"description": {
|
|
122
127
|
"description": "Prose about what this value is, for whoever meets it in the console. It changes nothing the robot does, so a publish that touches only it pushes no configuration at all — but it is carried verbatim into `robot_describe`, where a model that has never seen this robot reads it. The datapoint is offered whenever the role grants it; without one it is offered with `description: null` and the model has less to go on, as for actions, services, publishers and cameras. Omission is the only way to say nothing; an empty string is refused, here and on all five.",
|
|
123
128
|
"examples": [
|
|
@@ -438,7 +443,7 @@
|
|
|
438
443
|
}
|
|
439
444
|
]
|
|
440
445
|
},
|
|
441
|
-
"description": "Values the robot publishes, each one field of one topic or a whole topic, and **never several topics**. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
446
|
+
"description": "Values the robot publishes, each one field of one topic or a whole topic, and **never several topics**. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
442
447
|
"defaultSnippets": [
|
|
443
448
|
{
|
|
444
449
|
"label": "a datapoint",
|
|
@@ -686,7 +691,7 @@
|
|
|
686
691
|
}
|
|
687
692
|
]
|
|
688
693
|
},
|
|
689
|
-
"description": "Things the robot does on request that take time, each reported as a job with progress. **At most one job runs per action slug**: a second call is refused `busy`, and every observer of that slug watches the same job. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
694
|
+
"description": "Things the robot does on request that take time, each reported as a job with progress. **At most one job runs per action slug**: a second call is refused `busy`, and every observer of that slug watches the same job. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
690
695
|
"defaultSnippets": [
|
|
691
696
|
{
|
|
692
697
|
"label": "an action",
|
|
@@ -907,7 +912,7 @@
|
|
|
907
912
|
}
|
|
908
913
|
]
|
|
909
914
|
},
|
|
910
|
-
"description": "ROS service calls the robot answers — one request, one reply. Unlike an action a service reports **no progress** and the call returns with its result already on the job, so there is nothing left to observe; a second concurrent call is still refused `busy`, exactly as for an action. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
915
|
+
"description": "ROS service calls the robot answers — one request, one reply. Unlike an action a service reports **no progress** and the call returns with its result already on the job, so there is nothing left to observe; a second concurrent call is still refused `busy`, exactly as for an action. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
911
916
|
"defaultSnippets": [
|
|
912
917
|
{
|
|
913
918
|
"label": "a service",
|
|
@@ -1215,7 +1220,7 @@
|
|
|
1215
1220
|
}
|
|
1216
1221
|
]
|
|
1217
1222
|
},
|
|
1218
|
-
"description": "Topics clients may send to, and where the format's whole safety story lives. The `message` template fixes every value a caller cannot change, and **`failsafe` is required**: once a client falls silent the bridge sends the failsafe message itself, so an operator whose window closed does not leave a robot driving. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
1223
|
+
"description": "Topics clients may send to, and where the format's whole safety story lives. The `message` template fixes every value a caller cannot change, and **`failsafe` is required**: once a client falls silent the bridge sends the failsafe message itself, so an operator whose window closed does not leave a robot driving. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
1219
1224
|
"defaultSnippets": [
|
|
1220
1225
|
{
|
|
1221
1226
|
"label": "a publisher, with its parameters and its failsafe",
|
|
@@ -1599,7 +1604,7 @@
|
|
|
1599
1604
|
}
|
|
1600
1605
|
]
|
|
1601
1606
|
},
|
|
1602
|
-
"description": "Video the robot streams, and the still frames the cloud serves from it. `width`, `height`, `fps` and `bitrate_kbps` are what **the bridge produces before sending**, not what the camera captures — they live in the configuration rather than in a viewer's request precisely so that no viewer can make a robot send more. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
1607
|
+
"description": "Video the robot streams, and the still frames the cloud serves from it. `width`, `height`, `fps` and `bitrate_kbps` are what **the bridge produces before sending**, not what the camera captures — they live in the configuration rather than in a viewer's request precisely so that no viewer can make a robot send more. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
1603
1608
|
"defaultSnippets": [
|
|
1604
1609
|
{
|
|
1605
1610
|
"label": "a camera",
|
|
@@ -1620,6 +1625,86 @@
|
|
|
1620
1625
|
}
|
|
1621
1626
|
}
|
|
1622
1627
|
]
|
|
1628
|
+
},
|
|
1629
|
+
"low_bandwidth": {
|
|
1630
|
+
"description": "Overrides for the bridge's low-bandwidth mode; see the section schema.",
|
|
1631
|
+
"defaultSnippets": [
|
|
1632
|
+
{
|
|
1633
|
+
"label": "low-bandwidth mode, tuned",
|
|
1634
|
+
"description": "Enters after ten seconds above two seconds of lag, caps every datapoint to 1 Hz and lets running streams continue at a reduced bitrate.",
|
|
1635
|
+
"body": {
|
|
1636
|
+
"enter_lag_ms": 2000,
|
|
1637
|
+
"datapoint_max_hz": 1,
|
|
1638
|
+
"camera": "reduce"
|
|
1639
|
+
}
|
|
1640
|
+
}
|
|
1641
|
+
],
|
|
1642
|
+
"type": "object",
|
|
1643
|
+
"properties": {
|
|
1644
|
+
"mode": {
|
|
1645
|
+
"description": "`auto` decides from the measured lag; `on` and `off` force the mode, for tests and for an operator who knows the link.",
|
|
1646
|
+
"enumDescriptions": [
|
|
1647
|
+
"The bridge enters and leaves the mode on its own, from the lag the cloud reports and the dwell it measures in its own send queue. The setting to leave alone.",
|
|
1648
|
+
"The mode is held on, whatever the link is doing. For a robot on a link known to be poor, and for a test that would otherwise have to wait for a real one.",
|
|
1649
|
+
"The mode never engages, whatever the link is doing. The robot then sends at its configured rates over a link that cannot carry them, which is a choice and not a default."
|
|
1650
|
+
],
|
|
1651
|
+
"type": "string",
|
|
1652
|
+
"enum": [
|
|
1653
|
+
"auto",
|
|
1654
|
+
"on",
|
|
1655
|
+
"off"
|
|
1656
|
+
]
|
|
1657
|
+
},
|
|
1658
|
+
"enter_lag_ms": {
|
|
1659
|
+
"description": "Lag or queue dwell above this enters the mode. Checked against exit_lag_ms only when both are in this document; a lone key composes with the bridge's parameter or the default on the robot, and a crossed pair is refused there when the configuration is applied, so name both when you change either.",
|
|
1660
|
+
"type": "integer",
|
|
1661
|
+
"minimum": 100,
|
|
1662
|
+
"maximum": 9007199254740991
|
|
1663
|
+
},
|
|
1664
|
+
"enter_after_s": {
|
|
1665
|
+
"description": "The entry condition must hold this long.",
|
|
1666
|
+
"type": "integer",
|
|
1667
|
+
"minimum": 1,
|
|
1668
|
+
"maximum": 9007199254740991
|
|
1669
|
+
},
|
|
1670
|
+
"exit_lag_ms": {
|
|
1671
|
+
"description": "Lag and dwell both at or below this leave the mode. Must be at or below enter_lag_ms: a crossed pair is a mode that leaves as it arrives. Checked here only when both keys are present; a lone key is checked on the robot against the parameter or default it composes with.",
|
|
1672
|
+
"type": "integer",
|
|
1673
|
+
"minimum": 0,
|
|
1674
|
+
"maximum": 9007199254740991
|
|
1675
|
+
},
|
|
1676
|
+
"exit_after_s": {
|
|
1677
|
+
"description": "The exit condition must hold this long.",
|
|
1678
|
+
"type": "integer",
|
|
1679
|
+
"minimum": 1,
|
|
1680
|
+
"maximum": 9007199254740991
|
|
1681
|
+
},
|
|
1682
|
+
"datapoint_max_hz": {
|
|
1683
|
+
"description": "The long-run rate for every datapoint in the mode, unless the datapoint says `low_bandwidth: keep`. It is an average, not a minimum gap: after a quiet spell two samples may go out close together, and over any longer window the rate holds.",
|
|
1684
|
+
"type": "number",
|
|
1685
|
+
"exclusiveMinimum": 0,
|
|
1686
|
+
"maximum": 20
|
|
1687
|
+
},
|
|
1688
|
+
"camera": {
|
|
1689
|
+
"description": "What happens to a running stream in the mode. New streams are refused either way.",
|
|
1690
|
+
"enumDescriptions": [
|
|
1691
|
+
"A running stream is re-encoded at `camera_bitrate_kbps` and keeps running. A viewer sees a worse picture rather than none.",
|
|
1692
|
+
"A running stream ends and the viewer is told why. The uplink is then free for datapoints, which is the right trade where video is the nice-to-have."
|
|
1693
|
+
],
|
|
1694
|
+
"type": "string",
|
|
1695
|
+
"enum": [
|
|
1696
|
+
"reduce",
|
|
1697
|
+
"stop"
|
|
1698
|
+
]
|
|
1699
|
+
},
|
|
1700
|
+
"camera_bitrate_kbps": {
|
|
1701
|
+
"description": "Bitrate applied to running streams under `reduce`.",
|
|
1702
|
+
"type": "integer",
|
|
1703
|
+
"minimum": 50,
|
|
1704
|
+
"maximum": 20000
|
|
1705
|
+
}
|
|
1706
|
+
},
|
|
1707
|
+
"additionalProperties": false
|
|
1623
1708
|
}
|
|
1624
1709
|
},
|
|
1625
1710
|
"required": [
|
|
@@ -44,6 +44,11 @@
|
|
|
44
44
|
0.5
|
|
45
45
|
]
|
|
46
46
|
},
|
|
47
|
+
"low_bandwidth": {
|
|
48
|
+
"description": "`keep` exempts this datapoint from the low-bandwidth rate cap; its backfill still pauses.",
|
|
49
|
+
"type": "string",
|
|
50
|
+
"const": "keep"
|
|
51
|
+
},
|
|
47
52
|
"description": {
|
|
48
53
|
"description": "Prose about what this value is, for whoever meets it in the console. It changes nothing the robot does, so a publish that touches only it pushes no configuration at all — but it is carried verbatim into `robot_describe`, where a model that has never seen this robot reads it. The datapoint is offered whenever the role grants it; without one it is offered with `description: null` and the model has less to go on, as for actions, services, publishers and cameras. Omission is the only way to say nothing; an empty string is refused, here and on all five.",
|
|
49
54
|
"examples": [
|
|
@@ -17,6 +17,10 @@
|
|
|
17
17
|
"type": "integer",
|
|
18
18
|
"minimum": 0,
|
|
19
19
|
"maximum": 9007199254740991
|
|
20
|
+
},
|
|
21
|
+
"backfill": {
|
|
22
|
+
"description": "true when the sample was captured while the bridge was disconnected and is being replayed after the reconnect. The cloud keeps such a sample out of its lag measure; absent means live.",
|
|
23
|
+
"type": "boolean"
|
|
20
24
|
}
|
|
21
25
|
},
|
|
22
26
|
"required": [
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
},
|
|
17
17
|
"builtin": {
|
|
18
18
|
"type": "boolean",
|
|
19
|
-
"description": "`true` for the datapoints every robot has — `bridge_state
|
|
19
|
+
"description": "`true` for the datapoints every robot has — `bridge_state` and `robot_details` — and `false` for everything the published configuration adds."
|
|
20
20
|
},
|
|
21
21
|
"unit": {
|
|
22
22
|
"anyOf": [
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
],
|
|
52
52
|
"additionalProperties": false
|
|
53
53
|
},
|
|
54
|
-
"description": "Everything a client may read on this robot: the
|
|
54
|
+
"description": "Everything a client may read on this robot: the two built-ins, plus every datapoint the published configuration exposes and the caller's role grants."
|
|
55
55
|
}
|
|
56
56
|
},
|
|
57
57
|
"required": [
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"slug": {
|
|
6
|
+
"anyOf": [
|
|
7
|
+
{
|
|
8
|
+
"type": "string",
|
|
9
|
+
"minLength": 2,
|
|
10
|
+
"maxLength": 63,
|
|
11
|
+
"pattern": "^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"type": "null"
|
|
15
|
+
}
|
|
16
|
+
],
|
|
17
|
+
"description": "The datapoint to read joint positions from, or `null` to choose none. It must name a whole-message `sensor_msgs/msg/JointState` datapoint of the published configuration; anything else is a `validation_error` naming the rule."
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"required": [
|
|
21
|
+
"slug"
|
|
22
|
+
]
|
|
23
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"joint_state_slug": {
|
|
6
|
+
"anyOf": [
|
|
7
|
+
{
|
|
8
|
+
"type": "string",
|
|
9
|
+
"minLength": 2,
|
|
10
|
+
"maxLength": 63,
|
|
11
|
+
"pattern": "^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"type": "null"
|
|
15
|
+
}
|
|
16
|
+
],
|
|
17
|
+
"description": "The stored mapping after the call, `null` when none is chosen. The same value `assetListResponse.joint_state_slug` carries."
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"required": [
|
|
21
|
+
"joint_state_slug"
|
|
22
|
+
],
|
|
23
|
+
"additionalProperties": false
|
|
24
|
+
}
|
|
@@ -34,11 +34,6 @@
|
|
|
34
34
|
"type": "integer",
|
|
35
35
|
"exclusiveMinimum": 0,
|
|
36
36
|
"maximum": 9007199254740991
|
|
37
|
-
},
|
|
38
|
-
"max_asset_storage_bytes": {
|
|
39
|
-
"type": "integer",
|
|
40
|
-
"minimum": 0,
|
|
41
|
-
"maximum": 9007199254740991
|
|
42
37
|
}
|
|
43
38
|
},
|
|
44
39
|
"required": [
|
|
@@ -47,8 +42,7 @@
|
|
|
47
42
|
"max_end_users",
|
|
48
43
|
"max_retention_bytes",
|
|
49
44
|
"max_retention_writes_per_minute",
|
|
50
|
-
"max_realtime_connections"
|
|
51
|
-
"max_asset_storage_bytes"
|
|
45
|
+
"max_realtime_connections"
|
|
52
46
|
],
|
|
53
47
|
"additionalProperties": false
|
|
54
48
|
},
|
|
@@ -75,11 +69,6 @@
|
|
|
75
69
|
"minimum": 0,
|
|
76
70
|
"maximum": 9007199254740991
|
|
77
71
|
},
|
|
78
|
-
"max_asset_storage_bytes": {
|
|
79
|
-
"type": "integer",
|
|
80
|
-
"minimum": 0,
|
|
81
|
-
"maximum": 9007199254740991
|
|
82
|
-
},
|
|
83
72
|
"max_retention_writes_per_minute": {
|
|
84
73
|
"type": "integer",
|
|
85
74
|
"minimum": 0,
|
|
@@ -31,11 +31,6 @@
|
|
|
31
31
|
"type": "integer",
|
|
32
32
|
"exclusiveMinimum": 0,
|
|
33
33
|
"maximum": 9007199254740991
|
|
34
|
-
},
|
|
35
|
-
"max_asset_storage_bytes": {
|
|
36
|
-
"type": "integer",
|
|
37
|
-
"minimum": 0,
|
|
38
|
-
"maximum": 9007199254740991
|
|
39
34
|
}
|
|
40
35
|
},
|
|
41
36
|
"required": [
|
|
@@ -44,8 +39,7 @@
|
|
|
44
39
|
"max_end_users",
|
|
45
40
|
"max_retention_bytes",
|
|
46
41
|
"max_retention_writes_per_minute",
|
|
47
|
-
"max_realtime_connections"
|
|
48
|
-
"max_asset_storage_bytes"
|
|
42
|
+
"max_realtime_connections"
|
|
49
43
|
],
|
|
50
44
|
"additionalProperties": false
|
|
51
45
|
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"mcp_enabled": {
|
|
6
|
+
"type": "boolean",
|
|
7
|
+
"description": "Whether this app serves an MCP endpoint at `/mcp/<identifier>`. Off refuses the whole OAuth surface for the app, not merely the tool calls, and is re-read on every request rather than cached off a token."
|
|
8
|
+
},
|
|
9
|
+
"mcp_login_url": {
|
|
10
|
+
"anyOf": [
|
|
11
|
+
{
|
|
12
|
+
"type": "string",
|
|
13
|
+
"maxLength": 500
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"type": "null"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"description": "The page an MCP authorization redirects to, with `{interaction}` where the interaction id goes. Not a token: the id names a pending request the server already holds, and the app authenticates the user itself before approving it."
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"required": [
|
|
23
|
+
"mcp_enabled",
|
|
24
|
+
"mcp_login_url"
|
|
25
|
+
],
|
|
26
|
+
"additionalProperties": false
|
|
27
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"self_registration": {
|
|
6
|
+
"type": "boolean",
|
|
7
|
+
"description": "Whether a stranger may create an account in this app. Off refuses `POST /api/client/register` with `403 registration_closed`, and refuses an unknown identity at an OIDC callback with the same reasoning — one switch for one decision, whichever door the person arrives at."
|
|
8
|
+
},
|
|
9
|
+
"allowed_domains": {
|
|
10
|
+
"maxItems": 50,
|
|
11
|
+
"type": "array",
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"minLength": 1,
|
|
15
|
+
"maxLength": 253,
|
|
16
|
+
"pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"
|
|
17
|
+
},
|
|
18
|
+
"description": "The email domains self-registration accepts, lowercase. An empty list means no domain restriction, not \"nobody\" — the switch above is what closes the door. **An invitation always bypasses this**, by password and through a provider alike."
|
|
19
|
+
},
|
|
20
|
+
"allowed_origins": {
|
|
21
|
+
"maxItems": 20,
|
|
22
|
+
"type": "array",
|
|
23
|
+
"items": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"maxLength": 200
|
|
26
|
+
},
|
|
27
|
+
"description": "The origins the client auth API answers CORS for, and the only origins an OIDC `redirect_uri` may name. Bare origins: scheme, host and port, with no path — a browser sends nothing longer, so an entry carrying one could never match."
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"required": [
|
|
31
|
+
"self_registration",
|
|
32
|
+
"allowed_domains",
|
|
33
|
+
"allowed_origins"
|
|
34
|
+
],
|
|
35
|
+
"additionalProperties": false
|
|
36
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"invite_url": {
|
|
6
|
+
"anyOf": [
|
|
7
|
+
{
|
|
8
|
+
"type": "string",
|
|
9
|
+
"maxLength": 500
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"type": "null"
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
"description": "The page in the developer's app that accepts an invitation, with `{token}` where the token goes. `null` when unconfigured, and then an invitation still issues but `send_mail` is refused with `409 target_state_conflict` — there would be nowhere for the link to point."
|
|
16
|
+
},
|
|
17
|
+
"verify_url": {
|
|
18
|
+
"anyOf": [
|
|
19
|
+
{
|
|
20
|
+
"type": "string",
|
|
21
|
+
"maxLength": 500
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"type": "null"
|
|
25
|
+
}
|
|
26
|
+
],
|
|
27
|
+
"description": "The page that confirms a new address, with `{token}` where the token goes. Self-registration needs it: without a page to send people to, a registration would leave an account nobody can activate."
|
|
28
|
+
},
|
|
29
|
+
"reset_url": {
|
|
30
|
+
"anyOf": [
|
|
31
|
+
{
|
|
32
|
+
"type": "string",
|
|
33
|
+
"maxLength": 500
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"type": "null"
|
|
37
|
+
}
|
|
38
|
+
],
|
|
39
|
+
"description": "The page that takes a new password, with `{token}` where the token goes."
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"required": [
|
|
43
|
+
"invite_url",
|
|
44
|
+
"verify_url",
|
|
45
|
+
"reset_url"
|
|
46
|
+
],
|
|
47
|
+
"additionalProperties": false
|
|
48
|
+
}
|
|
@@ -105,6 +105,11 @@
|
|
|
105
105
|
0.5
|
|
106
106
|
]
|
|
107
107
|
},
|
|
108
|
+
"low_bandwidth": {
|
|
109
|
+
"description": "`keep` exempts this datapoint from the low-bandwidth rate cap; its backfill still pauses.",
|
|
110
|
+
"type": "string",
|
|
111
|
+
"const": "keep"
|
|
112
|
+
},
|
|
108
113
|
"description": {
|
|
109
114
|
"description": "Prose about what this value is, for whoever meets it in the console. It changes nothing the robot does, so a publish that touches only it pushes no configuration at all — but it is carried verbatim into `robot_describe`, where a model that has never seen this robot reads it. The datapoint is offered whenever the role grants it; without one it is offered with `description: null` and the model has less to go on, as for actions, services, publishers and cameras. Omission is the only way to say nothing; an empty string is refused, here and on all five.",
|
|
110
115
|
"examples": [
|
|
@@ -425,7 +430,7 @@
|
|
|
425
430
|
}
|
|
426
431
|
]
|
|
427
432
|
},
|
|
428
|
-
"description": "Values the robot publishes, each one field of one topic or a whole topic, and **never several topics**. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
433
|
+
"description": "Values the robot publishes, each one field of one topic or a whole topic, and **never several topics**. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
429
434
|
"defaultSnippets": [
|
|
430
435
|
{
|
|
431
436
|
"label": "a datapoint",
|
|
@@ -673,7 +678,7 @@
|
|
|
673
678
|
}
|
|
674
679
|
]
|
|
675
680
|
},
|
|
676
|
-
"description": "Things the robot does on request that take time, each reported as a job with progress. **At most one job runs per action slug**: a second call is refused `busy`, and every observer of that slug watches the same job. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
681
|
+
"description": "Things the robot does on request that take time, each reported as a job with progress. **At most one job runs per action slug**: a second call is refused `busy`, and every observer of that slug watches the same job. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
677
682
|
"defaultSnippets": [
|
|
678
683
|
{
|
|
679
684
|
"label": "an action",
|
|
@@ -894,7 +899,7 @@
|
|
|
894
899
|
}
|
|
895
900
|
]
|
|
896
901
|
},
|
|
897
|
-
"description": "ROS service calls the robot answers — one request, one reply. Unlike an action a service reports **no progress** and the call returns with its result already on the job, so there is nothing left to observe; a second concurrent call is still refused `busy`, exactly as for an action. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
902
|
+
"description": "ROS service calls the robot answers — one request, one reply. Unlike an action a service reports **no progress** and the call returns with its result already on the job, so there is nothing left to observe; a second concurrent call is still refused `busy`, exactly as for an action. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
898
903
|
"defaultSnippets": [
|
|
899
904
|
{
|
|
900
905
|
"label": "a service",
|
|
@@ -1202,7 +1207,7 @@
|
|
|
1202
1207
|
}
|
|
1203
1208
|
]
|
|
1204
1209
|
},
|
|
1205
|
-
"description": "Topics clients may send to, and where the format's whole safety story lives. The `message` template fixes every value a caller cannot change, and **`failsafe` is required**: once a client falls silent the bridge sends the failsafe message itself, so an operator whose window closed does not leave a robot driving. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
1210
|
+
"description": "Topics clients may send to, and where the format's whole safety story lives. The `message` template fixes every value a caller cannot change, and **`failsafe` is required**: once a client falls silent the bridge sends the failsafe message itself, so an operator whose window closed does not leave a robot driving. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
1206
1211
|
"defaultSnippets": [
|
|
1207
1212
|
{
|
|
1208
1213
|
"label": "a publisher, with its parameters and its failsafe",
|
|
@@ -1586,7 +1591,7 @@
|
|
|
1586
1591
|
}
|
|
1587
1592
|
]
|
|
1588
1593
|
},
|
|
1589
|
-
"description": "Video the robot streams, and the still frames the cloud serves from it. `width`, `height`, `fps` and `bitrate_kbps` are what **the bridge produces before sending**, not what the camera captures — they live in the configuration rather than in a viewer's request precisely so that no viewer can make a robot send more. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state
|
|
1594
|
+
"description": "Video the robot streams, and the still frames the cloud serves from it. `width`, `height`, `fps` and `bitrate_kbps` are what **the bridge produces before sending**, not what the camera captures — they live in the configuration rather than in a viewer's request precisely so that no viewer can make a robot send more. Keys are slugs, one namespace across all five exposure sections, which is what lets a role grant say `{robot, slug}` without naming a kind; `bridge_state` and `robot_details` are built-in, and `history` is reserved because `GET …/jobs/history` would shadow an action of that name; all three are refused when the document is validated.",
|
|
1590
1595
|
"defaultSnippets": [
|
|
1591
1596
|
{
|
|
1592
1597
|
"label": "a camera",
|
|
@@ -1607,6 +1612,86 @@
|
|
|
1607
1612
|
}
|
|
1608
1613
|
}
|
|
1609
1614
|
]
|
|
1615
|
+
},
|
|
1616
|
+
"low_bandwidth": {
|
|
1617
|
+
"description": "Overrides for the bridge's low-bandwidth mode; see the section schema.",
|
|
1618
|
+
"defaultSnippets": [
|
|
1619
|
+
{
|
|
1620
|
+
"label": "low-bandwidth mode, tuned",
|
|
1621
|
+
"description": "Enters after ten seconds above two seconds of lag, caps every datapoint to 1 Hz and lets running streams continue at a reduced bitrate.",
|
|
1622
|
+
"body": {
|
|
1623
|
+
"enter_lag_ms": 2000,
|
|
1624
|
+
"datapoint_max_hz": 1,
|
|
1625
|
+
"camera": "reduce"
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
],
|
|
1629
|
+
"type": "object",
|
|
1630
|
+
"properties": {
|
|
1631
|
+
"mode": {
|
|
1632
|
+
"description": "`auto` decides from the measured lag; `on` and `off` force the mode, for tests and for an operator who knows the link.",
|
|
1633
|
+
"enumDescriptions": [
|
|
1634
|
+
"The bridge enters and leaves the mode on its own, from the lag the cloud reports and the dwell it measures in its own send queue. The setting to leave alone.",
|
|
1635
|
+
"The mode is held on, whatever the link is doing. For a robot on a link known to be poor, and for a test that would otherwise have to wait for a real one.",
|
|
1636
|
+
"The mode never engages, whatever the link is doing. The robot then sends at its configured rates over a link that cannot carry them, which is a choice and not a default."
|
|
1637
|
+
],
|
|
1638
|
+
"type": "string",
|
|
1639
|
+
"enum": [
|
|
1640
|
+
"auto",
|
|
1641
|
+
"on",
|
|
1642
|
+
"off"
|
|
1643
|
+
]
|
|
1644
|
+
},
|
|
1645
|
+
"enter_lag_ms": {
|
|
1646
|
+
"description": "Lag or queue dwell above this enters the mode. Checked against exit_lag_ms only when both are in this document; a lone key composes with the bridge's parameter or the default on the robot, and a crossed pair is refused there when the configuration is applied, so name both when you change either.",
|
|
1647
|
+
"type": "integer",
|
|
1648
|
+
"minimum": 100,
|
|
1649
|
+
"maximum": 9007199254740991
|
|
1650
|
+
},
|
|
1651
|
+
"enter_after_s": {
|
|
1652
|
+
"description": "The entry condition must hold this long.",
|
|
1653
|
+
"type": "integer",
|
|
1654
|
+
"minimum": 1,
|
|
1655
|
+
"maximum": 9007199254740991
|
|
1656
|
+
},
|
|
1657
|
+
"exit_lag_ms": {
|
|
1658
|
+
"description": "Lag and dwell both at or below this leave the mode. Must be at or below enter_lag_ms: a crossed pair is a mode that leaves as it arrives. Checked here only when both keys are present; a lone key is checked on the robot against the parameter or default it composes with.",
|
|
1659
|
+
"type": "integer",
|
|
1660
|
+
"minimum": 0,
|
|
1661
|
+
"maximum": 9007199254740991
|
|
1662
|
+
},
|
|
1663
|
+
"exit_after_s": {
|
|
1664
|
+
"description": "The exit condition must hold this long.",
|
|
1665
|
+
"type": "integer",
|
|
1666
|
+
"minimum": 1,
|
|
1667
|
+
"maximum": 9007199254740991
|
|
1668
|
+
},
|
|
1669
|
+
"datapoint_max_hz": {
|
|
1670
|
+
"description": "The long-run rate for every datapoint in the mode, unless the datapoint says `low_bandwidth: keep`. It is an average, not a minimum gap: after a quiet spell two samples may go out close together, and over any longer window the rate holds.",
|
|
1671
|
+
"type": "number",
|
|
1672
|
+
"exclusiveMinimum": 0,
|
|
1673
|
+
"maximum": 20
|
|
1674
|
+
},
|
|
1675
|
+
"camera": {
|
|
1676
|
+
"description": "What happens to a running stream in the mode. New streams are refused either way.",
|
|
1677
|
+
"enumDescriptions": [
|
|
1678
|
+
"A running stream is re-encoded at `camera_bitrate_kbps` and keeps running. A viewer sees a worse picture rather than none.",
|
|
1679
|
+
"A running stream ends and the viewer is told why. The uplink is then free for datapoints, which is the right trade where video is the nice-to-have."
|
|
1680
|
+
],
|
|
1681
|
+
"type": "string",
|
|
1682
|
+
"enum": [
|
|
1683
|
+
"reduce",
|
|
1684
|
+
"stop"
|
|
1685
|
+
]
|
|
1686
|
+
},
|
|
1687
|
+
"camera_bitrate_kbps": {
|
|
1688
|
+
"description": "Bitrate applied to running streams under `reduce`.",
|
|
1689
|
+
"type": "integer",
|
|
1690
|
+
"minimum": 50,
|
|
1691
|
+
"maximum": 20000
|
|
1692
|
+
}
|
|
1693
|
+
},
|
|
1694
|
+
"additionalProperties": false
|
|
1610
1695
|
}
|
|
1611
1696
|
},
|
|
1612
1697
|
"required": [
|
|
@@ -34,7 +34,8 @@
|
|
|
34
34
|
"asset_bytes_freed": {
|
|
35
35
|
"type": "integer",
|
|
36
36
|
"minimum": 0,
|
|
37
|
-
"maximum": 9007199254740991
|
|
37
|
+
"maximum": 9007199254740991,
|
|
38
|
+
"description": "What the robot's store gives back: every distinct mesh or texture blob it holds, counted once, URDF excluded; a blob another robot also references stays in the object store but is still credited here, because each robot's counter carries it."
|
|
38
39
|
},
|
|
39
40
|
"job_run_count": {
|
|
40
41
|
"type": "integer",
|