Skip to content

Commit 3aa7c72

Browse files
gjtorikiangjtorikian
committed
Convert issues
1 parent bb90ec7 commit 3aa7c72

4 files changed

Lines changed: 79 additions & 146 deletions

File tree

‎content/v3/issues.md‎

Lines changed: 38 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,14 @@ List all issues for a given organization for the authenticated user:
2828

2929
### Parameters
3030

31-
filter
32-
: * `assigned`: Issues assigned to you (default)
33-
* `created`: Issues created by you
34-
* `mentioned`: Issues mentioning you
35-
* `subscribed`: Issues you're subscribed to updates for
36-
* `all`: All issues the authenticated user can see, regardless of participation or creation
37-
38-
state
39-
: `open`, `closed`, default: `open`
40-
41-
labels
42-
: _String_ list of comma separated Label names. Example:
43-
`bug,ui,@high`
44-
45-
sort
46-
: `created`, `updated`, `comments`, default: `created`.
47-
48-
direction
49-
: `asc` or `desc`, default: `desc`.
50-
51-
since
52-
: _Optional_ **string** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
31+
Name | Type | Description | Required? | Default
32+
----|------|--------------|-----------|---------
33+
`filter`|`string`| Indicates which sorts of issues to return. Can be one of:<br/>* `assigned`: Issues assigned to you<br/>* `created`: Issues created by you<br/>* `mentioned`: Issues mentioning you<br/>* `subscribed`: Issues you're subscribed to updates for<br/>* `all`: All issues the authenticated user can see, regardless of participation or creation| | `assigned`
34+
`state`|`string`| Indicates the state of the issues to return. Can be either `open` or `closed`. | |`open`
35+
`labels`|`string`| A list of comma separated label names. Example: `bug,ui,@high`| |
36+
`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `comments`. | |`created`
37+
`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`. | |`desc`
38+
`since`|`string` | Only issues updated at or after this time are returned. A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.| |
5339

5440
### Response
5541

@@ -62,37 +48,17 @@ since
6248

6349
### Parameters
6450

65-
milestone
66-
: * _Integer_ Milestone number
67-
* `none` for Issues with no Milestone.
68-
* `*` for Issues with any Milestone.
69-
70-
state
71-
: `open`, `closed`, default: `open`
72-
73-
assignee
74-
: * _String_ User login
75-
* `none` for Issues with no assigned User.
76-
* `*` for Issues with any assigned User.
77-
78-
creator
79-
: _String_ User login.
80-
81-
mentioned
82-
: _String_ User login.
83-
84-
labels
85-
: _String_ list of comma separated Label names. Example:
86-
`bug,ui,@high`
87-
88-
sort
89-
: `created`, `updated`, `comments`, default: `created`
90-
91-
direction
92-
: `asc` or `desc`, default: `desc`.
93-
94-
since
95-
: _Optional_ **String** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
51+
Name | Type | Description | Required? | Default
52+
----|------|--------------|-----------|---------
53+
`filter`|`integer` or `string`| If an `integer` is passed, it should refer to a milestone number. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. | | `*`
54+
`state`|`string`| Indicates the state of the issues to return. Can be either `open` or `closed`. | |`open`
55+
`assignee`|`string`| Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.| | `*`
56+
`creator`|`string`| The user that created the issue.| |
57+
`mentioned`|`string`| A user that's mentioned in the issue. | |
58+
`labels`|`string`| A list of comma separated label names. Example: `bug,ui,@high`| |
59+
`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `comments`. | |`created`
60+
`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`. | |`desc`
61+
`since`|`string` | Only issues updated at or after this time are returned. A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.| |
9662

9763
### Response
9864

@@ -114,30 +80,17 @@ Any user with pull access to a repository can create an issue.
11480

11581
POST /repos/:owner/:repo/issues
11682

117-
### Input
118-
119-
title
120-
: _Required_ **string**
121-
122-
body
123-
: _Optional_ **string**
124-
125-
assignee
126-
: _Optional_ **string** - Login for the user that this issue should be
127-
assigned to. _NOTE: Only users with push access can set the assignee for new
128-
issues. The assignee is silently dropped otherwise._
129-
130-
131-
milestone
132-
: _Optional_ **number** - Milestone to associate this issue with. _NOTE: Only
133-
users with push access can set the milestone for new issues. The milestone is
134-
silently dropped otherwise._
83+
### Parameters
13584

85+
Name | Type | Description | Required? | Default
86+
----|------|--------------|-----------|---------
87+
`title`|`string` | The title of the issue.|**YES**|
88+
`body`|`string` | The contents of the issue.| |
89+
`assignee`|`string` | Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise._| |
90+
`milestone`|`number` | Milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._| |
91+
`labels`|`array` of `strings` | Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._| |
13692

137-
labels
138-
: _Optional_ **array** of **strings** - Labels to associate with this
139-
issue. _NOTE: Only users with push access can set labels for new issues. Labels are
140-
silently dropped otherwise._
93+
#### Example
14194

14295
<%= json \
14396
:title => "Found a bug",
@@ -160,28 +113,19 @@ Issue owners and users with push access can edit an issue.
160113

161114
PATCH /repos/:owner/:repo/issues/:number
162115

163-
### Input
164-
165-
title
166-
: _Optional_ **string**
167-
168-
body
169-
: _Optional_ **string**
170-
171-
assignee
172-
: _Optional_ **string** - Login for the user that this issue should be
173-
assigned to.
116+
### Parameters
174117

175-
state
176-
: _Optional_ **string** - State of the issue: `open` or `closed`.
118+
Name | Type | Description | Required? | Default
119+
----|------|--------------|-----------|---------
120+
`title`|`string` | The title of the issue.|**YES**|
121+
`body`|`string` | The contents of the issue.| |
122+
`assignee`|`string` | Login for the user that this issue should be assigned to.| |
123+
`state`|`string` | State of the issue. Either `open` or `closed`.| |
124+
`milestone`|`number` | Milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._| |
125+
`labels`|`array` of `strings` | Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._| |
177126

178-
milestone
179-
: _Optional_ **number** - Milestone to associate this issue with.
180127

181-
labels
182-
: _Optional_ **array** of **strings** - Labels to associate with this
183-
issue. Pass one or more Labels to _replace_ the set of Labels on this
184-
Issue. Send an empty array (`[]`) to clear all Labels from the Issue.
128+
#### Example
185129

186130
<%= json \
187131
:title => "Found a bug",

‎content/v3/issues/comments.md‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,12 @@ By default, Issue Comments are ordered by ascending ID.
3131

3232
### Parameters
3333

34-
sort
35-
: _Optional_ **String** `created` or `updated`
34+
Name | Type | Description | Required? | Default
35+
----|------|--------------|-----------|---------
36+
`sort`|`String` | Either `created` or `updated`.| |
37+
`direction`|`String` | Either `asc` or `desc`. Ignored without `sort` parameter.| |
38+
`since`|`String` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.| |
3639

37-
direction
38-
: _Optional_ **String** `asc` or `desc`. Ignored without `sort` parameter.
39-
40-
since
41-
: _Optional_ **String** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
4240

4341
### Response
4442

@@ -60,8 +58,10 @@ since
6058

6159
### Input
6260

63-
body
64-
: _Required_ **string**
61+
Name | Type | Description | Required? | Default
62+
----|------|--------------|-----------|---------
63+
`body`|`string` | The contents of the comment.|**YES**|
64+
6565

6666
<%= json :body => "a new comment" %>
6767

@@ -78,8 +78,10 @@ body
7878

7979
### Input
8080

81-
body
82-
: _Required_ **string**
81+
Name | Type | Description | Required? | Default
82+
----|------|--------------|-----------|---------
83+
`body`|`string` | The contents of the comment.|**YES**|
84+
8385

8486
<%= json :body => "String" %>
8587

‎content/v3/issues/labels.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ title: Issue Labels | GitHub API
2929

3030
POST /repos/:owner/:repo/labels
3131

32-
### Input
32+
### Parameters
3333

34-
name
35-
: _Required_ **string**
34+
Name | Type | Description | Required? | Default
35+
----|------|--------------|-----------|---------
36+
`name`|`string` | The name of the label.|**YES**|
37+
`color`|`string` | A 6 character hex code, without the leading `#`, identifying the color.|**YES**|
3638

37-
color
38-
: _Required_ **string** - 6 character hex code, without a leading `#`.
3939

4040
<%= json :name => "API", :color => "FFFFFF" %>
4141

@@ -50,13 +50,13 @@ color
5050

5151
PATCH /repos/:owner/:repo/labels/:name
5252

53-
### Input
53+
### Parameters
5454

55-
name
56-
: _Required_ **string**
55+
Name | Type | Description | Required? | Default
56+
----|------|--------------|-----------|---------
57+
`name`|`string` | The name of the label.|**YES**|
58+
`color`|`string` | A 6 character hex code, without the leading `#`, identifying the color.|**YES**|
5759

58-
color
59-
: _Required_ **string** - 6 character hex code, without a leading `#`.
6060

6161
<%= json :name => "API", :color => "FFFFFF" %>
6262

‎content/v3/issues/milestones.md‎

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,12 @@ title: Issue Milestones | GitHub API
1313

1414
### Parameters
1515

16-
state
17-
: `open`, `closed`, default: `open`
16+
Name | Type | Description | Required? | Default
17+
----|------|--------------|-----------|---------
18+
`state`|`string` | The state of the milestone. Either `open` or `closed`. | |`open`
19+
`sort`|`string` | What to sort results by. Either `due_date` or `completeness`. | |`due_date`
20+
`direction`|`string` | The direction of the sort. Either `asc` or `desc`. | |`asc`
1821

19-
sort
20-
: `due_date`, `completeness`, default: `due_date`
21-
22-
direction
23-
: `asc` or `desc`, default: `asc`.
2422

2523
### Response
2624

@@ -42,23 +40,19 @@ direction
4240

4341
### Input
4442

45-
title
46-
: _Required_ **string**
47-
48-
state
49-
: _Optional_ **string** - `open` or `closed`. Default is `open`.
43+
Name | Type | Description | Required? | Default
44+
----|------|--------------|-----------|---------
45+
`title`|`string` | The title of the milestone.|**YES**|
46+
`state`|`string` | The state of the milestone. Either `open` or `closed`. | |`open`
47+
`description`|`string` | A description of the milestone.| |
48+
`due_on`|`time` | The milestone due date. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`| |
5049

51-
description
52-
: _Optional_ **string**
53-
54-
due\_on
55-
: _Optional_ **string** - ISO 8601 time.
5650

5751
<%= json \
5852
:title => "String",
5953
:state => "open or closed",
6054
:description => "String",
61-
:due_on => "Time"
55+
:due_on => "2012-10-09T23:39:01Z"
6256
%>
6357

6458
### Response
@@ -74,20 +68,13 @@ due\_on
7468

7569
### Input
7670

77-
number
78-
: _Required_ **integer**
79-
80-
title
81-
: _Optional_ **string**
82-
83-
state
84-
: _Optional_ **string** - `open` or `closed`. Default is `open`.
85-
86-
description
87-
: _Optional_ **string**
71+
Name | Type | Description | Required? | Default
72+
----|------|--------------|-----------|---------
73+
`title`|`string` | The title of the milestone.| |
74+
`state`|`string` | The state of the milestone. Either `open` or `closed`. | |`open`
75+
`description`|`string` | A description of the milestone.| |
76+
`due_on`|`time` | The milestone due date. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`| |
8877

89-
due\_on
90-
: _Optional_ **string** - ISO 8601 time.
9178

9279
<%= json \
9380
:title => "String",

0 commit comments

Comments
 (0)