From d3b8952f8fb067afe89f08eadbae7733c0cc6824 Mon Sep 17 00:00:00 2001 From: Cyril Date: Mon, 10 Dec 2012 23:46:31 +0100 Subject: [PATCH] Add username to User and UserBasic entities in API and in examples in doc. --- doc/api/issues.md | 5 +++++ doc/api/merge_requests.md | 9 +++++++++ doc/api/notes.md | 1 + doc/api/projects.md | 4 ++++ doc/api/session.md | 1 + doc/api/snippets.md | 1 + doc/api/users.md | 5 +++++ lib/api/entities.rb | 4 ++-- 8 files changed, 28 insertions(+), 2 deletions(-) diff --git a/doc/api/issues.md b/doc/api/issues.md index aaad3305489..4c0dde2f4e4 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -18,6 +18,7 @@ GET /issues "assignee": null, "author": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -46,6 +47,7 @@ GET /issues }, "assignee": { "id": 2, + "username": "jack_smith", "email": "jack@example.com", "name": "Jack Smith", "blocked": false, @@ -53,6 +55,7 @@ GET /issues }, "author": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -110,6 +113,7 @@ Parameters: }, "assignee": { "id": 2, + "username": "jack_smith", "email": "jack@example.com", "name": "Jack Smith", "blocked": false, @@ -117,6 +121,7 @@ Parameters: }, "author": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index e5b067a61d9..86bd79ff43a 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -22,6 +22,7 @@ Parameters: "merged":false, "author":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -29,6 +30,7 @@ Parameters: }, "assignee":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -62,6 +64,7 @@ Parameters: "merged":false, "author":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -69,6 +72,7 @@ Parameters: }, "assignee":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -105,6 +109,7 @@ Parameters: "merged":false, "author":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -112,6 +117,7 @@ Parameters: }, "assignee":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -150,6 +156,7 @@ Parameters: "merged":false, "author":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -157,6 +164,7 @@ Parameters: }, "assignee":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, @@ -184,6 +192,7 @@ Will return created note with status `201 Created` on success, or `404 Not found { "author":{ "id":1, + "username": "admin", "email":"admin@local.host", "name":"Administrator", "blocked":false, diff --git a/doc/api/notes.md b/doc/api/notes.md index 7b226dea44c..dddb55edb93 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -15,6 +15,7 @@ GET /projects/:id/notes "body": "The solution is rather tricky", "author": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, diff --git a/doc/api/projects.md b/doc/api/projects.md index fdedf904a3a..fac4107fd93 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -17,6 +17,7 @@ GET /projects "default_branch": "master", "owner": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -38,6 +39,7 @@ GET /projects "default_branch": "api", "owner": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -75,6 +77,7 @@ Parameters: "default_branch": "api", "owner": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -141,6 +144,7 @@ Parameters: { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, diff --git a/doc/api/session.md b/doc/api/session.md index 9fdbeb439a4..c7e57aaca7a 100644 --- a/doc/api/session.md +++ b/doc/api/session.md @@ -13,6 +13,7 @@ Parameters: ```json { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "private_token": "dd34asd13as", diff --git a/doc/api/snippets.md b/doc/api/snippets.md index 288fd5296f6..b9638ea8291 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -30,6 +30,7 @@ Parameters: "file_name": "add.rb", "author": { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, diff --git a/doc/api/users.md b/doc/api/users.md index e5674ab8463..200c0e06e04 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -10,6 +10,7 @@ GET /users [ { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -23,6 +24,7 @@ GET /users }, { "id": 2, + "username": "jack_smith", "email": "jack@example.com", "name": "Jack Smith", "blocked": false, @@ -52,6 +54,7 @@ Parameters: ```json { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, @@ -75,6 +78,7 @@ POST /users Parameters: + `email` (required) - Email + `password` (required) - Password ++ `username` (required) - Username + `name` (required) - Name + `skype` - Skype ID + `linkedin` - Linkedin @@ -95,6 +99,7 @@ GET /user ```json { "id": 1, + "username": "john_smith", "email": "john@example.com", "name": "John Smith", "blocked": false, diff --git a/lib/api/entities.rb b/lib/api/entities.rb index 9e9d44594a2..070fbad27ed 100644 --- a/lib/api/entities.rb +++ b/lib/api/entities.rb @@ -1,12 +1,12 @@ module Gitlab module Entities class User < Grape::Entity - expose :id, :email, :name, :bio, :skype, :linkedin, :twitter, + expose :id, :username, :email, :name, :bio, :skype, :linkedin, :twitter, :dark_scheme, :theme_id, :blocked, :created_at end class UserBasic < Grape::Entity - expose :id, :email, :name, :blocked, :created_at + expose :id, :username, :email, :name, :blocked, :created_at end class UserLogin < UserBasic -- GitLab