Commit d3b8952f authored by Cyril Jouve's avatar Cyril Jouve
Browse files

Add username to User and UserBasic entities in API and in examples in doc.

parent 633f9fc54a7a
......@@ -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,
......
......@@ -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,
......
......@@ -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,
......
......@@ -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,
......
......@@ -13,6 +13,7 @@ Parameters:
```json
{
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"private_token": "dd34asd13as",
......
......@@ -30,6 +30,7 @@ Parameters:
"file_name": "add.rb",
"author": {
"id": 1,
"username": "john_smith",
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
......
......@@ -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,
......
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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment