ref: 876360f046a2ffb85b1471b7a13bbea799acdfde
server/docs/swagger.yaml
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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 |
basePath: / definitions: model.AvailableMetric: properties: description: type: string name: type: string type: object model.EventRequest: properties: etime: type: integer name: type: string type: object model.EventSearchRequest: properties: from: type: integer source: type: string to: type: integer type: object model.MetricRequest: properties: mtime: type: integer name: type: string value: type: string type: object model.MetricSearchRequest: properties: from: type: integer name: type: string source: type: string to: type: integer type: object model.PositionRequest: properties: lat: description: TODO Check parquet types type: number lon: description: TODO Check parquet types type: number name: type: string ptime: type: integer type: object model.PositionSearchRequest: properties: from: type: integer source: type: string to: type: integer type: object externalDocs: description: OpenAPI url: https://swagger.io/resources/open-api/ info: contact: email: info@kevwe.com name: API Support url: https://kevwe.com/message description: Yet Another Time Serie license: name: Affero GPL url: https://www.gnu.org/licenses/agpl-3.0.en.html#license-text termsOfService: https://kevwe.com/ title: Yats Server version: "1.0" paths: /event: post: consumes: - application/json description: store events parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Event body data in: body name: event1 required: true schema: $ref: '#/definitions/model.EventRequest' produces: - application/json responses: "202": description: Accepted schema: type: string summary: write event to db tags: - Events /event/{from}: get: consumes: - application/json description: retrieve events from timestamp {from} parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Event query filters in: body name: event2 required: true schema: $ref: '#/definitions/model.EventSearchRequest' - description: Starting from timestamp :from in: path name: from required: true type: string produces: - application/json responses: "200": description: OK schema: type: string summary: Get the events from timestamp {from} tags: - Events /event/search: post: consumes: - application/json description: retrieve events in the specified time window parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Event query filters in: body name: event2 required: true schema: $ref: '#/definitions/model.EventSearchRequest' produces: - application/json responses: "200": description: OK schema: type: string summary: Get the events From ... and To when present tags: - Events /metric: post: consumes: - application/json description: store metric parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Metric request body in: body name: metric2 required: true schema: $ref: '#/definitions/model.MetricRequest' produces: - application/json responses: "202": description: Accepted schema: type: string summary: write metric to db tags: - Metrics /metric/{name}/{from}: get: description: search metrics after the specified timestamp parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Metric Name :name in: path name: name required: true type: string - description: Starting from epoch :from in: path name: from required: true type: string produces: - application/json responses: "200": description: OK schema: type: string summary: Get the specific metric {name} starting from the epoch {from} tags: - Metrics /metric/search: post: consumes: - application/json description: search metrics in the specified timeframe parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Metric query filters in: body name: metric1 required: true schema: $ref: '#/definitions/model.MetricSearchRequest' produces: - application/json responses: "200": description: OK schema: type: string summary: Get the metrics From ... and To when present tags: - Metrics /perms: get: description: Show available Metrics and Event for current user parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string produces: - application/json responses: "200": description: OK schema: items: $ref: '#/definitions/model.AvailableMetric' type: array summary: Show available Metrics and Event for current user tags: - Permissions /position: post: consumes: - application/json description: store position parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Position body data in: body name: position required: true schema: $ref: '#/definitions/model.PositionRequest' produces: - application/json responses: "202": description: Accepted schema: type: string summary: write position to db tags: - Positions /position/{from}: get: consumes: - application/json description: retrieve positions from timestamp {from} parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Event query filters in: body name: position required: true schema: $ref: '#/definitions/model.PositionSearchRequest' - description: Starting from timestamp :from in: path name: from required: true type: string produces: - application/json responses: "200": description: OK schema: type: string summary: Get the positions from timestamp {from} tags: - Positions /position/search: post: consumes: - application/json description: retrieve positions in the specified time window parameters: - description: clientCN in: header name: X-SSL-Client-CN required: true type: string - description: Position query filters in: body name: position required: true schema: $ref: '#/definitions/model.PositionSearchRequest' produces: - application/json responses: "200": description: OK schema: type: string summary: Get the positions From ... and To when present tags: - Positions swagger: "2.0" |