mirror of
https://github.com/kennethreitz/python-github3.git
synced 2026-06-05 23:10:17 +00:00
docs
This commit is contained in:
@@ -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,
|
||||
}
|
||||
@@ -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`
|
||||
@@ -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`
|
||||
@@ -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`
|
||||
Reference in New Issue
Block a user