kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Update snippets and merge request api documentation

Browse source
This commit is contained in:
Marin Jankovski 2013-10-02 11:04:51 +02:00
parent f22e6c917d
commit 5e96d07021
2 changed files with 15 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc/api/merge_requests.md
View file

@ -19,14 +19,13 @@ Parameters:
"source_branch":"test1", "source_branch":"test1",
"project_id":3, "project_id":3,
"title":"test1", "title":"test1",
"closed":true, "state":"opened",
"merged":false,
"author":{ "author":{
"id":1, "id":1,
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
}, },
"assignee":{ "assignee":{
@ -34,7 +33,7 @@ Parameters:
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
} }
} }
@ -62,14 +61,13 @@ Parameters:
"source_branch":"test1", "source_branch":"test1",
"project_id":3, "project_id":3,
"title":"test1", "title":"test1",
"closed":true, "state":"merged",
"merged":false,
"author":{ "author":{
"id":1, "id":1,
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
}, },
"assignee":{ "assignee":{
@ -77,7 +75,7 @@ Parameters:
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
} }
} }
@ -97,7 +95,7 @@ Parameters:
+ `id` (required) - The ID of a project + `id` (required) - The ID of a project
+ `source_branch` (required) - The source branch + `source_branch` (required) - The source branch
+ `target_branch` (required) - The target branch + `target_branch` (required) - The target branch
+ `assignee_id` - Assignee user ID + `assignee_id` (optional) - Assignee user ID
+ `title` (required) - Title of MR + `title` (required) - Title of MR
```json ```json
@ -107,14 +105,13 @@ Parameters:
"source_branch":"test1", "source_branch":"test1",
"project_id":3, "project_id":3,
"title":"test1", "title":"test1",
"closed":true, "state":"opened",
"merged":false,
"author":{ "author":{
"id":1, "id":1,
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
}, },
"assignee":{ "assignee":{
@ -122,7 +119,7 @@ Parameters:
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
} }
} }
@ -145,24 +142,22 @@ Parameters:
+ `target_branch` - The target branch + `target_branch` - The target branch
+ `assignee_id` - Assignee user ID + `assignee_id` - Assignee user ID
+ `title` - Title of MR + `title` - Title of MR
+ `closed` - Status of MR. true - closed
```json ```json
{ {
"id":1, "id":1,
"target_branch":"master", "target_branch":"master",
"source_branch":"test1", "source_branch":"test1",
"project_id":3, "project_id":3,
"title":"test1", "title":"test1",
"closed":true, "state":"opened",
"merged":false,
"author":{ "author":{
"id":1, "id":1,
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
}, },
"assignee":{ "assignee":{
@ -170,7 +165,7 @@ Parameters:
"username": "admin", "username": "admin",
"email":"admin@local.host", "email":"admin@local.host",
"name":"Administrator", "name":"Administrator",
"blocked":false, "state":"active",
"created_at":"2012-04-29T08:46:00Z" "created_at":"2012-04-29T08:46:00Z"
} }
} }

2
doc/api/project_snippets.md
View file

@ -34,7 +34,7 @@ Parameters:
"username": "john_smith", "username": "john_smith",
"email": "john@example.com", "email": "john@example.com",
"name": "John Smith", "name": "John Smith",
"blocked": false, "state": "active",
"created_at": "2012-05-23T08:00:58Z" "created_at": "2012-05-23T08:00:58Z"
}, },
"expires_at": null, "expires_at": null,