mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-25 17:14:57 +02:00
bb4f8dcb12
* feat(climate): add WMO normals seeding and CO2 monitoring * fix(climate): skip missing normals per-zone and align anomaly tooltip copy * fix(climate): remove normals from bootstrap and harden health/cache key wiring * feat(climate): version anomaly cache to v2, harden seed freshness, and align CO2/normal baselines
270 lines
11 KiB
YAML
270 lines
11 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: ClimateService API
|
|
version: 1.0.0
|
|
paths:
|
|
/api/climate/v1/list-climate-anomalies:
|
|
get:
|
|
tags:
|
|
- ClimateService
|
|
summary: ListClimateAnomalies
|
|
description: ListClimateAnomalies retrieves temperature and precipitation anomalies from ERA5 data.
|
|
operationId: ListClimateAnomalies
|
|
parameters:
|
|
- name: page_size
|
|
in: query
|
|
description: Maximum items per page (1-100).
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
- name: cursor
|
|
in: query
|
|
description: Cursor for next page.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: min_severity
|
|
in: query
|
|
description: Optional filter by anomaly severity.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListClimateAnomaliesResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/climate/v1/get-co2-monitoring:
|
|
get:
|
|
tags:
|
|
- ClimateService
|
|
summary: GetCo2Monitoring
|
|
description: GetCo2Monitoring retrieves seeded NOAA greenhouse gas monitoring data.
|
|
operationId: GetCo2Monitoring
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetCo2MonitoringResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
components:
|
|
schemas:
|
|
Error:
|
|
type: object
|
|
properties:
|
|
message:
|
|
type: string
|
|
description: Error message (e.g., 'user not found', 'database connection failed')
|
|
description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
|
|
FieldViolation:
|
|
type: object
|
|
properties:
|
|
field:
|
|
type: string
|
|
description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
|
|
description:
|
|
type: string
|
|
description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
|
|
required:
|
|
- field
|
|
- description
|
|
description: FieldViolation describes a single validation error for a specific field.
|
|
ValidationError:
|
|
type: object
|
|
properties:
|
|
violations:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FieldViolation'
|
|
description: List of validation violations
|
|
required:
|
|
- violations
|
|
description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
|
|
ListClimateAnomaliesRequest:
|
|
type: object
|
|
properties:
|
|
pageSize:
|
|
type: integer
|
|
format: int32
|
|
description: Maximum items per page (1-100).
|
|
cursor:
|
|
type: string
|
|
description: Cursor for next page.
|
|
minSeverity:
|
|
type: string
|
|
enum:
|
|
- ANOMALY_SEVERITY_UNSPECIFIED
|
|
- ANOMALY_SEVERITY_NORMAL
|
|
- ANOMALY_SEVERITY_MODERATE
|
|
- ANOMALY_SEVERITY_EXTREME
|
|
description: |-
|
|
AnomalySeverity represents the severity of a climate anomaly.
|
|
Maps to existing TS union: 'normal' | 'moderate' | 'extreme'.
|
|
description: ListClimateAnomaliesRequest specifies filters for retrieving climate anomaly data.
|
|
ListClimateAnomaliesResponse:
|
|
type: object
|
|
properties:
|
|
anomalies:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ClimateAnomaly'
|
|
pagination:
|
|
$ref: '#/components/schemas/PaginationResponse'
|
|
description: ListClimateAnomaliesResponse contains the list of climate anomalies.
|
|
ClimateAnomaly:
|
|
type: object
|
|
properties:
|
|
zone:
|
|
type: string
|
|
minLength: 1
|
|
description: Climate zone name (e.g., "Northern Europe", "Sahel").
|
|
location:
|
|
$ref: '#/components/schemas/GeoCoordinates'
|
|
tempDelta:
|
|
type: number
|
|
format: double
|
|
description: Temperature deviation from normal in degrees Celsius.
|
|
precipDelta:
|
|
type: number
|
|
format: double
|
|
description: Precipitation deviation from normal in millimeters.
|
|
severity:
|
|
type: string
|
|
enum:
|
|
- ANOMALY_SEVERITY_UNSPECIFIED
|
|
- ANOMALY_SEVERITY_NORMAL
|
|
- ANOMALY_SEVERITY_MODERATE
|
|
- ANOMALY_SEVERITY_EXTREME
|
|
description: |-
|
|
AnomalySeverity represents the severity of a climate anomaly.
|
|
Maps to existing TS union: 'normal' | 'moderate' | 'extreme'.
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ANOMALY_TYPE_UNSPECIFIED
|
|
- ANOMALY_TYPE_WARM
|
|
- ANOMALY_TYPE_COLD
|
|
- ANOMALY_TYPE_WET
|
|
- ANOMALY_TYPE_DRY
|
|
- ANOMALY_TYPE_MIXED
|
|
description: |-
|
|
AnomalyType represents the type of climate anomaly.
|
|
Maps to existing TS union: 'warm' | 'cold' | 'wet' | 'dry' | 'mixed'.
|
|
period:
|
|
type: string
|
|
minLength: 1
|
|
description: Time period covered (e.g., "2024-W03", "2024-01").
|
|
required:
|
|
- zone
|
|
- period
|
|
description: |-
|
|
ClimateAnomaly represents a temperature or precipitation deviation from historical norms.
|
|
Sourced from Open-Meteo / ERA5 reanalysis data.
|
|
GeoCoordinates:
|
|
type: object
|
|
properties:
|
|
latitude:
|
|
type: number
|
|
maximum: 90
|
|
minimum: -90
|
|
format: double
|
|
description: Latitude in decimal degrees (-90 to 90).
|
|
longitude:
|
|
type: number
|
|
maximum: 180
|
|
minimum: -180
|
|
format: double
|
|
description: Longitude in decimal degrees (-180 to 180).
|
|
description: GeoCoordinates represents a geographic location using WGS84 coordinates.
|
|
PaginationResponse:
|
|
type: object
|
|
properties:
|
|
nextCursor:
|
|
type: string
|
|
description: Cursor for fetching the next page. Empty string indicates no more pages.
|
|
totalCount:
|
|
type: integer
|
|
format: int32
|
|
description: Total count of items matching the query, if known. Zero if the total is unknown.
|
|
description: PaginationResponse contains pagination metadata returned alongside list results.
|
|
GetCo2MonitoringRequest:
|
|
type: object
|
|
GetCo2MonitoringResponse:
|
|
type: object
|
|
properties:
|
|
monitoring:
|
|
$ref: '#/components/schemas/Co2Monitoring'
|
|
Co2Monitoring:
|
|
type: object
|
|
properties:
|
|
currentPpm:
|
|
type: number
|
|
format: double
|
|
yearAgoPpm:
|
|
type: number
|
|
format: double
|
|
annualGrowthRate:
|
|
type: number
|
|
format: double
|
|
preIndustrialBaseline:
|
|
type: number
|
|
format: double
|
|
monthlyAverage:
|
|
type: number
|
|
format: double
|
|
trend12m:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Co2DataPoint'
|
|
methanePpb:
|
|
type: number
|
|
format: double
|
|
nitrousOxidePpb:
|
|
type: number
|
|
format: double
|
|
measuredAt:
|
|
type: string
|
|
format: int64
|
|
station:
|
|
type: string
|
|
Co2DataPoint:
|
|
type: object
|
|
properties:
|
|
month:
|
|
type: string
|
|
ppm:
|
|
type: number
|
|
format: double
|
|
anomaly:
|
|
type: number
|
|
format: double
|
|
description: Year-over-year delta vs same calendar month, in ppm.
|