WebcamService.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"},"GetWebcamImageRequest":{"properties":{"webcamId":{"type":"string"}},"type":"object"},"GetWebcamImageResponse":{"properties":{"error":{"type":"string"},"lastUpdated":{"format":"int64","type":"string"},"playerUrl":{"type":"string"},"thumbnailUrl":{"type":"string"},"title":{"type":"string"},"windyUrl":{"type":"string"}},"type":"object"},"ListWebcamsRequest":{"properties":{"boundE":{"format":"double","type":"number"},"boundN":{"format":"double","type":"number"},"boundS":{"format":"double","type":"number"},"boundW":{"format":"double","type":"number"},"zoom":{"format":"int32","type":"integer"}},"type":"object"},"ListWebcamsResponse":{"properties":{"clusters":{"items":{"$ref":"#/components/schemas/WebcamCluster"},"type":"array"},"totalInView":{"format":"int32","type":"integer"},"webcams":{"items":{"$ref":"#/components/schemas/WebcamEntry"},"type":"array"}},"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"},"WebcamCluster":{"properties":{"categories":{"items":{"type":"string"},"type":"array"},"count":{"format":"int32","type":"integer"},"lat":{"format":"double","type":"number"},"lng":{"format":"double","type":"number"}},"type":"object"},"WebcamEntry":{"properties":{"category":{"type":"string"},"country":{"type":"string"},"lat":{"format":"double","type":"number"},"lng":{"format":"double","type":"number"},"title":{"type":"string"},"webcamId":{"type":"string"}},"type":"object"}}},"info":{"title":"WebcamService API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/webcam/v1/get-webcam-image":{"get":{"operationId":"GetWebcamImage","parameters":[{"in":"query","name":"webcam_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebcamImageResponse"}}},"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":"GetWebcamImage","tags":["WebcamService"]}},"/api/webcam/v1/list-webcams":{"get":{"operationId":"ListWebcams","parameters":[{"in":"query","name":"zoom","required":false,"schema":{"format":"int32","type":"integer"}},{"in":"query","name":"bound_w","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"bound_s","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"bound_e","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"bound_n","required":false,"schema":{"format":"double","type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebcamsResponse"}}},"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":"ListWebcams","tags":["WebcamService"]}}}}