RadiationService.openapi.json

{"components":{"schemas":{"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"},"ListRadiationObservationsRequest":{"description":"ListRadiationObservationsRequest specifies optional result limits.","properties":{"maxItems":{"description":"Maximum items to return (1-25). Zero uses the service default.","format":"int32","type":"integer"}},"type":"object"},"ListRadiationObservationsResponse":{"description":"ListRadiationObservationsResponse contains normalized readings plus coverage metadata.","properties":{"anomalyCount":{"description":"Total observations classified above normal.","format":"int32","type":"integer"},"conflictingCount":{"description":"Observations where contributing sources materially disagree.","format":"int32","type":"integer"},"convertedFromCpmCount":{"description":"Observations whose normalized value was derived from CPM.","format":"int32","type":"integer"},"corroboratedCount":{"description":"Observations corroborated by more than one source.","format":"int32","type":"integer"},"elevatedCount":{"description":"Observations classified as elevated.","format":"int32","type":"integer"},"epaCount":{"description":"Number of EPA RadNet observations included.","format":"int32","type":"integer"},"fetchedAt":{"description":"Time the service synthesized the response, as Unix epoch milliseconds.. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"lowConfidenceCount":{"description":"Observations that remain low-confidence after synthesis.","format":"int32","type":"integer"},"observations":{"items":{"$ref":"#/components/schemas/RadiationObservation"},"type":"array"},"safecastCount":{"description":"Number of Safecast observations included.","format":"int32","type":"integer"},"spikeCount":{"description":"Observations classified as spike-level anomalies.","format":"int32","type":"integer"}},"type":"object"},"RadiationObservation":{"description":"RadiationObservation represents a normalized ambient dose-rate reading.","properties":{"baselineValue":{"description":"Rolling baseline for this station in nSv/h.","format":"double","type":"number"},"confidence":{"description":"RadiationConfidence represents how strongly the reading is supported.","enum":["RADIATION_CONFIDENCE_UNSPECIFIED","RADIATION_CONFIDENCE_LOW","RADIATION_CONFIDENCE_MEDIUM","RADIATION_CONFIDENCE_HIGH"],"type":"string"},"conflictingSources":{"description":"Whether contributing sources materially disagree.","type":"boolean"},"contributingSources":{"items":{"description":"RadiationSource identifies the upstream measurement network.","enum":["RADIATION_SOURCE_UNSPECIFIED","RADIATION_SOURCE_EPA_RADNET","RADIATION_SOURCE_SAFECAST"],"type":"string"},"type":"array"},"convertedFromCpm":{"description":"True when the value was converted from CPM using a generic fallback.","type":"boolean"},"corroborated":{"description":"Whether a second source corroborated the observed pattern.","type":"boolean"},"country":{"description":"Country or territory label.","type":"string"},"delta":{"description":"Current reading minus rolling baseline in nSv/h.","format":"double","type":"number"},"freshness":{"description":"RadiationFreshness groups observations by recency.","enum":["RADIATION_FRESHNESS_UNSPECIFIED","RADIATION_FRESHNESS_LIVE","RADIATION_FRESHNESS_RECENT","RADIATION_FRESHNESS_HISTORICAL"],"type":"string"},"id":{"description":"Unique source-specific observation identifier.","maxLength":160,"minLength":1,"type":"string"},"location":{"$ref":"#/components/schemas/GeoCoordinates"},"locationName":{"description":"Human-readable location label.","type":"string"},"observedAt":{"description":"Time the observation was recorded, as Unix epoch milliseconds.. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"severity":{"description":"RadiationSeverity classifies whether a reading is behaving normally.","enum":["RADIATION_SEVERITY_UNSPECIFIED","RADIATION_SEVERITY_NORMAL","RADIATION_SEVERITY_ELEVATED","RADIATION_SEVERITY_SPIKE"],"type":"string"},"source":{"description":"RadiationSource identifies the upstream measurement network.","enum":["RADIATION_SOURCE_UNSPECIFIED","RADIATION_SOURCE_EPA_RADNET","RADIATION_SOURCE_SAFECAST"],"type":"string"},"sourceCount":{"description":"Number of distinct contributing sources.","format":"int32","type":"integer"},"unit":{"description":"Display unit, currently always nSv/h after normalization.","type":"string"},"value":{"description":"Dose equivalent rate normalized to nSv/h.","format":"double","type":"number"},"zScore":{"description":"Standard deviation distance from the rolling baseline.","format":"double","type":"number"}},"required":["id"],"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":"RadiationService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/radiation/v1/list-radiation-observations":{"get":{"description":"ListRadiationObservations retrieves normalized EPA RadNet and Safecast readings.","operationId":"ListRadiationObservations","parameters":[{"description":"Maximum items to return (1-25). Zero uses the service default.","in":"query","name":"max_items","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRadiationObservationsResponse"}}},"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":"ListRadiationObservations","tags":["RadiationService"]}}}}