telebyte-robot/docs/openapi.yaml at main · massivebugs/telebyte-robot · 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
openapi: "3.0.3"

info:
  title: telebyte-robot
  version: 1.0.0

servers:
- url: "http://telebyte.local"

paths:
  /api/ping:
    get:
      description: ping pong back a passthrough message
      parameters:
        - name: msg
          in: query
          example: foo
          description: Message to include in the ping response
          required: false
          schema:
            type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  pong:
                    type: string
                    description: What you passed in <msg> param
                    example: OK
  /api/command:
    post:
      description: Send a debug command
      requestBody:
              required: true
              content:
                application/json:
                  schema:
                    type: object
                    properties:
                      c:
                        type: string
                        description: command name + args (space delimited)
                        example: somecommand arg1 arg2
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: OK or FAIL
                    example: OK
  /api/config:
    get:
      description: Get the current configurations of the robot
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object