diff options
| author | Rob Taylor <robt@hoopassociates.co.uk> | 2012-08-14 17:54:25 +0100 |
|---|---|---|
| committer | Rob Taylor <robt@hoopassociates.co.uk> | 2012-09-04 09:48:33 +0100 |
| commit | 4cb03183ac4d9c765111174f0d657997bfb35d45 (patch) | |
| tree | 0de4e1db47136bc387f1c1020c60d4739a75e072 /doc/api/README.md | |
| parent | c347fd3f880925c1883df798f8d7dc85a57e80d2 (diff) | |
| download | gitlab-ce-4cb03183ac4d9c765111174f0d657997bfb35d45.tar.gz | |
Text changes to API documentation
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 3a6c7b7682a..dece3e23619 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,10 +1,8 @@ # Gitlab API -All API requests require authentication. You need to pass `private_token` parameter to authenticate. +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. -To get or reset your token visit your profile. - -If no or invalid `private_token` provided error message will be returned with status code 401: +If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401: ```json { @@ -12,10 +10,9 @@ If no or invalid `private_token` provided error message will be returned with st } ``` -API requests should be prefixed with `api` and the API version. -API version is equal to Gitlab major version number and 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 valid API request: +Example of a valid API request: ``` GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U |