forked from koala73/worldmonitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathThermalService.openapi.json
More file actions
1 lines (1 loc) · 4.97 KB
/
ThermalService.openapi.json
File metadata and controls
1 lines (1 loc) · 4.97 KB
1
{"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"},"ListThermalEscalationsRequest":{"properties":{"maxItems":{"format":"int32","type":"integer"}},"type":"object"},"ListThermalEscalationsResponse":{"properties":{"clusters":{"items":{"$ref":"#/components/schemas/ThermalEscalationCluster"},"type":"array"},"fetchedAt":{"type":"string"},"observationWindowHours":{"format":"int32","type":"integer"},"sourceVersion":{"type":"string"},"summary":{"$ref":"#/components/schemas/ThermalEscalationSummary"}},"type":"object"},"ThermalEscalationCluster":{"properties":{"avgBrightness":{"format":"double","type":"number"},"baselineExpectedCount":{"format":"double","type":"number"},"baselineExpectedFrp":{"format":"double","type":"number"},"centroid":{"$ref":"#/components/schemas/GeoCoordinates"},"confidence":{"enum":["THERMAL_CONFIDENCE_UNSPECIFIED","THERMAL_CONFIDENCE_LOW","THERMAL_CONFIDENCE_MEDIUM","THERMAL_CONFIDENCE_HIGH"],"type":"string"},"context":{"enum":["THERMAL_CONTEXT_UNSPECIFIED","THERMAL_CONTEXT_WILDLAND","THERMAL_CONTEXT_URBAN_EDGE","THERMAL_CONTEXT_INDUSTRIAL","THERMAL_CONTEXT_ENERGY_ADJACENT","THERMAL_CONTEXT_CONFLICT_ADJACENT","THERMAL_CONTEXT_LOGISTICS_ADJACENT","THERMAL_CONTEXT_MIXED"],"type":"string"},"countDelta":{"format":"double","type":"number"},"countryCode":{"type":"string"},"countryName":{"type":"string"},"firstDetectedAt":{"type":"string"},"frpDelta":{"format":"double","type":"number"},"id":{"type":"string"},"lastDetectedAt":{"type":"string"},"maxBrightness":{"format":"double","type":"number"},"maxFrp":{"format":"double","type":"number"},"narrativeFlags":{"items":{"type":"string"},"type":"array"},"nearbyAssets":{"items":{"type":"string"},"type":"array"},"nightDetectionShare":{"format":"double","type":"number"},"observationCount":{"format":"int32","type":"integer"},"persistenceHours":{"format":"double","type":"number"},"regionLabel":{"type":"string"},"status":{"enum":["THERMAL_STATUS_UNSPECIFIED","THERMAL_STATUS_NORMAL","THERMAL_STATUS_ELEVATED","THERMAL_STATUS_SPIKE","THERMAL_STATUS_PERSISTENT"],"type":"string"},"strategicRelevance":{"enum":["THERMAL_RELEVANCE_UNSPECIFIED","THERMAL_RELEVANCE_LOW","THERMAL_RELEVANCE_MEDIUM","THERMAL_RELEVANCE_HIGH"],"type":"string"},"totalFrp":{"format":"double","type":"number"},"uniqueSourceCount":{"format":"int32","type":"integer"},"zScore":{"format":"double","type":"number"}},"type":"object"},"ThermalEscalationSummary":{"properties":{"clusterCount":{"format":"int32","type":"integer"},"conflictAdjacentCount":{"format":"int32","type":"integer"},"elevatedCount":{"format":"int32","type":"integer"},"highRelevanceCount":{"format":"int32","type":"integer"},"persistentCount":{"format":"int32","type":"integer"},"spikeCount":{"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":"ThermalService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/thermal/v1/list-thermal-escalations":{"get":{"operationId":"ListThermalEscalations","parameters":[{"in":"query","name":"max_items","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThermalEscalationsResponse"}}},"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":"ListThermalEscalations","tags":["ThermalService"]}}}}