root
/
gitlab-ce
mirror of https://gitlab.com/free-releases/gitlab-ce.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update api docs and remove old attribute from User entity. 

The API docs incorrectly referenced a few attributes associated with users. The 'blocked' attribute has been replaced with 'state'. Also, 'dark_scheme' seems to no longer be available in the User model so it should be removed from the exposed attributes in the API User entity.

Add color scheme ID to API User entity
This commit is contained in:
Drew Blessing 2013-05-28 18:41:15 -05:00
parent d58aca0693
commit 07fd95f384
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/api/users.md
View File

@ -14,32 +14,32 @@ GET /users
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"state": "active",
"created_at": "2012-05-23T08:00:58Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": false,
"extern_uid": "john.smith",
"provider": "provider_name",
"theme_id": 1
"color_scheme_id": 2
},
{
"id": 2,
"username": "jack_smith",
"email": "jack@example.com",
"name": "Jack Smith",
"blocked": false,
"state": "blocked",
"created_at": "2012-05-23T08:01:01Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": true,
"extern_uid": "jack.smith",
"provider": "provider_name",
"theme_id": 1
"color_scheme_id": 3
}
]
```
@ -63,16 +63,16 @@ Parameters:
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"state": "active",
"created_at": "2012-05-23T08:00:58Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": false,
"extern_uid": "john.smith",
"provider": "provider_name",
"theme_id": 1
"color_scheme_id": 2
}
```
@ -156,14 +156,14 @@ GET /user
"email": "john@example.com",
"name": "John Smith",
"private_token": "dd34asd13as",
"blocked": false,
"state": "active",
"created_at": "2012-05-23T08:00:58Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": false,
"theme_id": 1
"color_scheme_id": 2
"is_admin": false,
"can_create_group" : true,
"can_create_team" : true,

2
lib/api/entities.rb
View File

@ -2,7 +2,7 @@ module API
module Entities
class User < Grape::Entity
expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter,
:dark_scheme, :theme_id, :state, :created_at, :extern_uid, :provider
:theme_id, :color_scheme_id, :state, :created_at, :extern_uid, :provider
end
class UserSafe < Grape::Entity