diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/README.md | 4 | ||||
| -rw-r--r-- | doc/api/projects.md | 6 |
2 files changed, 8 insertions, 2 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index dece3e23619..93919b42852 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,4 +1,4 @@ -# Gitlab API +# GitLab API All API requests require authentication. You need to pass a `private_token` parameter to authenticate. You can find or reset your private token in your profile. @@ -10,7 +10,7 @@ If no, or an invalid, `private_token` is provided then an error message will be } ``` -API requests should be prefixed with `api` and the API version. The API version is equal to the Gitlab major version number, which is defined in `lib/api.rb`. +API requests should be prefixed with `api` and the API version. The API version is equal to the GitLab major version number, which is defined in `lib/api.rb`. Example of a valid API request: diff --git a/doc/api/projects.md b/doc/api/projects.md index b26305b140f..72874e59682 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -102,6 +102,12 @@ 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 ++ `issues_enabled` (optional) - enabled by default ++ `wall_enabled` (optional) - enabled by default ++ `merge_requests_enabled` (optional) - enabled by default ++ `wiki_enabled` (optional) - enabled by default Will return created project with status `201 Created` on success, or `404 Not found` on fail. |