From f086676b7c02dc9958fa9c7f6135142523f65bfc Mon Sep 17 00:00:00 2001 From: Nihad Abbasov Date: Thu, 5 Jul 2012 06:57:45 -0700 Subject: add docs for existing API --- doc/api/users.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 doc/api/users.md (limited to 'doc/api/users.md') diff --git a/doc/api/users.md b/doc/api/users.md new file mode 100644 index 00000000000..b9b04dc5399 --- /dev/null +++ b/doc/api/users.md @@ -0,0 +1,90 @@ +## List users + +Get a list of users. + +``` +GET /users +``` + +```json +[ + { + "id": 1, + "email": "john@example.com", + "name": "John Smith", + "blocked": false, + "created_at": "2012-05-23T08:00:58Z", + "bio": null, + "skype": "", + "linkedin": "", + "twitter": "", + "dark_scheme": false, + "theme_id": 1 + }, + { + "id": 2, + "email": "jack@example.com", + "name": "Jack Smith", + "blocked": false, + "created_at": "2012-05-23T08:01:01Z", + "bio": null, + "skype": "", + "linkedin": "", + "twitter": "", + "dark_scheme": true, + "theme_id": 1 + } +] +``` + +## Single user + +Get a single user. + +``` +GET /users/:id +``` + +Parameters: + ++ `id` (required) - The ID of a user + +```json +{ + "id": 1, + "email": "john@example.com", + "name": "John Smith", + "blocked": false, + "created_at": "2012-05-23T08:00:58Z", + "bio": null, + "skype": "", + "linkedin": "", + "twitter": "", + "dark_scheme": false, + "theme_id": 1 +} +``` + +## Current user + +Get currently authenticated user. + +``` +GET /user +``` + +```json +{ + "id": 1, + "email": "john@example.com", + "name": "John Smith", + "blocked": false, + "created_at": "2012-05-23T08:00:58Z", + "bio": null, + "skype": "", + "linkedin": "", + "twitter": "", + "dark_scheme": false, + "theme_id": 1 +} +``` -- cgit v1.2.1