aboutsummaryrefslogtreecommitdiffstats
path: root/ext
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
parentfab update (diff)
downloadpython-github3-a71fc4816b821dd7695bf609b6bb424091a2bf40.tar.xz
python-github3-a71fc4816b821dd7695bf609b6bb424091a2bf40.zip
docs
Diffstat (limited to 'ext')
-rw-r--r--ext/issue_comments.md15
-rw-r--r--ext/issues.md48
-rw-r--r--ext/labels.md71
-rw-r--r--ext/milestones.md44
4 files changed, 178 insertions, 0 deletions
diff --git a/ext/issue_comments.md b/ext/issue_comments.md
new file mode 100644
index 0000000..ee5ca27
--- /dev/null
+++ b/ext/issue_comments.md
@@ -0,0 +1,15 @@
+# Issue Comments API
+
+## Get Comments for an Issue
+
+### GET `/repos/:user/:repo/issues/:id/comments.json`
+
+## Create a Comment for an Issue
+
+### POST `/repos/:user/:repo/issues/:id/comments.json`
+
+### Input
+
+ {
+ body: String,
+ }
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`
diff --git a/ext/labels.md b/ext/labels.md
new file mode 100644
index 0000000..2dcca58
--- /dev/null
+++ b/ext/labels.md
@@ -0,0 +1,71 @@
+# Labels API
+
+## List all Labels for this Repository
+
+### GET `/repos/:user/:repo/labels.json`
+
+## Create a Label
+
+### POST `/repos/:user/:repo/labels.json`
+
+### Input
+
+ {
+ name: String,
+ color: String,
+ }
+
+## Get a single Label
+
+### GET `/repos/:user/:repo/labels/:id.json`
+
+## Update a Label
+
+### PUT `/repos/:user/:repo/labels/:id.json`
+
+### Input
+
+ {
+ name: String,
+ color: String,
+ }
+
+## Delete a label
+
+### DELETE `/repos/:user/:repo/labels/:id.json`
+
+## List labels on the Issue
+
+### GET `/repos/:user/:repo/issues/:id/labels.json`
+
+## Add a Label to an Issue
+
+### POST `/repos/:user/:repo/issues/:id/labels.json`
+
+### Input
+
+ [{
+ name: String,
+ }, ...]
+
+## Remove a Label from an Issue
+
+### DELETE `/repos/:user/:repo/issues/:id/labels/:id.json`
+
+## Replace all Labels for an Issue
+
+### PUT `/repos/:user/:repo/issues/:id/labels.json`
+
+### Input
+
+ [{
+ name: String,
+ }, ...]
+
+## Remove all Labels from an Issue
+
+### DELETE `/repos/:user/:repo/issues/:id/labels.json`
+
+## Get Labels for every Issue in a Milestone
+
+### GET `/repos/:user/:repo/milestones/:id/labels.json`
diff --git a/ext/milestones.md b/ext/milestones.md
new file mode 100644
index 0000000..381228b
--- /dev/null
+++ b/ext/milestones.md
@@ -0,0 +1,44 @@
+# Milestones API
+
+## List Milestones for an Issue
+
+### GET `/repos/:user/:repo/milestones.json`
+
+* `?sort` = (String)
+* `?direction` = (String)
+* `?state` = open, closed, default: open
+
+
+## Create a Milestone
+
+### POST `/repos/:user/:repo/milestones.json`
+
+### Input
+
+ {
+ title: String,
+ state: String,
+ description: String,
+ due_on: Time,
+ }
+
+## Get a single Milestone
+
+### GET `/repos/:user/:repo/milestones/:id.json`
+
+## Update a Milestone
+
+### PUT `/repos/:user/:repo/milestones/:id.json`
+
+### Input
+
+ {
+ title: String,
+ state: String,
+ description: String,
+ due_on: Time,
+ }
+
+## Delete a Milestone
+
+### DELETE `/repos/:user/:repo/milestones/:id.json`