aboutsummaryrefslogtreecommitdiffstats
path: root/ext/issues.md
diff options
context:
space:
mode:
authorKenneth Reitz <me@kennethreitz.com>2011-04-13 19:43:13 -0400
committerKenneth Reitz <me@kennethreitz.com>2011-04-13 19:43:17 -0400
commita71fc4816b821dd7695bf609b6bb424091a2bf40 (patch)
tree8407e203acbd4be1e4a43c49cc05b44907e54300 /ext/issues.md
parentfab update (diff)
downloadpython-github3-a71fc4816b821dd7695bf609b6bb424091a2bf40.tar.xz
python-github3-a71fc4816b821dd7695bf609b6bb424091a2bf40.zip
docs
Diffstat (limited to 'ext/issues.md')
-rw-r--r--ext/issues.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/ext/issues.md b/ext/issues.md
new file mode 100644
index 0000000..83920ff
--- /dev/null
+++ b/ext/issues.md
@@ -0,0 +1,48 @@
+# Issues API
+
+## List issues for this Repository
+
+### GET `/repos/:user/:repo/issues.json`
+
+* `?milestone` = (Fixnum)
+* `?sort` = (String)
+* `?direction` = (String)
+* `?state` = open, closed, default: open
+* `?assignee` = (String)
+* `?mentioned` = (String)
+* `?labels` = (String)
+
+
+## Create an Issue
+
+### POST `/repos/:user/:repo/issues.json`
+
+### Input
+
+ {
+ title: String,
+ body: String,
+ assignee: String,
+ milestone: Fixnum,
+ }
+
+## Get a single Issue
+
+### GET `/repos/:user/:repo/issues/:id.json`
+
+## Edit an Issue
+
+### PUT `/repos/:user/:repo/issues/:id.json`
+
+### Input
+
+ {
+ title: String,
+ body: String,
+ assignee: String,
+ milestone: Fixnum,
+ }
+
+## Delete an Issue
+
+### DELETE `/repos/:user/:repo/issues/:id.json`