rase_api/api_documentation.json at dev · orted-org/rase_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
{
    "/auth": {
        "/login (POST)": {
            "body": {
                "idToken": "obtained id token from the google OAuth"
            },
            "res": {
                "status": 200,
                "content": "user details"
            },
            "error": {
                "400": "no Id Token Found in request",
                "401": "id token expired",
                "422": "email not allowed",
                "500": "internal server error"
            }
        },
        "/login (GET)": {
            "res": {
                "status": 200,
                "content": "user details"
            },
            "error": {
                "401": "No session found or session expired or the user is wait listed"
            }
        },
        "/logout (DELETE)": {
            "res": {
                "status": 200,
                "message": "logged out"
            },
            "error": {
                "401": "Unauthorized"
            }
        }
    },
    "/team" : {
        "/create (POST)" : {
            "body" : {
                "teamName" : "team name",
                "teamDescription" : "team description"
            },
            "res" : {
                "status" : 201,
                "message" : "Team Created Successfully"
            },
            "error" : {
                "400" : "invalid team name/invalid team description",
                "405" : "Data already present",
                "500": "internal server error"
            }
        },
        "/join (POST)" : {
            "body" : {
                "teamId" : "team UUID"
            },
            "res" : {
                "status" : 201,
                "message" : "Team Join Successfully"
            },
            "error" : {
                "400" : "invalid team id",
                "405" : "Data already present",
                "500": "internal server error"
            }
        }
    }
}