Commit a4e671dc31dd2b2775bd52304f0c772eaac451bc
1 parent
0fbaf95f
Exists in
master
and in
4 other branches
Fix wrong documentation for issue close api. Fixes #3548
Showing
2 changed files
with
7 additions
and
7 deletions
Show diff stats
doc/api/issues.md
| ... | ... | @@ -25,7 +25,7 @@ GET /issues |
| 25 | 25 | "blocked": false, |
| 26 | 26 | "created_at": "2012-05-23T08:00:58Z" |
| 27 | 27 | }, |
| 28 | - "closed": true, | |
| 28 | + "state": 'closed', | |
| 29 | 29 | "updated_at": "2012-07-02T17:53:12Z", |
| 30 | 30 | "created_at": "2012-07-02T17:53:12Z" |
| 31 | 31 | }, |
| ... | ... | @@ -42,7 +42,7 @@ GET /issues |
| 42 | 42 | "title": "v1.0", |
| 43 | 43 | "description": "", |
| 44 | 44 | "due_date": "2012-07-20", |
| 45 | - "closed": false, | |
| 45 | + "state": 'reopenend', | |
| 46 | 46 | "updated_at": "2012-07-04T13:42:48Z", |
| 47 | 47 | "created_at": "2012-07-04T13:42:48Z" |
| 48 | 48 | }, |
| ... | ... | @@ -62,7 +62,7 @@ GET /issues |
| 62 | 62 | "blocked": false, |
| 63 | 63 | "created_at": "2012-05-23T08:00:58Z" |
| 64 | 64 | }, |
| 65 | - "closed": false, | |
| 65 | + "state": 'opened', | |
| 66 | 66 | "updated_at": "2012-07-12T13:43:19Z", |
| 67 | 67 | "created_at": "2012-06-28T12:58:06Z" |
| 68 | 68 | } |
| ... | ... | @@ -111,7 +111,7 @@ Parameters: |
| 111 | 111 | "title": "v1.0", |
| 112 | 112 | "description": "", |
| 113 | 113 | "due_date": "2012-07-20", |
| 114 | - "closed": false, | |
| 114 | + "state": 'closed', | |
| 115 | 115 | "updated_at": "2012-07-04T13:42:48Z", |
| 116 | 116 | "created_at": "2012-07-04T13:42:48Z" |
| 117 | 117 | }, |
| ... | ... | @@ -131,7 +131,7 @@ Parameters: |
| 131 | 131 | "blocked": false, |
| 132 | 132 | "created_at": "2012-05-23T08:00:58Z" |
| 133 | 133 | }, |
| 134 | - "closed": false, | |
| 134 | + "state": 'opened', | |
| 135 | 135 | "updated_at": "2012-07-12T13:43:19Z", |
| 136 | 136 | "created_at": "2012-06-28T12:58:06Z" |
| 137 | 137 | } |
| ... | ... | @@ -173,7 +173,7 @@ Parameters: |
| 173 | 173 | + `assignee_id` (optional) - The ID of a user to assign issue |
| 174 | 174 | + `milestone_id` (optional) - The ID of a milestone to assign issue |
| 175 | 175 | + `labels` (optional) - Comma-separated label names for an issue |
| 176 | -+ `closed` (optional) - The state of an issue (0 = false, 1 = true) | |
| 176 | ++ `state_event` (optional) - The state event of an issue ('close' to close issue and 'reopen' to reopen it) | |
| 177 | 177 | |
| 178 | 178 | |
| 179 | 179 | ## Delete existing issue (**Deprecated**) | ... | ... |
lib/api/issues.rb
| ... | ... | @@ -70,7 +70,7 @@ module API |
| 70 | 70 | # assignee_id (optional) - The ID of a user to assign issue |
| 71 | 71 | # milestone_id (optional) - The ID of a milestone to assign issue |
| 72 | 72 | # labels (optional) - The labels of an issue |
| 73 | - # state (optional) - The state of an issue (close|reopen) | |
| 73 | + # state_event (optional) - The state event of an issue (close|reopen) | |
| 74 | 74 | # Example Request: |
| 75 | 75 | # PUT /projects/:id/issues/:issue_id |
| 76 | 76 | put ":id/issues/:issue_id" do | ... | ... |