Browse Source

added API specification

Come 7 years ago
parent
commit
73c904805d
1 changed files with 105 additions and 0 deletions
  1. 105 0
      API.md

+ 105 - 0
API.md View File

@@ -5,6 +5,26 @@
5 5
 APi not actually implement authentication method. You must use cookies set by
6 6
 frontend login.
7 7
 
8
+### List
9
+
10
+    GET /api/timezone/
11
+
12
+Return list of all timezone available when creating a user
13
+
14
+#### Response
15
+
16
+    {
17
+      "value_list": [
18
+        "Africa/Abidjan",
19
+        "Africa/Accra",
20
+        "Africa/Addis_Ababa",
21
+        "Africa/Algiers",
22
+        "Africa/Asmara",
23
+        ...
24
+      ]
25
+    }
26
+
27
+
8 28
 ## Workspaces
9 29
 
10 30
 ### List
@@ -32,6 +52,91 @@ Return list of workspaces acessible by current connected user.
32 52
        ]
33 53
     }
34 54
 
55
+## Users
56
+
57
+### List
58
+
59
+    GET /api/users/
60
+
61
+Return list of all users of the tracim instance
62
+
63
+#### Response
64
+
65
+    {
66
+      "value_list": [
67
+        {
68
+          "id": 0,
69
+          "name": "Georges Abitbol",
70
+          "email": "g.abitbol@laclasse.com",
71
+          "canCreateWs": true,
72
+          "isAdmin": true,
73
+          "config": {
74
+            "sendEmailNotif": true
75
+          }
76
+        }, {
77
+          "id": 145,
78
+          "name": "Peter",
79
+          "email": "peter@laclasse.com",
80
+          "canCreateWs": false,
81
+          "isAdmin": false,
82
+          "config": {
83
+            "sendEmailNotif": false
84
+        }
85
+      ]
86
+    }
87
+
88
+## Users_Workspace (Role)
89
+
90
+### List
91
+
92
+    GET /api/users_workspace/
93
+
94
+Return list of all roles of all workspaces the connected user has access to
95
+
96
+#### Response
97
+
98
+    {
99
+      "value_list": [
100
+        {
101
+          "userId": 0,
102
+          "workspaceId": 1,
103
+          "roleId": 8,
104
+          "subscribedNotif": true
105
+        }, {
106
+          "userId": 2,
107
+          "workspaceId": 2,
108
+          "roleId": 2,
109
+          "subscribedNotif": true
110
+        }, {
111
+          "userId": 5,
112
+          "workspaceId": 3,
113
+          "roleId": 4,
114
+          "subscribedNotif": false
115
+        }
116
+      ]
117
+    }
118
+
119
+## Timezone
120
+
121
+### List
122
+
123
+    GET /api/timezone/
124
+
125
+Return list of all timezone available when creating a user
126
+
127
+#### Response
128
+
129
+    {
130
+      "value_list": [
131
+        "Africa/Abidjan",
132
+        "Africa/Accra",
133
+        "Africa/Addis_Ababa",
134
+        "Africa/Algiers",
135
+        "Africa/Asmara",
136
+        ...
137
+      ]
138
+    }
139
+
35 140
 ## Calendars
36 141
 
37 142
 ### List