Skip to content

Commit ec72a85

Browse files
technoweenietechnoweenie
committed
better descriptions of url params
1 parent 5ede1f7 commit ec72a85

6 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎content/v3/issues.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ issue.
129129

130130
## Edit an issue
131131

132-
PATCH /repos/:user/:repo/issues/:id
132+
PATCH /repos/:user/:repo/issues/:number
133133

134134
### Input
135135

‎content/v3/issues/comments.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can read more about the use of mime types in the API
1010

1111
## List comments on an issue
1212

13-
GET /repos/:user/:repo/issues/:id/comments
13+
GET /repos/:user/:repo/issues/:number/comments
1414

1515
### Response
1616

@@ -28,7 +28,7 @@ You can read more about the use of mime types in the API
2828

2929
## Create a comment
3030

31-
POST /repos/:user/:repo/issues/:id/comments
31+
POST /repos/:user/:repo/issues/:number/comments
3232

3333
### Input
3434

‎content/v3/issues/events.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ assigned
4848

4949
## List events for an issue
5050

51-
GET /repos/:user/:repo/issues/:issue_id/events
51+
GET /repos/:user/:repo/issues/:issue_number/events
5252

5353
### Response
5454

‎content/v3/issues/labels.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ title: Issue Labels | GitHub API
1515

1616
## Get a single label
1717

18-
GET /repos/:user/:repo/labels/:id
18+
GET /repos/:user/:repo/labels/:name
1919

2020
### Response
2121

@@ -45,7 +45,7 @@ color
4545

4646
## Update a label
4747

48-
PATCH /repos/:user/:repo/labels/:id
48+
PATCH /repos/:user/:repo/labels/:name
4949

5050
### Input
5151

@@ -64,15 +64,15 @@ color
6464

6565
## Delete a label
6666

67-
DELETE /repos/:user/:repo/labels/:id
67+
DELETE /repos/:user/:repo/labels/:name
6868

6969
### Response
7070

7171
<%= headers 204 %>
7272

7373
## List labels on an issue
7474

75-
GET /repos/:user/:repo/issues/:id/labels
75+
GET /repos/:user/:repo/issues/:number/labels
7676

7777
### Response
7878

@@ -81,7 +81,7 @@ color
8181

8282
## Add labels to an issue
8383

84-
POST /repos/:user/:repo/issues/:id/labels
84+
POST /repos/:user/:repo/issues/:number/labels
8585

8686
### Input
8787

@@ -94,7 +94,7 @@ color
9494

9595
## Remove a label from an issue
9696

97-
DELETE /repos/:user/:repo/issues/:id/labels/:id
97+
DELETE /repos/:user/:repo/issues/:number/labels/:name
9898

9999
### Response
100100

@@ -103,7 +103,7 @@ color
103103

104104
## Replace all labels for an issue
105105

106-
PUT /repos/:user/:repo/issues/:id/labels
106+
PUT /repos/:user/:repo/issues/:number/labels
107107

108108
### Input
109109

@@ -118,15 +118,15 @@ Sending an empty array (`[]`) will remove all Labels from the Issue.
118118

119119
## Remove all labels from an issue
120120

121-
DELETE /repos/:user/:repo/issues/:id/labels
121+
DELETE /repos/:user/:repo/issues/:number/labels
122122

123123
### Response
124124

125125
<%= headers 204 %>
126126

127127
## Get labels for every issue in a milestone
128128

129-
GET /repos/:user/:repo/milestones/:id/labels
129+
GET /repos/:user/:repo/milestones/:number/labels
130130

131131
### Response
132132

‎content/v3/pulls.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ is `open`.
4141

4242
## Get a single pull request
4343

44-
GET /repos/:user/:repo/pulls/:id
44+
GET /repos/:user/:repo/pulls/:number
4545

4646
### Response
4747

@@ -101,7 +101,7 @@ Pull Request.
101101

102102
## Update a pull request
103103

104-
PATCH /repos/:user/:repo/pulls/:id
104+
PATCH /repos/:user/:repo/pulls/:number
105105

106106
### Input
107107

@@ -128,7 +128,7 @@ state
128128

129129
## List commits on a pull request
130130

131-
GET /repos/:user/:repo/pulls/:id/commits
131+
GET /repos/:user/:repo/pulls/:number/commits
132132

133133
### Response
134134

@@ -137,7 +137,7 @@ state
137137

138138
## List pull requests files
139139

140-
GET /repos/:user/:repo/pulls/:id/files
140+
GET /repos/:user/:repo/pulls/:number/files
141141

142142
### Response
143143

@@ -146,7 +146,7 @@ state
146146

147147
## Get if a pull request has been merged
148148

149-
GET /repos/:user/:repo/pulls/:id/merge
149+
GET /repos/:user/:repo/pulls/:number/merge
150150

151151
### Response if pull request has been merged
152152

@@ -158,7 +158,7 @@ state
158158

159159
## Merge a pull request (Merge Button™)
160160

161-
PUT /repos/:user/:repo/pulls/:id/merge
161+
PUT /repos/:user/:repo/pulls/:number/merge
162162

163163
### Input
164164

‎content/v3/pulls/comments.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ types. You can read more about the use of mime types in the API
1515

1616
## List comments on a pull request
1717

18-
GET /repos/:user/:repo/pulls/:id/comments
18+
GET /repos/:user/:repo/pulls/:number/comments
1919

2020
### Response
2121

@@ -24,7 +24,7 @@ types. You can read more about the use of mime types in the API
2424

2525
## Get a single comment
2626

27-
GET /repos/:user/:repo/pulls/comments/:id
27+
GET /repos/:user/:repo/pulls/comments/:number
2828

2929
### Response
3030

@@ -33,7 +33,7 @@ types. You can read more about the use of mime types in the API
3333

3434
## Create a comment
3535

36-
POST /repos/:user/:repo/pulls/:id/comments
36+
POST /repos/:user/:repo/pulls/:number/comments
3737

3838
### Input
3939

@@ -85,7 +85,7 @@ in_reply_to
8585

8686
## Edit a comment
8787

88-
PATCH /repos/:user/:repo/pulls/comments/:id
88+
PATCH /repos/:user/:repo/pulls/comments/:number
8989

9090
### Input
9191

@@ -105,7 +105,7 @@ body
105105

106106
## Delete a comment
107107

108-
DELETE /repos/:user/:repo/pulls/comments/:id
108+
DELETE /repos/:user/:repo/pulls/comments/:number
109109

110110
### Response
111111

0 commit comments

Comments
 (0)