Download as
Browse Code »

Commit 4cb03183ac4d9c765111174f0d657997bfb35d45

Authored by Rob Taylor
1 parent c347fd3f
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Text changes to API documentation

Showing 2 changed files with 9 additions and 11 deletions   Show diff stats
doc/api/README.md
  Diff comments   View file @4cb0318
1 # Gitlab API 1 # Gitlab API
2 2
3 -All API requests require authentication. You need to pass `private_token` parameter to authenticate. 3 +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.
4 4
5 -To get or reset your token visit your profile.  
6 -  
7 -If no or invalid `private_token` provided error message will be returned with status code 401: 5 +If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401:
8 6
9 ```json 7 ```json
10 { 8 {
@@ -12,10 +10,9 @@ If no or invalid `private_token` provided error message will be returned with st @@ -12,10 +10,9 @@ If no or invalid `private_token` provided error message will be returned with st
12 } 10 }
13 ``` 11 ```
14 12
15 -API requests should be prefixed with `api` and the API version.  
16 -API version is equal to Gitlab major version number and defined in `lib/api.rb`. 13 +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`.
17 14
18 -Example of valid API request: 15 +Example of a valid API request:
19 16
20 ``` 17 ```
21 GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U 18 GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U
doc/api/projects.md
  Diff comments   View file @4cb0318
1 ## List projects 1 ## List projects
2 2
3 -Get a list of authenticated user's projects. 3 +Get a list of projects owned by the authenticated user.
4 4
5 ``` 5 ```
6 GET /projects 6 GET /projects
@@ -55,7 +55,7 @@ GET /projects @@ -55,7 +55,7 @@ GET /projects
55 55
56 ## Single project 56 ## Single project
57 57
58 -Get an authenticated user's project. 58 +Get a specific project, identified by project ID, which is owned by the authentication user.
59 59
60 ``` 60 ```
61 GET /projects/:id 61 GET /projects/:id
@@ -109,7 +109,7 @@ found` on fail. @@ -109,7 +109,7 @@ found` on fail.
109 109
110 ## Project repository branches 110 ## Project repository branches
111 111
112 -Get a list of project repository branches sorted by name alphabetically. 112 +Get a list of repository branches from a project, sorted by name alphabetically.
113 113
114 ``` 114 ```
115 GET /projects/:id/repository/branches 115 GET /projects/:id/repository/branches
@@ -186,7 +186,7 @@ Parameters: @@ -186,7 +186,7 @@ Parameters:
186 186
187 ## Project repository tags 187 ## Project repository tags
188 188
189 -Get a list of project repository tags sorted by name in reverse alphabetical order. 189 +Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
190 190
191 ``` 191 ```
192 GET /projects/:id/repository/tags 192 GET /projects/:id/repository/tags
@@ -237,3 +237,4 @@ Parameters: @@ -237,3 +237,4 @@ Parameters:
237 + `filepath` (required) - The path the file 237 + `filepath` (required) - The path the file
238 238
239 Will return the raw file contents. 239 Will return the raw file contents.
  240 +