VatNotif-api/swagger.yaml at main · kristiankunc/VatNotif-api · 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
openapi: 3.0.0
info:
    title: VatNotif API
    description: API specification for VatNotif. Provides info about active controllers on the VATSIM network.
    version: 0.2.0
servers:
    - url: https://vatnotif-api.kristn.co.uk/
      description: Main production server
paths:
    /:
        get:
            summary: Get the root endpoint
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    message:
                                        type: string
    /controllers/online:
        get:
            summary: Get online controllers
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Controller"
    /controllers/up:
        get:
            summary: Get new controllers from the latest update cycle (last 15-30 seconds)
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Controller"
    /controllers/down:
        get:
            summary: Get controllers that got offline in the latest update cycle (last 15-30 seconds)
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Controller"

components:
    schemas:
        Controller:
            type: object
            properties:
                cid:
                    type: integer
                    format: int64
                name:
                    type: string
                callsign:
                    type: string
                frequency:
                    type: string