diff options
| author | Drew Blessing <drew.blessing@buckle.com> | 2013-05-29 03:41:15 +0400 |
|---|---|---|
| committer | Drew Blessing <drew.blessing@buckle.com> | 2013-05-29 14:40:17 +0400 |
| commit | 07fd95f3840908018cb3712162a441e63409bc31 (patch) | |
| tree | 47dd5019aafe04b2d44150f23e87d55c0ba96347 /doc/api/users.md | |
| parent | d58aca0693d28e17633fb0d2825f1cddfd4f0748 (diff) | |
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
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index ee5e98a016c..9dd35f4bca0 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -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, |