NaturalService.openapi.json

{"components":{"schemas":{"CoordRing":{"properties":{"points":{"items":{"$ref":"#/components/schemas/Coordinate"},"type":"array"}},"type":"object"},"Coordinate":{"properties":{"lat":{"format":"double","type":"number"},"lon":{"format":"double","type":"number"}},"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"},"ForecastPoint":{"properties":{"category":{"format":"int32","type":"integer"},"hour":{"format":"int32","type":"integer"},"lat":{"format":"double","type":"number"},"lon":{"format":"double","type":"number"},"windKt":{"format":"int32","type":"integer"}},"type":"object"},"ListNaturalEventsRequest":{"properties":{"days":{"format":"int32","type":"integer"}},"type":"object"},"ListNaturalEventsResponse":{"properties":{"events":{"items":{"$ref":"#/components/schemas/NaturalEvent"},"type":"array"}},"type":"object"},"NaturalEvent":{"properties":{"basin":{"type":"string"},"category":{"type":"string"},"categoryTitle":{"type":"string"},"classification":{"type":"string"},"closed":{"type":"boolean"},"conePolygon":{"items":{"$ref":"#/components/schemas/CoordRing"},"type":"array"},"date":{"description":"Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"description":{"type":"string"},"forecastTrack":{"items":{"$ref":"#/components/schemas/ForecastPoint"},"type":"array"},"id":{"type":"string"},"lat":{"format":"double","type":"number"},"lon":{"format":"double","type":"number"},"magnitude":{"format":"double","type":"number"},"magnitudeUnit":{"type":"string"},"movementDir":{"format":"int32","type":"integer"},"movementSpeedKt":{"format":"int32","type":"integer"},"pastTrack":{"items":{"$ref":"#/components/schemas/PastTrackPoint"},"type":"array"},"pressureMb":{"format":"int32","type":"integer"},"sourceName":{"type":"string"},"sourceUrl":{"type":"string"},"stormCategory":{"format":"int32","type":"integer"},"stormId":{"description":"Optional tropical cyclone fields (populated for severeStorms from GDACS TC / NHC)","type":"string"},"stormName":{"type":"string"},"title":{"type":"string"},"windKt":{"format":"int32","type":"integer"}},"type":"object"},"PastTrackPoint":{"properties":{"lat":{"format":"double","type":"number"},"lon":{"format":"double","type":"number"},"timestamp":{"description":"Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"windKt":{"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":"NaturalService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/natural/v1/list-natural-events":{"get":{"operationId":"ListNaturalEvents","parameters":[{"in":"query","name":"days","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNaturalEventsResponse"}}},"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":"ListNaturalEvents","tags":["NaturalService"]}}}}