ambient-local-exporter/api/v1alpha1/weather/weather_service.swagger.json
Ryan D McGuire 15dd74d6ab
All checks were successful
Build and Publish / check-chart (push) Successful in 12s
Build and Publish / helm-release (push) Has been skipped
Build and Publish / release (push) Successful in 4m6s
implement lightning_time in grpc
2025-04-03 15:31:43 -04:00

328 lines
7.3 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "weather/weather_service.proto",
"version": "version not set"
},
"tags": [
{
"name": "AmbientLocalWeatherService"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/count": {
"get": {
"operationId": "AmbientLocalWeatherService_CountWeatherUpdates",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/weatherCountWeatherUpdatesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "opts.stationName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "opts.stationType",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AmbientLocalWeatherService"
]
}
},
"/v1/weather": {
"get": {
"operationId": "AmbientLocalWeatherService_GetWeather",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/weatherGetWeatherResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "opts.stationName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "opts.stationType",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"AmbientLocalWeatherService"
]
}
}
},
"definitions": {
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
},
"weatherBatteryStatus": {
"type": "object",
"properties": {
"component": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
}
},
"title": "Represents battery status for different components"
},
"weatherCountWeatherUpdatesResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
}
}
},
"weatherGetWeatherOpts": {
"type": "object",
"properties": {
"stationName": {
"type": "string"
},
"stationType": {
"type": "string"
}
}
},
"weatherGetWeatherResponse": {
"type": "object",
"properties": {
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"weatherUpdates": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/weatherWeatherUpdate"
}
}
}
},
"weatherTempHumiditySensor": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tempF": {
"type": "number",
"format": "double"
},
"humidity": {
"type": "integer",
"format": "int32"
}
},
"title": "Represents a temperature and humidity sensor"
},
"weatherWeatherUpdate": {
"type": "object",
"properties": {
"stationName": {
"type": "string"
},
"stationType": {
"type": "string"
},
"stationId": {
"type": "string"
},
"tempOutdoorF": {
"type": "number",
"format": "double"
},
"tempIndoorF": {
"type": "number",
"format": "double"
},
"humidityOutdoor": {
"type": "integer",
"format": "int32"
},
"humidityIndoor": {
"type": "integer",
"format": "int32"
},
"windSpeedMph": {
"type": "number",
"format": "double"
},
"windGustMph": {
"type": "number",
"format": "double"
},
"maxDailyGust": {
"type": "number",
"format": "double"
},
"windDir": {
"type": "integer",
"format": "int32"
},
"windDirAvg10m": {
"type": "integer",
"format": "int32"
},
"uv": {
"type": "integer",
"format": "int32"
},
"solarRadiation": {
"type": "number",
"format": "double"
},
"hourlyRainIn": {
"type": "number",
"format": "double"
},
"eventRainIn": {
"type": "number",
"format": "double"
},
"dailyRainIn": {
"type": "number",
"format": "double"
},
"weeklyRainIn": {
"type": "number",
"format": "double"
},
"monthlyRainIn": {
"type": "number",
"format": "double"
},
"yearlyRainIn": {
"type": "number",
"format": "double"
},
"totalRainIn": {
"type": "number",
"format": "double"
},
"batteries": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/weatherBatteryStatus"
}
},
"baromRelativeIn": {
"type": "number",
"format": "double"
},
"baromAbsoluteIn": {
"type": "number",
"format": "double"
},
"dewPointF": {
"type": "number",
"format": "double"
},
"windChillF": {
"type": "number",
"format": "double"
},
"tempHumiditySensors": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/weatherTempHumiditySensor"
}
},
"updateTimestamp": {
"type": "string",
"format": "date-time"
},
"lightningDay": {
"type": "integer",
"format": "int32"
},
"lightningDistance": {
"type": "integer",
"format": "int32"
},
"lightningLastTime": {
"type": "string",
"format": "date-time"
}
}
}
}
}