From d3b8952f8fb067afe89f08eadbae7733c0cc6824 Mon Sep 17 00:00:00 2001 From: Cyril Date: Mon, 10 Dec 2012 23:46:31 +0100 Subject: Add username to User and UserBasic entities in API and in examples in doc. --- doc/api/projects.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/api/projects.md') 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, -- cgit v1.2.1 From 77d632890bce9835929daeec829b529799915815 Mon Sep 17 00:00:00 2001 From: Valeriy Sizov Date: Tue, 18 Dec 2012 20:52:18 +0200 Subject: refactoring gfm_autocomplete --- doc/api/projects.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index fac4107fd93..c8cb263e705 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -126,6 +126,7 @@ GET /projects/:id/members Parameters: + `id` (required) - The ID or code name of a project ++ `query` - Query string ## Get project team member -- cgit v1.2.1 From 931ec399bd16321f5bdd8e745f2f87dfe25a83ac Mon Sep 17 00:00:00 2001 From: Riyad Preukschas Date: Fri, 21 Dec 2012 18:43:46 +0100 Subject: Remove the code parameter from the projects API --- doc/api/projects.md | 4 ---- 1 file changed, 4 deletions(-) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index c8cb263e705..42c20ff6e5f 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -10,7 +10,6 @@ GET /projects [ { "id": 3, - "code": "rails", "name": "rails", "description": null, "path": "rails", @@ -32,7 +31,6 @@ GET /projects }, { "id": 5, - "code": "gitlab", "name": "gitlab", "description": null, "path": "gitlab", @@ -70,7 +68,6 @@ Parameters: ```json { "id": 5, - "code": "gitlab", "name": "gitlab", "description": null, "path": "gitlab", @@ -103,7 +100,6 @@ POST /projects Parameters: + `name` (required) - new project name -+ `code` (optional) - new project code, uses project name if not set + `path` (optional) - new project path, uses project name if not set + `description` (optional) - short project description + `default_branch` (optional) - 'master' by default -- cgit v1.2.1 From 8f01190eb5ec0f40d6f8874a3f3c79637000a709 Mon Sep 17 00:00:00 2001 From: Riyad Preukschas Date: Fri, 21 Dec 2012 18:47:04 +0100 Subject: Remove all references tp the project code parameter from the API --- doc/api/projects.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index 42c20ff6e5f..b38e60ee296 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -63,7 +63,7 @@ GET /projects/:id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ```json { @@ -121,7 +121,7 @@ GET /projects/:id/members Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `query` - Query string ## Get project team member @@ -134,7 +134,7 @@ GET /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a user ```json @@ -160,7 +160,7 @@ POST /projects/:id/members Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a user to add + `access_level` (required) - Project access level @@ -176,7 +176,7 @@ PUT /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a team member + `access_level` (required) - Project access level @@ -192,7 +192,7 @@ DELETE /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a team member Status code `200` will be returned on success. @@ -207,7 +207,7 @@ GET /projects/:id/hooks Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project Will return hooks with status `200 OK` on success, or `404 Not found` on fail. @@ -221,7 +221,7 @@ GET /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `hook_id` (required) - The ID of a project hook Will return hook with status `200 OK` on success, or `404 Not found` on fail. @@ -236,7 +236,7 @@ POST /projects/:id/hooks Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `url` (required) - The hook URL Will return status `201 Created` on success, or `404 Not found` on fail. @@ -251,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `hook_id` (required) - The ID of a project hook + `url` (required) - The hook URL @@ -268,7 +268,7 @@ DELETE /projects/:id/hooks Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `hook_id` (required) - The ID of hook to delete Will return status `200 OK` on success, or `404 Not found` on fail. -- cgit v1.2.1 From 056fa05b869a8e12700bf56934e93ca76abb2db7 Mon Sep 17 00:00:00 2001 From: Riyad Preukschas Date: Sat, 22 Dec 2012 20:06:18 +0100 Subject: Remove path parameter from projects API --- doc/api/projects.md | 4 ---- 1 file changed, 4 deletions(-) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index b38e60ee296..411286750f8 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -12,7 +12,6 @@ GET /projects "id": 3, "name": "rails", "description": null, - "path": "rails", "default_branch": "master", "owner": { "id": 1, @@ -33,7 +32,6 @@ GET /projects "id": 5, "name": "gitlab", "description": null, - "path": "gitlab", "default_branch": "api", "owner": { "id": 1, @@ -70,7 +68,6 @@ Parameters: "id": 5, "name": "gitlab", "description": null, - "path": "gitlab", "default_branch": "api", "owner": { "id": 1, @@ -100,7 +97,6 @@ POST /projects Parameters: + `name` (required) - new project name -+ `path` (optional) - new project path, uses project name if not set + `description` (optional) - short project description + `default_branch` (optional) - 'master' by default + `issues_enabled` (optional) - enabled by default -- cgit v1.2.1