Verified Commit 7785a061 authored by Dan Jones's avatar Dan Jones
Browse files

fix: remove placeholder comments

...@@ -10,7 +10,7 @@ alert_schema = { ...@@ -10,7 +10,7 @@ alert_schema = {
"example": "alert", "example": "alert",
"enum": ["alert"], "enum": ["alert"],
}, },
"code": { # changed from alert_ID because reasons "code": {
"type": "integer", "type": "integer",
"description": "Alert code", "description": "Alert code",
"example": 345, "example": 345,
...@@ -26,7 +26,7 @@ alert_schema = { ...@@ -26,7 +26,7 @@ alert_schema = {
"description": "Timestamp for onboard platform status message", "description": "Timestamp for onboard platform status message",
"example": "2022-12-21T00:00:00Z", "example": "2022-12-21T00:00:00Z",
}, },
"subsystem": { # changed from suggested "source" could be device / subsystem or something "subsystem": {
"type": "string", "type": "string",
"description": "System that generated the alert", "description": "System that generated the alert",
"example": "Onboard Fault Monitor", "example": "Onboard Fault Monitor",
......
...@@ -170,17 +170,12 @@ platform_status_schema = { ...@@ -170,17 +170,12 @@ platform_status_schema = {
"description": "Battery remaining % provided by respective C2", "description": "Battery remaining % provided by respective C2",
"example": 80.2, "example": 80.2,
}, },
# Battery power (kw / float) "battery_output": {
"battery_output": { # changed from battery_power
"type": "number", "type": "number",
"format": "float", "format": "float",
"description": "Battery output in kW", "description": "Battery output in kW",
"example": 80.2, "example": 80.2,
}, },
# Bunkers remaining capacity (litres, float)
# Bunkers percentage full (percentage, float)
# battery_remaining_capacity is % full if we want both these fields
# these names are going to cause confusion
"fuel_remaining_capacity": { "fuel_remaining_capacity": {
"type": "number", "type": "number",
"format": "float", "format": "float",
...@@ -193,7 +188,6 @@ platform_status_schema = { ...@@ -193,7 +188,6 @@ platform_status_schema = {
"description": "Litres of liquid fuel", "description": "Litres of liquid fuel",
"example": 12.5, "example": 12.5,
}, },
# Endurance (hours, float)
"endurance": { "endurance": {
"type": "number", "type": "number",
"format": "float", "format": "float",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment