diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2013-06-06 11:31:40 +0300 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2013-06-06 11:31:40 +0300 |
| commit | a4e671dc31dd2b2775bd52304f0c772eaac451bc (patch) | |
| tree | a47c7e36244186f76df1d3542d9f848adbf0b4dc | |
| parent | 0fbaf95f13bfa8097cd277971a41028b159da0a7 (diff) | |
| download | gitlab-ce-a4e671dc31dd2b2775bd52304f0c772eaac451bc.tar.gz | |
Fix wrong documentation for issue close api. Fixes #3548
| -rw-r--r-- | doc/api/issues.md | 12 | ||||
| -rw-r--r-- | lib/api/issues.rb | 2 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md index a8ae7401b39..87547593586 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -25,7 +25,7 @@ GET /issues "blocked": false, "created_at": "2012-05-23T08:00:58Z" }, - "closed": true, + "state": 'closed', "updated_at": "2012-07-02T17:53:12Z", "created_at": "2012-07-02T17:53:12Z" }, @@ -42,7 +42,7 @@ GET /issues "title": "v1.0", "description": "", "due_date": "2012-07-20", - "closed": false, + "state": 'reopenend', "updated_at": "2012-07-04T13:42:48Z", "created_at": "2012-07-04T13:42:48Z" }, @@ -62,7 +62,7 @@ GET /issues "blocked": false, "created_at": "2012-05-23T08:00:58Z" }, - "closed": false, + "state": 'opened', "updated_at": "2012-07-12T13:43:19Z", "created_at": "2012-06-28T12:58:06Z" } @@ -111,7 +111,7 @@ Parameters: "title": "v1.0", "description": "", "due_date": "2012-07-20", - "closed": false, + "state": 'closed', "updated_at": "2012-07-04T13:42:48Z", "created_at": "2012-07-04T13:42:48Z" }, @@ -131,7 +131,7 @@ Parameters: "blocked": false, "created_at": "2012-05-23T08:00:58Z" }, - "closed": false, + "state": 'opened', "updated_at": "2012-07-12T13:43:19Z", "created_at": "2012-06-28T12:58:06Z" } @@ -173,7 +173,7 @@ Parameters: + `assignee_id` (optional) - The ID of a user to assign issue + `milestone_id` (optional) - The ID of a milestone to assign issue + `labels` (optional) - Comma-separated label names for an issue -+ `closed` (optional) - The state of an issue (0 = false, 1 = true) ++ `state_event` (optional) - The state event of an issue ('close' to close issue and 'reopen' to reopen it) ## Delete existing issue (**Deprecated**) diff --git a/lib/api/issues.rb b/lib/api/issues.rb index 53e2e8cfa35..a2983e197e7 100644 --- a/lib/api/issues.rb +++ b/lib/api/issues.rb @@ -70,7 +70,7 @@ module API # assignee_id (optional) - The ID of a user to assign issue # milestone_id (optional) - The ID of a milestone to assign issue # labels (optional) - The labels of an issue - # state (optional) - The state of an issue (close|reopen) + # state_event (optional) - The state event of an issue (close|reopen) # Example Request: # PUT /projects/:id/issues/:issue_id put ":id/issues/:issue_id" do |