dawarich/swagger/v1/swagger.yaml
2024-05-25 13:26:56 +02:00

188 lines
5.1 KiB
YAML

---
openapi: 3.0.1
info:
title: API V1
version: v1
paths:
"/api/v1/overland/batches":
post:
summary: Creates a batch of points
tags:
- Batches
parameters:
- name: api_key
in: query
required: true
description: API Key
schema:
type: string
responses:
'201':
description: Batch of points created
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
geometry:
type: object
properties:
type:
type: string
coordinates:
type: array
properties:
type: object
properties:
timestamp:
type: string
altitude:
type: number
speed:
type: number
horizontal_accuracy:
type: number
vertical_accuracy:
type: number
motion:
type: array
pauses:
type: boolean
activity:
type: string
desired_accuracy:
type: number
deferred:
type: number
significant_change:
type: string
locations_in_payload:
type: number
device_id:
type: string
wifi:
type: string
battery_state:
type: string
battery_level:
type: number
required:
- geometry
- properties
examples:
'0':
summary: Creates a batch of points
value:
locations:
- type: Feature
geometry:
type: Point
coordinates:
- 13.356718
- 52.502397
properties:
timestamp: '2021-06-01T12:00:00Z'
altitude: 0
speed: 0
horizontal_accuracy: 0
vertical_accuracy: 0
motion: []
pauses: false
activity: unknown
desired_accuracy: 0
deferred: 0
significant_change: unknown
locations_in_payload: 1
device_id: Swagger
wifi: unknown
battery_state: unknown
battery_level: 0
"/api/v1/points":
post:
summary: Creates a point
tags:
- Points
parameters: []
responses:
'200':
description: invalid request
requestBody:
content:
application/json:
schema:
type: object
properties:
acc:
type: number
alt:
type: number
batt:
type: number
bs:
type: number
cog:
type: number
lat:
type: string
format: decimal
lon:
type: string
format: decimal
rad:
type: number
t:
type: string
tid:
type: string
tst:
type: number
vac:
type: number
vel:
type: number
p:
type: string
format: decimal
poi:
type: string
conn:
type: string
tag:
type: string
topic:
type: string
inregions:
type: array
SSID:
type: string
BSSID:
type: string
created_at:
type: string
inrids:
type: array
m:
type: number
required:
- lat
- lon
- tid
- tst
examples:
'0':
summary: Creates a point
value:
lat: 52.502397
lon: 13.356718
tid: Swagger
tst: 1716636414
servers:
- url: http://{defaultHost}
variables:
defaultHost:
default: localhost:3000