worldmonitor/docs/api/WebcamService.openapi.yaml at main · gavinlovespython/worldmonitor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
openapi: 3.1.0
info:
    title: WebcamService API
    version: 1.0.0
paths:
    /api/webcam/v1/list-webcams:
        get:
            tags:
                - WebcamService
            summary: ListWebcams
            operationId: ListWebcams
            parameters:
                - name: zoom
                  in: query
                  required: false
                  schema:
                    type: integer
                    format: int32
                - name: bound_w
                  in: query
                  required: false
                  schema:
                    type: number
                    format: double
                - name: bound_s
                  in: query
                  required: false
                  schema:
                    type: number
                    format: double
                - name: bound_e
                  in: query
                  required: false
                  schema:
                    type: number
                    format: double
                - name: bound_n
                  in: query
                  required: false
                  schema:
                    type: number
                    format: double
            responses:
                "200":
                    description: Successful response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ListWebcamsResponse'
                "400":
                    description: Validation error
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ValidationError'
                default:
                    description: Error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Error'
    /api/webcam/v1/get-webcam-image:
        get:
            tags:
                - WebcamService
            summary: GetWebcamImage
            operationId: GetWebcamImage
            parameters:
                - name: webcam_id
                  in: query
                  required: false
                  schema:
                    type: string
            responses:
                "200":
                    description: Successful response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/GetWebcamImageResponse'
                "400":
                    description: Validation error
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ValidationError'
                default:
                    description: Error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Error'
components:
    schemas:
        Error:
            type: object
            properties:
                message:
                    type: string
                    description: Error message (e.g., 'user not found', 'database connection failed')
            description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
        FieldViolation:
            type: object
            properties:
                field:
                    type: string
                    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')
                description:
                    type: string
                    description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
            required:
                - field
                - description
            description: FieldViolation describes a single validation error for a specific field.
        ValidationError:
            type: object
            properties:
                violations:
                    type: array
                    items:
                        $ref: '#/components/schemas/FieldViolation'
                    description: List of validation violations
            required:
                - violations
            description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
        ListWebcamsRequest:
            type: object
            properties:
                zoom:
                    type: integer
                    format: int32
                boundW:
                    type: number
                    format: double
                boundS:
                    type: number
                    format: double
                boundE:
                    type: number
                    format: double
                boundN:
                    type: number
                    format: double
        ListWebcamsResponse:
            type: object
            properties:
                webcams:
                    type: array
                    items:
                        $ref: '#/components/schemas/WebcamEntry'
                clusters:
                    type: array
                    items:
                        $ref: '#/components/schemas/WebcamCluster'
                totalInView:
                    type: integer
                    format: int32
        WebcamEntry:
            type: object
            properties:
                webcamId:
                    type: string
                title:
                    type: string
                lat:
                    type: number
                    format: double
                lng:
                    type: number
                    format: double
                category:
                    type: string
                country:
                    type: string
        WebcamCluster:
            type: object
            properties:
                lat:
                    type: number
                    format: double
                lng:
                    type: number
                    format: double
                count:
                    type: integer
                    format: int32
                categories:
                    type: array
                    items:
                        type: string
        GetWebcamImageRequest:
            type: object
            properties:
                webcamId:
                    type: string
        GetWebcamImageResponse:
            type: object
            properties:
                thumbnailUrl:
                    type: string
                playerUrl:
                    type: string
                title:
                    type: string
                windyUrl:
                    type: string
                lastUpdated:
                    type: string
                    format: int64
                error:
                    type: string