worldmonitor/docs/api/SeismologyService.openapi.json

{"components":{"schemas":{"Earthquake":{"description":"Earthquake represents a seismic event from USGS GeoJSON feed.","properties":{"depthKm":{"description":"Depth in kilometers below the surface.","format":"double","type":"number"},"id":{"description":"Unique USGS event identifier (e.g., \"us7000abcd\").","maxLength":100,"minLength":1,"type":"string"},"location":{"$ref":"#/components/schemas/GeoCoordinates"},"magnitude":{"description":"Earthquake magnitude on the Richter scale.","format":"double","type":"number"},"occurredAt":{"description":"Time the earthquake occurred, as Unix epoch milliseconds.. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"place":{"description":"Human-readable place description (e.g., \"10 km SW of Anchorage, Alaska\").","type":"string"},"sourceUrl":{"description":"URL to the USGS event detail page.","type":"string"}},"required":["id"],"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"},"ListEarthquakesRequest":{"description":"ListEarthquakesRequest specifies filters for retrieving earthquake data from USGS.","properties":{"cursor":{"description":"Cursor for next page.","type":"string"},"end":{"description":"End of time range (inclusive), Unix epoch milliseconds.. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"},"minMagnitude":{"description":"Minimum magnitude filter (e.g., 4.0 for significant quakes).","format":"double","type":"number"},"pageSize":{"description":"Maximum items per page (1-100).","format":"int32","type":"integer"},"start":{"description":"Start of time range (inclusive), Unix epoch milliseconds.. Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","type":"integer"}},"type":"object"},"ListEarthquakesResponse":{"description":"ListEarthquakesResponse contains the list of earthquakes matching the request filters.","properties":{"earthquakes":{"items":{"$ref":"#/components/schemas/Earthquake"},"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":"SeismologyService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/seismology/v1/list-earthquakes":{"get":{"description":"ListEarthquakes retrieves recent earthquakes from the USGS GeoJSON feed.","operationId":"ListEarthquakes","parameters":[{"description":"Start of time range (inclusive), Unix epoch milliseconds.","in":"query","name":"start","required":false,"schema":{"format":"int64","type":"string"}},{"description":"End of time range (inclusive), Unix epoch milliseconds.","in":"query","name":"end","required":false,"schema":{"format":"int64","type":"string"}},{"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":"Minimum magnitude filter (e.g., 4.0 for significant quakes).","in":"query","name":"min_magnitude","required":false,"schema":{"format":"double","type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEarthquakesResponse"}}},"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":"ListEarthquakes","tags":["SeismologyService"]}}}}