control-panel-api/swagger.json at master · Yonder-Dynamics/control-panel-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
{
    "swagger": "2.0",
    "info": {
        "title": "Rover Control Panel",
        "description": "Backend server for rover control panel.",
        "version": "0.1"
    },
    "servers": [],
    "basePath": "/ctrl",
    "schemes": ["http", "https"],
    "paths": {
        "/drive/joystick": {
            "summary": "",
            "description": "Drive the rover using a joystick.",
            "post": {
                "operationId": "joystick_drive",
                "x-swagger-router-controller": "swagger_server.controllers.joystick",
                "responses": {
                    "200": {
                        "description": "Successfully recieved joystick data."
                    }
                },
                "consumes": ["application/json"],
                "parameters": [
                    {
                        "name": "joystick",
                        "required": true,
                        "in": "body",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "angle": {
                                    "description": "The angle of the joystick, in radians",
                                    "type": "number",
                                    "format": "float"
                                },
                                "magnitude": {
                                    "description": "The displacement of the joystick, in [0.0, 1.0].",
                                    "type": "number",
                                    "format": "float"
                                }
                            }
                        }
                    }
                ]
            }
        },
        "/kill": {
            "summary": "Soft kill the rover.",
            "description": "Stop sending commands to motors.",
            "post": {
                "operationId": "kill_rover",
                "x-swagger-router-controller": "swagger_server.controllers.kill_rover",
                "responses": {
                    "200": {
                        "description": "Dispatched kill message."
                    }
                }
            }
        }
    }
}