Merge pull request #4115 from bke-drewb/apidocs
Update api docs and remove old attribute from User entity.
This commit is contained in:
commit
cd5685ca8c
|
@ -14,32 +14,32 @@ GET /users
|
||||||
"username": "john_smith",
|
"username": "john_smith",
|
||||||
"email": "john@example.com",
|
"email": "john@example.com",
|
||||||
"name": "John Smith",
|
"name": "John Smith",
|
||||||
"blocked": false,
|
"state": "active",
|
||||||
"created_at": "2012-05-23T08:00:58Z",
|
"created_at": "2012-05-23T08:00:58Z",
|
||||||
"bio": null,
|
"bio": null,
|
||||||
"skype": "",
|
"skype": "",
|
||||||
"linkedin": "",
|
"linkedin": "",
|
||||||
"twitter": "",
|
"twitter": "",
|
||||||
"dark_scheme": false,
|
|
||||||
"extern_uid": "john.smith",
|
"extern_uid": "john.smith",
|
||||||
"provider": "provider_name",
|
"provider": "provider_name",
|
||||||
"theme_id": 1
|
"theme_id": 1
|
||||||
|
"color_scheme_id": 2
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 2,
|
"id": 2,
|
||||||
"username": "jack_smith",
|
"username": "jack_smith",
|
||||||
"email": "jack@example.com",
|
"email": "jack@example.com",
|
||||||
"name": "Jack Smith",
|
"name": "Jack Smith",
|
||||||
"blocked": false,
|
"state": "blocked",
|
||||||
"created_at": "2012-05-23T08:01:01Z",
|
"created_at": "2012-05-23T08:01:01Z",
|
||||||
"bio": null,
|
"bio": null,
|
||||||
"skype": "",
|
"skype": "",
|
||||||
"linkedin": "",
|
"linkedin": "",
|
||||||
"twitter": "",
|
"twitter": "",
|
||||||
"dark_scheme": true,
|
|
||||||
"extern_uid": "jack.smith",
|
"extern_uid": "jack.smith",
|
||||||
"provider": "provider_name",
|
"provider": "provider_name",
|
||||||
"theme_id": 1
|
"theme_id": 1
|
||||||
|
"color_scheme_id": 3
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
@ -63,16 +63,16 @@ Parameters:
|
||||||
"username": "john_smith",
|
"username": "john_smith",
|
||||||
"email": "john@example.com",
|
"email": "john@example.com",
|
||||||
"name": "John Smith",
|
"name": "John Smith",
|
||||||
"blocked": false,
|
"state": "active",
|
||||||
"created_at": "2012-05-23T08:00:58Z",
|
"created_at": "2012-05-23T08:00:58Z",
|
||||||
"bio": null,
|
"bio": null,
|
||||||
"skype": "",
|
"skype": "",
|
||||||
"linkedin": "",
|
"linkedin": "",
|
||||||
"twitter": "",
|
"twitter": "",
|
||||||
"dark_scheme": false,
|
|
||||||
"extern_uid": "john.smith",
|
"extern_uid": "john.smith",
|
||||||
"provider": "provider_name",
|
"provider": "provider_name",
|
||||||
"theme_id": 1
|
"theme_id": 1
|
||||||
|
"color_scheme_id": 2
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -156,14 +156,14 @@ GET /user
|
||||||
"email": "john@example.com",
|
"email": "john@example.com",
|
||||||
"name": "John Smith",
|
"name": "John Smith",
|
||||||
"private_token": "dd34asd13as",
|
"private_token": "dd34asd13as",
|
||||||
"blocked": false,
|
"state": "active",
|
||||||
"created_at": "2012-05-23T08:00:58Z",
|
"created_at": "2012-05-23T08:00:58Z",
|
||||||
"bio": null,
|
"bio": null,
|
||||||
"skype": "",
|
"skype": "",
|
||||||
"linkedin": "",
|
"linkedin": "",
|
||||||
"twitter": "",
|
"twitter": "",
|
||||||
"dark_scheme": false,
|
|
||||||
"theme_id": 1
|
"theme_id": 1
|
||||||
|
"color_scheme_id": 2
|
||||||
"is_admin": false,
|
"is_admin": false,
|
||||||
"can_create_group" : true,
|
"can_create_group" : true,
|
||||||
"can_create_team" : true,
|
"can_create_team" : true,
|
||||||
|
|
|
@ -2,7 +2,7 @@ module API
|
||||||
module Entities
|
module Entities
|
||||||
class User < Grape::Entity
|
class User < Grape::Entity
|
||||||
expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter,
|
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
|
end
|
||||||
|
|
||||||
class UserSafe < Grape::Entity
|
class UserSafe < Grape::Entity
|
||||||
|
|
Loading…
Reference in New Issue