forked from koala73/worldmonitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPositiveEventsService.openapi.json
More file actions
1 lines (1 loc) · 2.48 KB
/
PositiveEventsService.openapi.json
File metadata and controls
1 lines (1 loc) · 2.48 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"},"ListPositiveGeoEventsRequest":{"type":"object"},"ListPositiveGeoEventsResponse":{"properties":{"events":{"items":{"$ref":"#/components/schemas/PositiveGeoEvent"},"type":"array"}},"type":"object"},"PositiveGeoEvent":{"properties":{"category":{"type":"string"},"count":{"format":"int32","type":"integer"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"name":{"type":"string"},"timestamp":{"description":"Warning: Values \u003e 2^53 may lose precision in JavaScript","format":"int64","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":"PositiveEventsService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/positive-events/v1/list-positive-geo-events":{"get":{"description":"ListPositiveGeoEvents retrieves geocoded positive news events from GDELT GEO API.","operationId":"ListPositiveGeoEvents","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPositiveGeoEventsResponse"}}},"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":"ListPositiveGeoEvents","tags":["PositiveEventsService"]}}}}