Skip to content

Commit 97ea041

Browse files
committed
Merge pull request gitlabhq#1233 from robbytaylor/master
Changes to text in API documentation
2 parents e398e96 + 4cb0318 commit 97ea041

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

doc/api/README.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
# Gitlab API
22

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.
44

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:
86

97
```json
108
{
119
"message": "401 Unauthorized"
1210
}
1311
```
1412

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`.
1714

18-
Example of valid API request:
15+
Example of a valid API request:
1916

2017
```
2118
GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U

doc/api/projects.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## List projects
22

3-
Get a list of authenticated user's projects.
3+
Get a list of projects owned by the authenticated user.
44

55
```
66
GET /projects
@@ -55,7 +55,7 @@ GET /projects
5555

5656
## Single project
5757

58-
Get an authenticated user's project.
58+
Get a specific project, identified by project ID, which is owned by the authentication user.
5959

6060
```
6161
GET /projects/:id
@@ -109,7 +109,7 @@ found` on fail.
109109

110110
## Project repository branches
111111

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.
113113

114114
```
115115
GET /projects/:id/repository/branches
@@ -186,7 +186,7 @@ Parameters:
186186

187187
## Project repository tags
188188

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.
190190

191191
```
192192
GET /projects/:id/repository/tags
@@ -237,3 +237,4 @@ Parameters:
237237
+ `filepath` (required) - The path the file
238238

239239
Will return the raw file contents.
240+

0 commit comments

Comments
 (0)