Commit d3b8952f8fb067afe89f08eadbae7733c0cc6824
1 parent
b48852e7
Exists in
master
and in
4 other branches
Add username to User and UserBasic entities in API and in examples in doc.
Showing
8 changed files
with
28 additions
and
2 deletions
Show diff stats
doc/api/issues.md
... | ... | @@ -18,6 +18,7 @@ GET /issues |
18 | 18 | "assignee": null, |
19 | 19 | "author": { |
20 | 20 | "id": 1, |
21 | + "username": "john_smith", | |
21 | 22 | "email": "john@example.com", |
22 | 23 | "name": "John Smith", |
23 | 24 | "blocked": false, |
... | ... | @@ -46,6 +47,7 @@ GET /issues |
46 | 47 | }, |
47 | 48 | "assignee": { |
48 | 49 | "id": 2, |
50 | + "username": "jack_smith", | |
49 | 51 | "email": "jack@example.com", |
50 | 52 | "name": "Jack Smith", |
51 | 53 | "blocked": false, |
... | ... | @@ -53,6 +55,7 @@ GET /issues |
53 | 55 | }, |
54 | 56 | "author": { |
55 | 57 | "id": 1, |
58 | + "username": "john_smith", | |
56 | 59 | "email": "john@example.com", |
57 | 60 | "name": "John Smith", |
58 | 61 | "blocked": false, |
... | ... | @@ -110,6 +113,7 @@ Parameters: |
110 | 113 | }, |
111 | 114 | "assignee": { |
112 | 115 | "id": 2, |
116 | + "username": "jack_smith", | |
113 | 117 | "email": "jack@example.com", |
114 | 118 | "name": "Jack Smith", |
115 | 119 | "blocked": false, |
... | ... | @@ -117,6 +121,7 @@ Parameters: |
117 | 121 | }, |
118 | 122 | "author": { |
119 | 123 | "id": 1, |
124 | + "username": "john_smith", | |
120 | 125 | "email": "john@example.com", |
121 | 126 | "name": "John Smith", |
122 | 127 | "blocked": false, | ... | ... |
doc/api/merge_requests.md
... | ... | @@ -22,6 +22,7 @@ Parameters: |
22 | 22 | "merged":false, |
23 | 23 | "author":{ |
24 | 24 | "id":1, |
25 | + "username": "admin", | |
25 | 26 | "email":"admin@local.host", |
26 | 27 | "name":"Administrator", |
27 | 28 | "blocked":false, |
... | ... | @@ -29,6 +30,7 @@ Parameters: |
29 | 30 | }, |
30 | 31 | "assignee":{ |
31 | 32 | "id":1, |
33 | + "username": "admin", | |
32 | 34 | "email":"admin@local.host", |
33 | 35 | "name":"Administrator", |
34 | 36 | "blocked":false, |
... | ... | @@ -62,6 +64,7 @@ Parameters: |
62 | 64 | "merged":false, |
63 | 65 | "author":{ |
64 | 66 | "id":1, |
67 | + "username": "admin", | |
65 | 68 | "email":"admin@local.host", |
66 | 69 | "name":"Administrator", |
67 | 70 | "blocked":false, |
... | ... | @@ -69,6 +72,7 @@ Parameters: |
69 | 72 | }, |
70 | 73 | "assignee":{ |
71 | 74 | "id":1, |
75 | + "username": "admin", | |
72 | 76 | "email":"admin@local.host", |
73 | 77 | "name":"Administrator", |
74 | 78 | "blocked":false, |
... | ... | @@ -105,6 +109,7 @@ Parameters: |
105 | 109 | "merged":false, |
106 | 110 | "author":{ |
107 | 111 | "id":1, |
112 | + "username": "admin", | |
108 | 113 | "email":"admin@local.host", |
109 | 114 | "name":"Administrator", |
110 | 115 | "blocked":false, |
... | ... | @@ -112,6 +117,7 @@ Parameters: |
112 | 117 | }, |
113 | 118 | "assignee":{ |
114 | 119 | "id":1, |
120 | + "username": "admin", | |
115 | 121 | "email":"admin@local.host", |
116 | 122 | "name":"Administrator", |
117 | 123 | "blocked":false, |
... | ... | @@ -150,6 +156,7 @@ Parameters: |
150 | 156 | "merged":false, |
151 | 157 | "author":{ |
152 | 158 | "id":1, |
159 | + "username": "admin", | |
153 | 160 | "email":"admin@local.host", |
154 | 161 | "name":"Administrator", |
155 | 162 | "blocked":false, |
... | ... | @@ -157,6 +164,7 @@ Parameters: |
157 | 164 | }, |
158 | 165 | "assignee":{ |
159 | 166 | "id":1, |
167 | + "username": "admin", | |
160 | 168 | "email":"admin@local.host", |
161 | 169 | "name":"Administrator", |
162 | 170 | "blocked":false, |
... | ... | @@ -184,6 +192,7 @@ Will return created note with status `201 Created` on success, or `404 Not found |
184 | 192 | { |
185 | 193 | "author":{ |
186 | 194 | "id":1, |
195 | + "username": "admin", | |
187 | 196 | "email":"admin@local.host", |
188 | 197 | "name":"Administrator", |
189 | 198 | "blocked":false, | ... | ... |
doc/api/notes.md
doc/api/projects.md
... | ... | @@ -17,6 +17,7 @@ GET /projects |
17 | 17 | "default_branch": "master", |
18 | 18 | "owner": { |
19 | 19 | "id": 1, |
20 | + "username": "john_smith", | |
20 | 21 | "email": "john@example.com", |
21 | 22 | "name": "John Smith", |
22 | 23 | "blocked": false, |
... | ... | @@ -38,6 +39,7 @@ GET /projects |
38 | 39 | "default_branch": "api", |
39 | 40 | "owner": { |
40 | 41 | "id": 1, |
42 | + "username": "john_smith", | |
41 | 43 | "email": "john@example.com", |
42 | 44 | "name": "John Smith", |
43 | 45 | "blocked": false, |
... | ... | @@ -75,6 +77,7 @@ Parameters: |
75 | 77 | "default_branch": "api", |
76 | 78 | "owner": { |
77 | 79 | "id": 1, |
80 | + "username": "john_smith", | |
78 | 81 | "email": "john@example.com", |
79 | 82 | "name": "John Smith", |
80 | 83 | "blocked": false, |
... | ... | @@ -141,6 +144,7 @@ Parameters: |
141 | 144 | { |
142 | 145 | |
143 | 146 | "id": 1, |
147 | + "username": "john_smith", | |
144 | 148 | "email": "john@example.com", |
145 | 149 | "name": "John Smith", |
146 | 150 | "blocked": false, | ... | ... |
doc/api/session.md
doc/api/snippets.md
doc/api/users.md
... | ... | @@ -10,6 +10,7 @@ GET /users |
10 | 10 | [ |
11 | 11 | { |
12 | 12 | "id": 1, |
13 | + "username": "john_smith", | |
13 | 14 | "email": "john@example.com", |
14 | 15 | "name": "John Smith", |
15 | 16 | "blocked": false, |
... | ... | @@ -23,6 +24,7 @@ GET /users |
23 | 24 | }, |
24 | 25 | { |
25 | 26 | "id": 2, |
27 | + "username": "jack_smith", | |
26 | 28 | "email": "jack@example.com", |
27 | 29 | "name": "Jack Smith", |
28 | 30 | "blocked": false, |
... | ... | @@ -52,6 +54,7 @@ Parameters: |
52 | 54 | ```json |
53 | 55 | { |
54 | 56 | "id": 1, |
57 | + "username": "john_smith", | |
55 | 58 | "email": "john@example.com", |
56 | 59 | "name": "John Smith", |
57 | 60 | "blocked": false, |
... | ... | @@ -75,6 +78,7 @@ POST /users |
75 | 78 | Parameters: |
76 | 79 | + `email` (required) - Email |
77 | 80 | + `password` (required) - Password |
81 | ++ `username` (required) - Username | |
78 | 82 | + `name` (required) - Name |
79 | 83 | + `skype` - Skype ID |
80 | 84 | + `linkedin` - Linkedin |
... | ... | @@ -95,6 +99,7 @@ GET /user |
95 | 99 | ```json |
96 | 100 | { |
97 | 101 | "id": 1, |
102 | + "username": "john_smith", | |
98 | 103 | "email": "john@example.com", |
99 | 104 | "name": "John Smith", |
100 | 105 | "blocked": false, | ... | ... |
lib/api/entities.rb
1 | 1 | module Gitlab |
2 | 2 | module Entities |
3 | 3 | class User < Grape::Entity |
4 | - expose :id, :email, :name, :bio, :skype, :linkedin, :twitter, | |
4 | + expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter, | |
5 | 5 | :dark_scheme, :theme_id, :blocked, :created_at |
6 | 6 | end |
7 | 7 | |
8 | 8 | class UserBasic < Grape::Entity |
9 | - expose :id, :email, :name, :blocked, :created_at | |
9 | + expose :id, :username, :email, :name, :blocked, :created_at | |
10 | 10 | end |
11 | 11 | |
12 | 12 | class UserLogin < UserBasic | ... | ... |