ClimateService.openapi.json

{"components":{"schemas":{"ClimateAnomaly":{"description":"ClimateAnomaly represents a temperature or precipitation deviation from historical norms.\n Sourced from Open-Meteo / ERA5 reanalysis data.","properties":{"location":{"$ref":"#/components/schemas/GeoCoordinates"},"period":{"description":"Time period covered (e.g., \"2024-W03\", \"2024-01\").","minLength":1,"type":"string"},"precipDelta":{"description":"Precipitation deviation from normal as a percentage.","format":"double","type":"number"},"severity":{"description":"AnomalySeverity represents the severity of a climate anomaly.\n Maps to existing TS union: 'normal' | 'moderate' | 'extreme'.","enum":["ANOMALY_SEVERITY_UNSPECIFIED","ANOMALY_SEVERITY_NORMAL","ANOMALY_SEVERITY_MODERATE","ANOMALY_SEVERITY_EXTREME"],"type":"string"},"tempDelta":{"description":"Temperature deviation from normal in degrees Celsius.","format":"double","type":"number"},"type":{"description":"AnomalyType represents the type of climate anomaly.\n Maps to existing TS union: 'warm' | 'cold' | 'wet' | 'dry' | 'mixed'.","enum":["ANOMALY_TYPE_UNSPECIFIED","ANOMALY_TYPE_WARM","ANOMALY_TYPE_COLD","ANOMALY_TYPE_WET","ANOMALY_TYPE_DRY","ANOMALY_TYPE_MIXED"],"type":"string"},"zone":{"description":"Climate zone name (e.g., \"Northern Europe\", \"Sahel\").","minLength":1,"type":"string"}},"required":["zone","period"],"type":"object"},"Error":{"description":"Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.","properties":{"message":{"description":"Error message (e.g., 'user not found', 'database connection failed')","type":"string"}},"type":"object"},"FieldViolation":{"description":"FieldViolation describes a single validation error for a specific field.","properties":{"description":{"description":"Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')","type":"string"},"field":{"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')","type":"string"}},"required":["field","description"],"type":"object"},"GeoCoordinates":{"description":"GeoCoordinates represents a geographic location using WGS84 coordinates.","properties":{"latitude":{"description":"Latitude in decimal degrees (-90 to 90).","format":"double","maximum":90,"minimum":-90,"type":"number"},"longitude":{"description":"Longitude in decimal degrees (-180 to 180).","format":"double","maximum":180,"minimum":-180,"type":"number"}},"type":"object"},"ListClimateAnomaliesRequest":{"description":"ListClimateAnomaliesRequest specifies filters for retrieving climate anomaly data.","properties":{"cursor":{"description":"Cursor for next page.","type":"string"},"minSeverity":{"description":"AnomalySeverity represents the severity of a climate anomaly.\n Maps to existing TS union: 'normal' | 'moderate' | 'extreme'.","enum":["ANOMALY_SEVERITY_UNSPECIFIED","ANOMALY_SEVERITY_NORMAL","ANOMALY_SEVERITY_MODERATE","ANOMALY_SEVERITY_EXTREME"],"type":"string"},"pageSize":{"description":"Maximum items per page (1-100).","format":"int32","type":"integer"}},"type":"object"},"ListClimateAnomaliesResponse":{"description":"ListClimateAnomaliesResponse contains the list of climate anomalies.","properties":{"anomalies":{"items":{"$ref":"#/components/schemas/ClimateAnomaly"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}},"type":"object"},"PaginationResponse":{"description":"PaginationResponse contains pagination metadata returned alongside list results.","properties":{"nextCursor":{"description":"Cursor for fetching the next page. Empty string indicates no more pages.","type":"string"},"totalCount":{"description":"Total count of items matching the query, if known. Zero if the total is unknown.","format":"int32","type":"integer"}},"type":"object"},"ValidationError":{"description":"ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.","properties":{"violations":{"description":"List of validation violations","items":{"$ref":"#/components/schemas/FieldViolation"},"type":"array"}},"required":["violations"],"type":"object"}}},"info":{"title":"ClimateService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/climate/v1/list-climate-anomalies":{"get":{"description":"ListClimateAnomalies retrieves temperature and precipitation anomalies from ERA5 data.","operationId":"ListClimateAnomalies","parameters":[{"description":"Maximum items per page (1-100).","in":"query","name":"page_size","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Cursor for next page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Optional filter by anomaly severity.","in":"query","name":"min_severity","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClimateAnomaliesResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Error response"}},"summary":"ListClimateAnomalies","tags":["ClimateService"]}}}}