From 985ecf0f045ce0d8a6fd0524935f12152bfe3918 Mon Sep 17 00:00:00 2001 From: Alex Denisov <1101.debian@gmail.com> Date: Fri, 31 Aug 2012 10:25:36 +0300 Subject: Docs added for Create Project API --- doc/api/projects.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index d680b5d8597..f015b2f534a 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -89,6 +89,44 @@ Parameters: } ``` +## Create project + +Create new project owned by user + +``` +POST /projects +``` + +Parameters: + ++ `name` (required) - new project name ++ `code` (optional) - new project code, used project name if not set ++ `path` (optional) - new project path, user project name if not set + +```json +{ + "id": 5, + "code": "gitlab", + "name": "gitlab", + "description": null, + "path": "gitlab", + "default_branch": "api", + "owner": { + "id": 1, + "email": "john@example.com", + "name": "John Smith", + "blocked": false, + "created_at": "2012-05-23T08:00:58Z" + }, + "private": true, + "issues_enabled": true, + "merge_requests_enabled": true, + "wall_enabled": true, + "wiki_enabled": true, + "created_at": "2012-05-30T12:49:20Z" +} +``` + ## Project repository branches Get a list of project repository branches sorted by name alphabetically. -- cgit v1.2.1 From b6a0407e7a3ba5bc77f332dbacb9cae3acb11cce Mon Sep 17 00:00:00 2001 From: Alex Denisov <1101.debian@gmail.com> Date: Fri, 31 Aug 2012 10:27:45 +0300 Subject: Docs changed for Create Project API --- doc/api/projects.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index f015b2f534a..8c34f4d0612 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -103,6 +103,9 @@ Parameters: + `code` (optional) - new project code, used project name if not set + `path` (optional) - new project path, user project name if not set +Will return created project with status `201 Created` on success, or `404 Not +found` on fail. + ```json { "id": 5, -- cgit v1.2.1 From acac1547a06e120a05010fbe556e5836f35248d0 Mon Sep 17 00:00:00 2001 From: Alex Denisov <1101.debian@gmail.com> Date: Fri, 31 Aug 2012 10:28:38 +0300 Subject: JSON for new project removed from API docs --- doc/api/projects.md | 23 ----------------------- 1 file changed, 23 deletions(-) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index 8c34f4d0612..97a316969d8 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -106,29 +106,6 @@ Parameters: Will return created project with status `201 Created` on success, or `404 Not found` on fail. -```json -{ - "id": 5, - "code": "gitlab", - "name": "gitlab", - "description": null, - "path": "gitlab", - "default_branch": "api", - "owner": { - "id": 1, - "email": "john@example.com", - "name": "John Smith", - "blocked": false, - "created_at": "2012-05-23T08:00:58Z" - }, - "private": true, - "issues_enabled": true, - "merge_requests_enabled": true, - "wall_enabled": true, - "wiki_enabled": true, - "created_at": "2012-05-30T12:49:20Z" -} -``` ## Project repository branches -- cgit v1.2.1 From 9811e64d71d050554c952221c4fdaf48ce1f06a6 Mon Sep 17 00:00:00 2001 From: Alex Denisov <1101.debian@gmail.com> Date: Fri, 31 Aug 2012 11:11:12 +0300 Subject: Typo and mistakes fixed --- doc/api/projects.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/api/projects.md') diff --git a/doc/api/projects.md b/doc/api/projects.md index 97a316969d8..b0c1e65709c 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -100,8 +100,8 @@ POST /projects Parameters: + `name` (required) - new project name -+ `code` (optional) - new project code, used project name if not set -+ `path` (optional) - new project path, user project name if not set ++ `code` (optional) - new project code, uses project name if not set ++ `path` (optional) - new project path, uses project name if not set Will return created project with status `201 Created` on success, or `404 Not found` on fail. -- cgit v1.2.1