From 07fd95f3840908018cb3712162a441e63409bc31 Mon Sep 17 00:00:00 2001 From: Drew Blessing Date: Tue, 28 May 2013 18:41:15 -0500 Subject: [PATCH] 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 --- doc/api/users.md | 16 ++++++++-------- lib/api/entities.rb | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/api/users.md b/doc/api/users.md index ee5e98a01..9dd35f4bc 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, diff --git a/lib/api/entities.rb b/lib/api/entities.rb index c3c351e17..a8f5068d0 100644 --- a/lib/api/entities.rb +++ b/lib/api/entities.rb @@ -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 -- 2.11.0