gitabu 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rspec +3 -0
- data/.rubocop.yml +33 -0
- data/CHANGELOG.md +3 -0
- data/Gemfile +10 -0
- data/Gemfile.lock +65 -0
- data/LICENSE.txt +21 -0
- data/README.md +42 -0
- data/Rakefile +12 -0
- data/gitabu.gemspec +41 -0
- data/lib/gitabu/api/v3/actions.rb +3724 -0
- data/lib/gitabu/api/v3/activity.rb +835 -0
- data/lib/gitabu/api/v3/apps.rb +961 -0
- data/lib/gitabu/api/v3/billing.rb +217 -0
- data/lib/gitabu/api/v3/branches.rb +1098 -0
- data/lib/gitabu/api/v3/checks.rb +384 -0
- data/lib/gitabu/api/v3/code_scanning.rb +315 -0
- data/lib/gitabu/api/v3/codes_of_conduct.rb +92 -0
- data/lib/gitabu/api/v3/codespaces.rb +650 -0
- data/lib/gitabu/api/v3/collaborators.rb +341 -0
- data/lib/gitabu/api/v3/commits.rb +428 -0
- data/lib/gitabu/api/v3/dependabot.rb +419 -0
- data/lib/gitabu/api/v3/deploy_keys.rb +152 -0
- data/lib/gitabu/api/v3/deployments.rb +356 -0
- data/lib/gitabu/api/v3/emojis.rb +67 -0
- data/lib/gitabu/api/v3/enterprise_admin.rb +495 -0
- data/lib/gitabu/api/v3/gists.rb +552 -0
- data/lib/gitabu/api/v3/git.rb +409 -0
- data/lib/gitabu/api/v3/gitignore.rb +92 -0
- data/lib/gitabu/api/v3/interactions.rb +275 -0
- data/lib/gitabu/api/v3/issues.rb +1119 -0
- data/lib/gitabu/api/v3/licenses.rb +118 -0
- data/lib/gitabu/api/v3/markdown.rb +94 -0
- data/lib/gitabu/api/v3/meta.rb +142 -0
- data/lib/gitabu/api/v3/metrics.rb +302 -0
- data/lib/gitabu/api/v3/migrations.rb +631 -0
- data/lib/gitabu/api/v3/orgs.rb +1291 -0
- data/lib/gitabu/api/v3/packages.rb +686 -0
- data/lib/gitabu/api/v3/pages.rb +282 -0
- data/lib/gitabu/api/v3/projects.rb +693 -0
- data/lib/gitabu/api/v3/pulls.rb +816 -0
- data/lib/gitabu/api/v3/rate_limit.rb +67 -0
- data/lib/gitabu/api/v3/reactions.rb +734 -0
- data/lib/gitabu/api/v3/releases.rb +411 -0
- data/lib/gitabu/api/v3/repos.rb +1136 -0
- data/lib/gitabu/api/v3/scim.rb +214 -0
- data/lib/gitabu/api/v3/search.rb +217 -0
- data/lib/gitabu/api/v3/secret_scanning.rb +201 -0
- data/lib/gitabu/api/v3/teams.rb +1963 -0
- data/lib/gitabu/api/v3/users.rb +851 -0
- data/lib/gitabu/api/v3/webhooks.rb +379 -0
- data/lib/gitabu/builder.rb +37 -0
- data/lib/gitabu/client.rb +8 -0
- data/lib/gitabu/generator.rb +75 -0
- data/lib/gitabu/http_client.rb +96 -0
- data/lib/gitabu/items.rb +110 -0
- data/lib/gitabu/public/api/v3/actions.json +5779 -0
- data/lib/gitabu/public/api/v3/activity.json +1248 -0
- data/lib/gitabu/public/api/v3/apps.json +1174 -0
- data/lib/gitabu/public/api/v3/billing.json +183 -0
- data/lib/gitabu/public/api/v3/branches.json +1886 -0
- data/lib/gitabu/public/api/v3/checks.json +856 -0
- data/lib/gitabu/public/api/v3/code_scanning.json +666 -0
- data/lib/gitabu/public/api/v3/codes_of_conduct.json +41 -0
- data/lib/gitabu/public/api/v3/codespaces.json +884 -0
- data/lib/gitabu/public/api/v3/collaborators.json +464 -0
- data/lib/gitabu/public/api/v3/commits.json +830 -0
- data/lib/gitabu/public/api/v3/dependabot.json +596 -0
- data/lib/gitabu/public/api/v3/deploy_keys.json +195 -0
- data/lib/gitabu/public/api/v3/deployments.json +698 -0
- data/lib/gitabu/public/api/v3/emojis.json +18 -0
- data/lib/gitabu/public/api/v3/enterprise_admin.json +881 -0
- data/lib/gitabu/public/api/v3/gists.json +689 -0
- data/lib/gitabu/public/api/v3/git.json +735 -0
- data/lib/gitabu/public/api/v3/gitignore.json +41 -0
- data/lib/gitabu/public/api/v3/interactions.json +265 -0
- data/lib/gitabu/public/api/v3/issues.json +2359 -0
- data/lib/gitabu/public/api/v3/licenses.json +100 -0
- data/lib/gitabu/public/api/v3/markdown.json +59 -0
- data/lib/gitabu/public/api/v3/meta.json +69 -0
- data/lib/gitabu/public/api/v3/metrics.json +342 -0
- data/lib/gitabu/public/api/v3/migrations.json +960 -0
- data/lib/gitabu/public/api/v3/orgs.json +1989 -0
- data/lib/gitabu/public/api/v3/packages.json +1078 -0
- data/lib/gitabu/public/api/v3/pages.json +373 -0
- data/lib/gitabu/public/api/v3/projects.json +966 -0
- data/lib/gitabu/public/api/v3/pulls.json +1768 -0
- data/lib/gitabu/public/api/v3/rate_limit.json +18 -0
- data/lib/gitabu/public/api/v3/reactions.json +1425 -0
- data/lib/gitabu/public/api/v3/releases.json +753 -0
- data/lib/gitabu/public/api/v3/repos.json +2314 -0
- data/lib/gitabu/public/api/v3/scim.json +412 -0
- data/lib/gitabu/public/api/v3/search.json +408 -0
- data/lib/gitabu/public/api/v3/secret_scanning.json +385 -0
- data/lib/gitabu/public/api/v3/teams.json +3126 -0
- data/lib/gitabu/public/api/v3/users.json +956 -0
- data/lib/gitabu/public/api/v3/webhooks.json +667 -0
- data/lib/gitabu/run.rb +237 -0
- data/lib/gitabu/scraper.rb +86 -0
- data/lib/gitabu/templates/template.rb.erb +70 -0
- data/lib/gitabu/version.rb +6 -0
- data/lib/gitabu.rb +57 -0
- data/sig/gitabu.rbs +4 -0
- metadata +177 -0
|
@@ -0,0 +1,1768 @@
|
|
|
1
|
+
{
|
|
2
|
+
"result": [
|
|
3
|
+
{
|
|
4
|
+
"namespace_description": "List pull requests",
|
|
5
|
+
"method": "get",
|
|
6
|
+
"endpoint": "/repos/{owner}/{repo}/pulls",
|
|
7
|
+
"field_0": {
|
|
8
|
+
"field_type": "header",
|
|
9
|
+
"fields": {
|
|
10
|
+
"name": "accept",
|
|
11
|
+
"type": "string",
|
|
12
|
+
"in": "header",
|
|
13
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"field_1": {
|
|
17
|
+
"field_type": "path",
|
|
18
|
+
"fields": {
|
|
19
|
+
"name": "owner",
|
|
20
|
+
"type": "string",
|
|
21
|
+
"in": "path",
|
|
22
|
+
"description": ""
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"field_2": {
|
|
26
|
+
"field_type": "path",
|
|
27
|
+
"fields": {
|
|
28
|
+
"name": "repo",
|
|
29
|
+
"type": "string",
|
|
30
|
+
"in": "path",
|
|
31
|
+
"description": ""
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"field_3": {
|
|
35
|
+
"field_type": "query",
|
|
36
|
+
"fields": {
|
|
37
|
+
"name": "state",
|
|
38
|
+
"type": "string",
|
|
39
|
+
"in": "query",
|
|
40
|
+
"description": "Either open, closed, or all to filter by state.Default: open"
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"field_4": {
|
|
44
|
+
"field_type": "query",
|
|
45
|
+
"fields": {
|
|
46
|
+
"name": "head",
|
|
47
|
+
"type": "string",
|
|
48
|
+
"in": "query",
|
|
49
|
+
"description": "Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch."
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
"field_5": {
|
|
53
|
+
"field_type": "query",
|
|
54
|
+
"fields": {
|
|
55
|
+
"name": "base",
|
|
56
|
+
"type": "string",
|
|
57
|
+
"in": "query",
|
|
58
|
+
"description": "Filter pulls by base branch name. Example: gh-pages."
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
"field_6": {
|
|
62
|
+
"field_type": "query",
|
|
63
|
+
"fields": {
|
|
64
|
+
"name": "sort",
|
|
65
|
+
"type": "string",
|
|
66
|
+
"in": "query",
|
|
67
|
+
"description": "What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).Default: created"
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"field_7": {
|
|
71
|
+
"field_type": "query",
|
|
72
|
+
"fields": {
|
|
73
|
+
"name": "direction",
|
|
74
|
+
"type": "string",
|
|
75
|
+
"in": "query",
|
|
76
|
+
"description": "The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc."
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"field_8": {
|
|
80
|
+
"field_type": "query",
|
|
81
|
+
"fields": {
|
|
82
|
+
"name": "per_page",
|
|
83
|
+
"type": "integer",
|
|
84
|
+
"in": "query",
|
|
85
|
+
"description": "Results per page (max 100)Default: 30"
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"field_9": {
|
|
89
|
+
"field_type": "query",
|
|
90
|
+
"fields": {
|
|
91
|
+
"name": "page",
|
|
92
|
+
"type": "integer",
|
|
93
|
+
"in": "query",
|
|
94
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"namespace_description": "Create a pull request",
|
|
100
|
+
"method": "post",
|
|
101
|
+
"endpoint": "/repos/{owner}/{repo}/pulls",
|
|
102
|
+
"field_0": {
|
|
103
|
+
"field_type": "header",
|
|
104
|
+
"fields": {
|
|
105
|
+
"name": "accept",
|
|
106
|
+
"type": "string",
|
|
107
|
+
"in": "header",
|
|
108
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
109
|
+
}
|
|
110
|
+
},
|
|
111
|
+
"field_1": {
|
|
112
|
+
"field_type": "path",
|
|
113
|
+
"fields": {
|
|
114
|
+
"name": "owner",
|
|
115
|
+
"type": "string",
|
|
116
|
+
"in": "path",
|
|
117
|
+
"description": ""
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
"field_2": {
|
|
121
|
+
"field_type": "path",
|
|
122
|
+
"fields": {
|
|
123
|
+
"name": "repo",
|
|
124
|
+
"type": "string",
|
|
125
|
+
"in": "path",
|
|
126
|
+
"description": ""
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
"field_3": {
|
|
130
|
+
"field_type": "body",
|
|
131
|
+
"fields": {
|
|
132
|
+
"name": "title",
|
|
133
|
+
"type": "string",
|
|
134
|
+
"in": "body",
|
|
135
|
+
"description": "The title of the new pull request."
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
"field_4": {
|
|
139
|
+
"field_type": "body",
|
|
140
|
+
"fields": {
|
|
141
|
+
"name": "head",
|
|
142
|
+
"type": "string",
|
|
143
|
+
"in": "body",
|
|
144
|
+
"description": "Required. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch."
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"field_5": {
|
|
148
|
+
"field_type": "body",
|
|
149
|
+
"fields": {
|
|
150
|
+
"name": "base",
|
|
151
|
+
"type": "string",
|
|
152
|
+
"in": "body",
|
|
153
|
+
"description": "Required. The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository."
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"field_6": {
|
|
157
|
+
"field_type": "body",
|
|
158
|
+
"fields": {
|
|
159
|
+
"name": "body",
|
|
160
|
+
"type": "string",
|
|
161
|
+
"in": "body",
|
|
162
|
+
"description": "The contents of the pull request."
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
"field_7": {
|
|
166
|
+
"field_type": "body",
|
|
167
|
+
"fields": {
|
|
168
|
+
"name": "maintainer_can_modify",
|
|
169
|
+
"type": "boolean",
|
|
170
|
+
"in": "body",
|
|
171
|
+
"description": "Indicates whether maintainers can modify the pull request."
|
|
172
|
+
}
|
|
173
|
+
},
|
|
174
|
+
"field_8": {
|
|
175
|
+
"field_type": "body",
|
|
176
|
+
"fields": {
|
|
177
|
+
"name": "draft",
|
|
178
|
+
"type": "boolean",
|
|
179
|
+
"in": "body",
|
|
180
|
+
"description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more."
|
|
181
|
+
}
|
|
182
|
+
},
|
|
183
|
+
"field_9": {
|
|
184
|
+
"field_type": "body",
|
|
185
|
+
"fields": {
|
|
186
|
+
"name": "issue",
|
|
187
|
+
"type": "integer",
|
|
188
|
+
"in": "body",
|
|
189
|
+
"description": ""
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"namespace_description": "Get a pull request",
|
|
195
|
+
"method": "get",
|
|
196
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}",
|
|
197
|
+
"field_0": {
|
|
198
|
+
"field_type": "header",
|
|
199
|
+
"fields": {
|
|
200
|
+
"name": "accept",
|
|
201
|
+
"type": "string",
|
|
202
|
+
"in": "header",
|
|
203
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
"field_1": {
|
|
207
|
+
"field_type": "path",
|
|
208
|
+
"fields": {
|
|
209
|
+
"name": "owner",
|
|
210
|
+
"type": "string",
|
|
211
|
+
"in": "path",
|
|
212
|
+
"description": ""
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
"field_2": {
|
|
216
|
+
"field_type": "path",
|
|
217
|
+
"fields": {
|
|
218
|
+
"name": "repo",
|
|
219
|
+
"type": "string",
|
|
220
|
+
"in": "path",
|
|
221
|
+
"description": ""
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
"field_3": {
|
|
225
|
+
"field_type": "path",
|
|
226
|
+
"fields": {
|
|
227
|
+
"name": "pull_number",
|
|
228
|
+
"type": "integer",
|
|
229
|
+
"in": "path",
|
|
230
|
+
"description": ""
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"namespace_description": "Update a pull request",
|
|
236
|
+
"method": "patch",
|
|
237
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}",
|
|
238
|
+
"field_0": {
|
|
239
|
+
"field_type": "header",
|
|
240
|
+
"fields": {
|
|
241
|
+
"name": "accept",
|
|
242
|
+
"type": "string",
|
|
243
|
+
"in": "header",
|
|
244
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"field_1": {
|
|
248
|
+
"field_type": "path",
|
|
249
|
+
"fields": {
|
|
250
|
+
"name": "owner",
|
|
251
|
+
"type": "string",
|
|
252
|
+
"in": "path",
|
|
253
|
+
"description": ""
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
"field_2": {
|
|
257
|
+
"field_type": "path",
|
|
258
|
+
"fields": {
|
|
259
|
+
"name": "repo",
|
|
260
|
+
"type": "string",
|
|
261
|
+
"in": "path",
|
|
262
|
+
"description": ""
|
|
263
|
+
}
|
|
264
|
+
},
|
|
265
|
+
"field_3": {
|
|
266
|
+
"field_type": "path",
|
|
267
|
+
"fields": {
|
|
268
|
+
"name": "pull_number",
|
|
269
|
+
"type": "integer",
|
|
270
|
+
"in": "path",
|
|
271
|
+
"description": ""
|
|
272
|
+
}
|
|
273
|
+
},
|
|
274
|
+
"field_4": {
|
|
275
|
+
"field_type": "body",
|
|
276
|
+
"fields": {
|
|
277
|
+
"name": "title",
|
|
278
|
+
"type": "string",
|
|
279
|
+
"in": "body",
|
|
280
|
+
"description": "The title of the pull request."
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
"field_5": {
|
|
284
|
+
"field_type": "body",
|
|
285
|
+
"fields": {
|
|
286
|
+
"name": "body",
|
|
287
|
+
"type": "string",
|
|
288
|
+
"in": "body",
|
|
289
|
+
"description": "The contents of the pull request."
|
|
290
|
+
}
|
|
291
|
+
},
|
|
292
|
+
"field_6": {
|
|
293
|
+
"field_type": "body",
|
|
294
|
+
"fields": {
|
|
295
|
+
"name": "state",
|
|
296
|
+
"type": "string",
|
|
297
|
+
"in": "body",
|
|
298
|
+
"description": "State of this Pull Request. Either open or closed."
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"field_7": {
|
|
302
|
+
"field_type": "body",
|
|
303
|
+
"fields": {
|
|
304
|
+
"name": "base",
|
|
305
|
+
"type": "string",
|
|
306
|
+
"in": "body",
|
|
307
|
+
"description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository."
|
|
308
|
+
}
|
|
309
|
+
},
|
|
310
|
+
"field_8": {
|
|
311
|
+
"field_type": "body",
|
|
312
|
+
"fields": {
|
|
313
|
+
"name": "maintainer_can_modify",
|
|
314
|
+
"type": "boolean",
|
|
315
|
+
"in": "body",
|
|
316
|
+
"description": "Indicates whether maintainers can modify the pull request."
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"namespace_description": "List commits on a pull request",
|
|
322
|
+
"method": "get",
|
|
323
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/commits",
|
|
324
|
+
"field_0": {
|
|
325
|
+
"field_type": "header",
|
|
326
|
+
"fields": {
|
|
327
|
+
"name": "accept",
|
|
328
|
+
"type": "string",
|
|
329
|
+
"in": "header",
|
|
330
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
331
|
+
}
|
|
332
|
+
},
|
|
333
|
+
"field_1": {
|
|
334
|
+
"field_type": "path",
|
|
335
|
+
"fields": {
|
|
336
|
+
"name": "owner",
|
|
337
|
+
"type": "string",
|
|
338
|
+
"in": "path",
|
|
339
|
+
"description": ""
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
"field_2": {
|
|
343
|
+
"field_type": "path",
|
|
344
|
+
"fields": {
|
|
345
|
+
"name": "repo",
|
|
346
|
+
"type": "string",
|
|
347
|
+
"in": "path",
|
|
348
|
+
"description": ""
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"field_3": {
|
|
352
|
+
"field_type": "path",
|
|
353
|
+
"fields": {
|
|
354
|
+
"name": "pull_number",
|
|
355
|
+
"type": "integer",
|
|
356
|
+
"in": "path",
|
|
357
|
+
"description": ""
|
|
358
|
+
}
|
|
359
|
+
},
|
|
360
|
+
"field_4": {
|
|
361
|
+
"field_type": "query",
|
|
362
|
+
"fields": {
|
|
363
|
+
"name": "per_page",
|
|
364
|
+
"type": "integer",
|
|
365
|
+
"in": "query",
|
|
366
|
+
"description": "Results per page (max 100)Default: 30"
|
|
367
|
+
}
|
|
368
|
+
},
|
|
369
|
+
"field_5": {
|
|
370
|
+
"field_type": "query",
|
|
371
|
+
"fields": {
|
|
372
|
+
"name": "page",
|
|
373
|
+
"type": "integer",
|
|
374
|
+
"in": "query",
|
|
375
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"namespace_description": "List pull requests files",
|
|
381
|
+
"method": "get",
|
|
382
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/files",
|
|
383
|
+
"field_0": {
|
|
384
|
+
"field_type": "header",
|
|
385
|
+
"fields": {
|
|
386
|
+
"name": "accept",
|
|
387
|
+
"type": "string",
|
|
388
|
+
"in": "header",
|
|
389
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"field_1": {
|
|
393
|
+
"field_type": "path",
|
|
394
|
+
"fields": {
|
|
395
|
+
"name": "owner",
|
|
396
|
+
"type": "string",
|
|
397
|
+
"in": "path",
|
|
398
|
+
"description": ""
|
|
399
|
+
}
|
|
400
|
+
},
|
|
401
|
+
"field_2": {
|
|
402
|
+
"field_type": "path",
|
|
403
|
+
"fields": {
|
|
404
|
+
"name": "repo",
|
|
405
|
+
"type": "string",
|
|
406
|
+
"in": "path",
|
|
407
|
+
"description": ""
|
|
408
|
+
}
|
|
409
|
+
},
|
|
410
|
+
"field_3": {
|
|
411
|
+
"field_type": "path",
|
|
412
|
+
"fields": {
|
|
413
|
+
"name": "pull_number",
|
|
414
|
+
"type": "integer",
|
|
415
|
+
"in": "path",
|
|
416
|
+
"description": ""
|
|
417
|
+
}
|
|
418
|
+
},
|
|
419
|
+
"field_4": {
|
|
420
|
+
"field_type": "query",
|
|
421
|
+
"fields": {
|
|
422
|
+
"name": "per_page",
|
|
423
|
+
"type": "integer",
|
|
424
|
+
"in": "query",
|
|
425
|
+
"description": "Results per page (max 100)Default: 30"
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
"field_5": {
|
|
429
|
+
"field_type": "query",
|
|
430
|
+
"fields": {
|
|
431
|
+
"name": "page",
|
|
432
|
+
"type": "integer",
|
|
433
|
+
"in": "query",
|
|
434
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
435
|
+
}
|
|
436
|
+
}
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"namespace_description": "Check if a pull request has been merged",
|
|
440
|
+
"method": "get",
|
|
441
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
|
|
442
|
+
"field_0": {
|
|
443
|
+
"field_type": "header",
|
|
444
|
+
"fields": {
|
|
445
|
+
"name": "accept",
|
|
446
|
+
"type": "string",
|
|
447
|
+
"in": "header",
|
|
448
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
449
|
+
}
|
|
450
|
+
},
|
|
451
|
+
"field_1": {
|
|
452
|
+
"field_type": "path",
|
|
453
|
+
"fields": {
|
|
454
|
+
"name": "owner",
|
|
455
|
+
"type": "string",
|
|
456
|
+
"in": "path",
|
|
457
|
+
"description": ""
|
|
458
|
+
}
|
|
459
|
+
},
|
|
460
|
+
"field_2": {
|
|
461
|
+
"field_type": "path",
|
|
462
|
+
"fields": {
|
|
463
|
+
"name": "repo",
|
|
464
|
+
"type": "string",
|
|
465
|
+
"in": "path",
|
|
466
|
+
"description": ""
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
"field_3": {
|
|
470
|
+
"field_type": "path",
|
|
471
|
+
"fields": {
|
|
472
|
+
"name": "pull_number",
|
|
473
|
+
"type": "integer",
|
|
474
|
+
"in": "path",
|
|
475
|
+
"description": ""
|
|
476
|
+
}
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"namespace_description": "Merge a pull request",
|
|
481
|
+
"method": "put",
|
|
482
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
|
|
483
|
+
"field_0": {
|
|
484
|
+
"field_type": "header",
|
|
485
|
+
"fields": {
|
|
486
|
+
"name": "accept",
|
|
487
|
+
"type": "string",
|
|
488
|
+
"in": "header",
|
|
489
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
490
|
+
}
|
|
491
|
+
},
|
|
492
|
+
"field_1": {
|
|
493
|
+
"field_type": "path",
|
|
494
|
+
"fields": {
|
|
495
|
+
"name": "owner",
|
|
496
|
+
"type": "string",
|
|
497
|
+
"in": "path",
|
|
498
|
+
"description": ""
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
"field_2": {
|
|
502
|
+
"field_type": "path",
|
|
503
|
+
"fields": {
|
|
504
|
+
"name": "repo",
|
|
505
|
+
"type": "string",
|
|
506
|
+
"in": "path",
|
|
507
|
+
"description": ""
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
"field_3": {
|
|
511
|
+
"field_type": "path",
|
|
512
|
+
"fields": {
|
|
513
|
+
"name": "pull_number",
|
|
514
|
+
"type": "integer",
|
|
515
|
+
"in": "path",
|
|
516
|
+
"description": ""
|
|
517
|
+
}
|
|
518
|
+
},
|
|
519
|
+
"field_4": {
|
|
520
|
+
"field_type": "body",
|
|
521
|
+
"fields": {
|
|
522
|
+
"name": "commit_title",
|
|
523
|
+
"type": "string",
|
|
524
|
+
"in": "body",
|
|
525
|
+
"description": "Title for the automatic commit message."
|
|
526
|
+
}
|
|
527
|
+
},
|
|
528
|
+
"field_5": {
|
|
529
|
+
"field_type": "body",
|
|
530
|
+
"fields": {
|
|
531
|
+
"name": "commit_message",
|
|
532
|
+
"type": "string",
|
|
533
|
+
"in": "body",
|
|
534
|
+
"description": "Extra detail to append to automatic commit message."
|
|
535
|
+
}
|
|
536
|
+
},
|
|
537
|
+
"field_6": {
|
|
538
|
+
"field_type": "body",
|
|
539
|
+
"fields": {
|
|
540
|
+
"name": "sha",
|
|
541
|
+
"type": "string",
|
|
542
|
+
"in": "body",
|
|
543
|
+
"description": "SHA that pull request head must match to allow merge."
|
|
544
|
+
}
|
|
545
|
+
},
|
|
546
|
+
"field_7": {
|
|
547
|
+
"field_type": "body",
|
|
548
|
+
"fields": {
|
|
549
|
+
"name": "merge_method",
|
|
550
|
+
"type": "string",
|
|
551
|
+
"in": "body",
|
|
552
|
+
"description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge."
|
|
553
|
+
}
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"namespace_description": "Update a pull request branch",
|
|
558
|
+
"method": "put",
|
|
559
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch",
|
|
560
|
+
"field_0": {
|
|
561
|
+
"field_type": "header",
|
|
562
|
+
"fields": {
|
|
563
|
+
"name": "accept",
|
|
564
|
+
"type": "string",
|
|
565
|
+
"in": "header",
|
|
566
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
"field_1": {
|
|
570
|
+
"field_type": "path",
|
|
571
|
+
"fields": {
|
|
572
|
+
"name": "owner",
|
|
573
|
+
"type": "string",
|
|
574
|
+
"in": "path",
|
|
575
|
+
"description": ""
|
|
576
|
+
}
|
|
577
|
+
},
|
|
578
|
+
"field_2": {
|
|
579
|
+
"field_type": "path",
|
|
580
|
+
"fields": {
|
|
581
|
+
"name": "repo",
|
|
582
|
+
"type": "string",
|
|
583
|
+
"in": "path",
|
|
584
|
+
"description": ""
|
|
585
|
+
}
|
|
586
|
+
},
|
|
587
|
+
"field_3": {
|
|
588
|
+
"field_type": "path",
|
|
589
|
+
"fields": {
|
|
590
|
+
"name": "pull_number",
|
|
591
|
+
"type": "integer",
|
|
592
|
+
"in": "path",
|
|
593
|
+
"description": ""
|
|
594
|
+
}
|
|
595
|
+
},
|
|
596
|
+
"field_4": {
|
|
597
|
+
"field_type": "body",
|
|
598
|
+
"fields": {
|
|
599
|
+
"name": "expected_head_sha",
|
|
600
|
+
"type": "string",
|
|
601
|
+
"in": "body",
|
|
602
|
+
"description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref."
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"namespace_description": "List review comments in a repository",
|
|
608
|
+
"method": "get",
|
|
609
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/comments",
|
|
610
|
+
"field_0": {
|
|
611
|
+
"field_type": "header",
|
|
612
|
+
"fields": {
|
|
613
|
+
"name": "accept",
|
|
614
|
+
"type": "string",
|
|
615
|
+
"in": "header",
|
|
616
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
617
|
+
}
|
|
618
|
+
},
|
|
619
|
+
"field_1": {
|
|
620
|
+
"field_type": "path",
|
|
621
|
+
"fields": {
|
|
622
|
+
"name": "owner",
|
|
623
|
+
"type": "string",
|
|
624
|
+
"in": "path",
|
|
625
|
+
"description": ""
|
|
626
|
+
}
|
|
627
|
+
},
|
|
628
|
+
"field_2": {
|
|
629
|
+
"field_type": "path",
|
|
630
|
+
"fields": {
|
|
631
|
+
"name": "repo",
|
|
632
|
+
"type": "string",
|
|
633
|
+
"in": "path",
|
|
634
|
+
"description": ""
|
|
635
|
+
}
|
|
636
|
+
},
|
|
637
|
+
"field_3": {
|
|
638
|
+
"field_type": "query",
|
|
639
|
+
"fields": {
|
|
640
|
+
"name": "sort",
|
|
641
|
+
"type": "string",
|
|
642
|
+
"in": "query",
|
|
643
|
+
"description": ""
|
|
644
|
+
}
|
|
645
|
+
},
|
|
646
|
+
"field_4": {
|
|
647
|
+
"field_type": "query",
|
|
648
|
+
"fields": {
|
|
649
|
+
"name": "direction",
|
|
650
|
+
"type": "string",
|
|
651
|
+
"in": "query",
|
|
652
|
+
"description": "Can be either asc or desc. Ignored without sort parameter."
|
|
653
|
+
}
|
|
654
|
+
},
|
|
655
|
+
"field_5": {
|
|
656
|
+
"field_type": "query",
|
|
657
|
+
"fields": {
|
|
658
|
+
"name": "since",
|
|
659
|
+
"type": "string",
|
|
660
|
+
"in": "query",
|
|
661
|
+
"description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
|
|
662
|
+
}
|
|
663
|
+
},
|
|
664
|
+
"field_6": {
|
|
665
|
+
"field_type": "query",
|
|
666
|
+
"fields": {
|
|
667
|
+
"name": "per_page",
|
|
668
|
+
"type": "integer",
|
|
669
|
+
"in": "query",
|
|
670
|
+
"description": "Results per page (max 100)Default: 30"
|
|
671
|
+
}
|
|
672
|
+
},
|
|
673
|
+
"field_7": {
|
|
674
|
+
"field_type": "query",
|
|
675
|
+
"fields": {
|
|
676
|
+
"name": "page",
|
|
677
|
+
"type": "integer",
|
|
678
|
+
"in": "query",
|
|
679
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"namespace_description": "Get a review comment for a pull request",
|
|
685
|
+
"method": "get",
|
|
686
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
|
|
687
|
+
"field_0": {
|
|
688
|
+
"field_type": "header",
|
|
689
|
+
"fields": {
|
|
690
|
+
"name": "accept",
|
|
691
|
+
"type": "string",
|
|
692
|
+
"in": "header",
|
|
693
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
694
|
+
}
|
|
695
|
+
},
|
|
696
|
+
"field_1": {
|
|
697
|
+
"field_type": "path",
|
|
698
|
+
"fields": {
|
|
699
|
+
"name": "owner",
|
|
700
|
+
"type": "string",
|
|
701
|
+
"in": "path",
|
|
702
|
+
"description": ""
|
|
703
|
+
}
|
|
704
|
+
},
|
|
705
|
+
"field_2": {
|
|
706
|
+
"field_type": "path",
|
|
707
|
+
"fields": {
|
|
708
|
+
"name": "repo",
|
|
709
|
+
"type": "string",
|
|
710
|
+
"in": "path",
|
|
711
|
+
"description": ""
|
|
712
|
+
}
|
|
713
|
+
},
|
|
714
|
+
"field_3": {
|
|
715
|
+
"field_type": "path",
|
|
716
|
+
"fields": {
|
|
717
|
+
"name": "comment_id",
|
|
718
|
+
"type": "integer",
|
|
719
|
+
"in": "path",
|
|
720
|
+
"description": "comment_id parameter"
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"namespace_description": "Update a review comment for a pull request",
|
|
726
|
+
"method": "patch",
|
|
727
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
|
|
728
|
+
"field_0": {
|
|
729
|
+
"field_type": "header",
|
|
730
|
+
"fields": {
|
|
731
|
+
"name": "accept",
|
|
732
|
+
"type": "string",
|
|
733
|
+
"in": "header",
|
|
734
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
735
|
+
}
|
|
736
|
+
},
|
|
737
|
+
"field_1": {
|
|
738
|
+
"field_type": "path",
|
|
739
|
+
"fields": {
|
|
740
|
+
"name": "owner",
|
|
741
|
+
"type": "string",
|
|
742
|
+
"in": "path",
|
|
743
|
+
"description": ""
|
|
744
|
+
}
|
|
745
|
+
},
|
|
746
|
+
"field_2": {
|
|
747
|
+
"field_type": "path",
|
|
748
|
+
"fields": {
|
|
749
|
+
"name": "repo",
|
|
750
|
+
"type": "string",
|
|
751
|
+
"in": "path",
|
|
752
|
+
"description": ""
|
|
753
|
+
}
|
|
754
|
+
},
|
|
755
|
+
"field_3": {
|
|
756
|
+
"field_type": "path",
|
|
757
|
+
"fields": {
|
|
758
|
+
"name": "comment_id",
|
|
759
|
+
"type": "integer",
|
|
760
|
+
"in": "path",
|
|
761
|
+
"description": "comment_id parameter"
|
|
762
|
+
}
|
|
763
|
+
},
|
|
764
|
+
"field_4": {
|
|
765
|
+
"field_type": "body",
|
|
766
|
+
"fields": {
|
|
767
|
+
"name": "body",
|
|
768
|
+
"type": "string",
|
|
769
|
+
"in": "body",
|
|
770
|
+
"description": "Required. The text of the reply to the review comment."
|
|
771
|
+
}
|
|
772
|
+
}
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"namespace_description": "Delete a review comment for a pull request",
|
|
776
|
+
"method": "delete",
|
|
777
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
|
|
778
|
+
"field_0": {
|
|
779
|
+
"field_type": "header",
|
|
780
|
+
"fields": {
|
|
781
|
+
"name": "accept",
|
|
782
|
+
"type": "string",
|
|
783
|
+
"in": "header",
|
|
784
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
785
|
+
}
|
|
786
|
+
},
|
|
787
|
+
"field_1": {
|
|
788
|
+
"field_type": "path",
|
|
789
|
+
"fields": {
|
|
790
|
+
"name": "owner",
|
|
791
|
+
"type": "string",
|
|
792
|
+
"in": "path",
|
|
793
|
+
"description": ""
|
|
794
|
+
}
|
|
795
|
+
},
|
|
796
|
+
"field_2": {
|
|
797
|
+
"field_type": "path",
|
|
798
|
+
"fields": {
|
|
799
|
+
"name": "repo",
|
|
800
|
+
"type": "string",
|
|
801
|
+
"in": "path",
|
|
802
|
+
"description": ""
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
"field_3": {
|
|
806
|
+
"field_type": "path",
|
|
807
|
+
"fields": {
|
|
808
|
+
"name": "comment_id",
|
|
809
|
+
"type": "integer",
|
|
810
|
+
"in": "path",
|
|
811
|
+
"description": "comment_id parameter"
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
},
|
|
815
|
+
{
|
|
816
|
+
"namespace_description": "List review comments on a pull request",
|
|
817
|
+
"method": "get",
|
|
818
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
|
|
819
|
+
"field_0": {
|
|
820
|
+
"field_type": "header",
|
|
821
|
+
"fields": {
|
|
822
|
+
"name": "accept",
|
|
823
|
+
"type": "string",
|
|
824
|
+
"in": "header",
|
|
825
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
826
|
+
}
|
|
827
|
+
},
|
|
828
|
+
"field_1": {
|
|
829
|
+
"field_type": "path",
|
|
830
|
+
"fields": {
|
|
831
|
+
"name": "owner",
|
|
832
|
+
"type": "string",
|
|
833
|
+
"in": "path",
|
|
834
|
+
"description": ""
|
|
835
|
+
}
|
|
836
|
+
},
|
|
837
|
+
"field_2": {
|
|
838
|
+
"field_type": "path",
|
|
839
|
+
"fields": {
|
|
840
|
+
"name": "repo",
|
|
841
|
+
"type": "string",
|
|
842
|
+
"in": "path",
|
|
843
|
+
"description": ""
|
|
844
|
+
}
|
|
845
|
+
},
|
|
846
|
+
"field_3": {
|
|
847
|
+
"field_type": "path",
|
|
848
|
+
"fields": {
|
|
849
|
+
"name": "pull_number",
|
|
850
|
+
"type": "integer",
|
|
851
|
+
"in": "path",
|
|
852
|
+
"description": ""
|
|
853
|
+
}
|
|
854
|
+
},
|
|
855
|
+
"field_4": {
|
|
856
|
+
"field_type": "query",
|
|
857
|
+
"fields": {
|
|
858
|
+
"name": "sort",
|
|
859
|
+
"type": "string",
|
|
860
|
+
"in": "query",
|
|
861
|
+
"description": "One of created (when the repository was starred) or updated (when it was last pushed to).Default: created"
|
|
862
|
+
}
|
|
863
|
+
},
|
|
864
|
+
"field_5": {
|
|
865
|
+
"field_type": "query",
|
|
866
|
+
"fields": {
|
|
867
|
+
"name": "direction",
|
|
868
|
+
"type": "string",
|
|
869
|
+
"in": "query",
|
|
870
|
+
"description": "Can be either asc or desc. Ignored without sort parameter."
|
|
871
|
+
}
|
|
872
|
+
},
|
|
873
|
+
"field_6": {
|
|
874
|
+
"field_type": "query",
|
|
875
|
+
"fields": {
|
|
876
|
+
"name": "since",
|
|
877
|
+
"type": "string",
|
|
878
|
+
"in": "query",
|
|
879
|
+
"description": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
|
|
880
|
+
}
|
|
881
|
+
},
|
|
882
|
+
"field_7": {
|
|
883
|
+
"field_type": "query",
|
|
884
|
+
"fields": {
|
|
885
|
+
"name": "per_page",
|
|
886
|
+
"type": "integer",
|
|
887
|
+
"in": "query",
|
|
888
|
+
"description": "Results per page (max 100)Default: 30"
|
|
889
|
+
}
|
|
890
|
+
},
|
|
891
|
+
"field_8": {
|
|
892
|
+
"field_type": "query",
|
|
893
|
+
"fields": {
|
|
894
|
+
"name": "page",
|
|
895
|
+
"type": "integer",
|
|
896
|
+
"in": "query",
|
|
897
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
"namespace_description": "Create a review comment for a pull request",
|
|
903
|
+
"method": "post",
|
|
904
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
|
|
905
|
+
"field_0": {
|
|
906
|
+
"field_type": "header",
|
|
907
|
+
"fields": {
|
|
908
|
+
"name": "accept",
|
|
909
|
+
"type": "string",
|
|
910
|
+
"in": "header",
|
|
911
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
912
|
+
}
|
|
913
|
+
},
|
|
914
|
+
"field_1": {
|
|
915
|
+
"field_type": "path",
|
|
916
|
+
"fields": {
|
|
917
|
+
"name": "owner",
|
|
918
|
+
"type": "string",
|
|
919
|
+
"in": "path",
|
|
920
|
+
"description": ""
|
|
921
|
+
}
|
|
922
|
+
},
|
|
923
|
+
"field_2": {
|
|
924
|
+
"field_type": "path",
|
|
925
|
+
"fields": {
|
|
926
|
+
"name": "repo",
|
|
927
|
+
"type": "string",
|
|
928
|
+
"in": "path",
|
|
929
|
+
"description": ""
|
|
930
|
+
}
|
|
931
|
+
},
|
|
932
|
+
"field_3": {
|
|
933
|
+
"field_type": "path",
|
|
934
|
+
"fields": {
|
|
935
|
+
"name": "pull_number",
|
|
936
|
+
"type": "integer",
|
|
937
|
+
"in": "path",
|
|
938
|
+
"description": ""
|
|
939
|
+
}
|
|
940
|
+
},
|
|
941
|
+
"field_4": {
|
|
942
|
+
"field_type": "body",
|
|
943
|
+
"fields": {
|
|
944
|
+
"name": "body",
|
|
945
|
+
"type": "string",
|
|
946
|
+
"in": "body",
|
|
947
|
+
"description": "Required. The text of the review comment."
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
"field_5": {
|
|
951
|
+
"field_type": "body",
|
|
952
|
+
"fields": {
|
|
953
|
+
"name": "commit_id",
|
|
954
|
+
"type": "string",
|
|
955
|
+
"in": "body",
|
|
956
|
+
"description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position."
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"field_6": {
|
|
960
|
+
"field_type": "body",
|
|
961
|
+
"fields": {
|
|
962
|
+
"name": "path",
|
|
963
|
+
"type": "string",
|
|
964
|
+
"in": "body",
|
|
965
|
+
"description": "The relative path to the file that necessitates a comment."
|
|
966
|
+
}
|
|
967
|
+
},
|
|
968
|
+
"field_7": {
|
|
969
|
+
"field_type": "body",
|
|
970
|
+
"fields": {
|
|
971
|
+
"name": "position",
|
|
972
|
+
"type": "integer",
|
|
973
|
+
"in": "body",
|
|
974
|
+
"description": "Required without comfort-fade preview unless using in_reply_to. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
"field_8": {
|
|
978
|
+
"field_type": "body",
|
|
979
|
+
"fields": {
|
|
980
|
+
"name": "side",
|
|
981
|
+
"type": "string",
|
|
982
|
+
"in": "body",
|
|
983
|
+
"description": "Required with comfort-fade preview unless using in_reply_to. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation."
|
|
984
|
+
}
|
|
985
|
+
},
|
|
986
|
+
"field_9": {
|
|
987
|
+
"field_type": "body",
|
|
988
|
+
"fields": {
|
|
989
|
+
"name": "line",
|
|
990
|
+
"type": "integer",
|
|
991
|
+
"in": "body",
|
|
992
|
+
"description": "Required with comfort-fade preview unless using in_reply_to. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to."
|
|
993
|
+
}
|
|
994
|
+
},
|
|
995
|
+
"field_10": {
|
|
996
|
+
"field_type": "body",
|
|
997
|
+
"fields": {
|
|
998
|
+
"name": "start_line",
|
|
999
|
+
"type": "integer",
|
|
1000
|
+
"in": "body",
|
|
1001
|
+
"description": "Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation."
|
|
1002
|
+
}
|
|
1003
|
+
},
|
|
1004
|
+
"field_11": {
|
|
1005
|
+
"field_type": "body",
|
|
1006
|
+
"fields": {
|
|
1007
|
+
"name": "start_side",
|
|
1008
|
+
"type": "string",
|
|
1009
|
+
"in": "body",
|
|
1010
|
+
"description": "Required when using multi-line comments unless using in_reply_to. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context."
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
"field_12": {
|
|
1014
|
+
"field_type": "body",
|
|
1015
|
+
"fields": {
|
|
1016
|
+
"name": "in_reply_to",
|
|
1017
|
+
"type": "integer",
|
|
1018
|
+
"in": "body",
|
|
1019
|
+
"description": "The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored."
|
|
1020
|
+
}
|
|
1021
|
+
}
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"namespace_description": "Create a reply for a review comment",
|
|
1025
|
+
"method": "post",
|
|
1026
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies",
|
|
1027
|
+
"field_0": {
|
|
1028
|
+
"field_type": "header",
|
|
1029
|
+
"fields": {
|
|
1030
|
+
"name": "accept",
|
|
1031
|
+
"type": "string",
|
|
1032
|
+
"in": "header",
|
|
1033
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1034
|
+
}
|
|
1035
|
+
},
|
|
1036
|
+
"field_1": {
|
|
1037
|
+
"field_type": "path",
|
|
1038
|
+
"fields": {
|
|
1039
|
+
"name": "owner",
|
|
1040
|
+
"type": "string",
|
|
1041
|
+
"in": "path",
|
|
1042
|
+
"description": ""
|
|
1043
|
+
}
|
|
1044
|
+
},
|
|
1045
|
+
"field_2": {
|
|
1046
|
+
"field_type": "path",
|
|
1047
|
+
"fields": {
|
|
1048
|
+
"name": "repo",
|
|
1049
|
+
"type": "string",
|
|
1050
|
+
"in": "path",
|
|
1051
|
+
"description": ""
|
|
1052
|
+
}
|
|
1053
|
+
},
|
|
1054
|
+
"field_3": {
|
|
1055
|
+
"field_type": "path",
|
|
1056
|
+
"fields": {
|
|
1057
|
+
"name": "pull_number",
|
|
1058
|
+
"type": "integer",
|
|
1059
|
+
"in": "path",
|
|
1060
|
+
"description": ""
|
|
1061
|
+
}
|
|
1062
|
+
},
|
|
1063
|
+
"field_4": {
|
|
1064
|
+
"field_type": "path",
|
|
1065
|
+
"fields": {
|
|
1066
|
+
"name": "comment_id",
|
|
1067
|
+
"type": "integer",
|
|
1068
|
+
"in": "path",
|
|
1069
|
+
"description": "comment_id parameter"
|
|
1070
|
+
}
|
|
1071
|
+
},
|
|
1072
|
+
"field_5": {
|
|
1073
|
+
"field_type": "body",
|
|
1074
|
+
"fields": {
|
|
1075
|
+
"name": "body",
|
|
1076
|
+
"type": "string",
|
|
1077
|
+
"in": "body",
|
|
1078
|
+
"description": "Required. The text of the review comment."
|
|
1079
|
+
}
|
|
1080
|
+
}
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"namespace_description": "List requested reviewers for a pull request",
|
|
1084
|
+
"method": "get",
|
|
1085
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
|
|
1086
|
+
"field_0": {
|
|
1087
|
+
"field_type": "header",
|
|
1088
|
+
"fields": {
|
|
1089
|
+
"name": "accept",
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"in": "header",
|
|
1092
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"field_1": {
|
|
1096
|
+
"field_type": "path",
|
|
1097
|
+
"fields": {
|
|
1098
|
+
"name": "owner",
|
|
1099
|
+
"type": "string",
|
|
1100
|
+
"in": "path",
|
|
1101
|
+
"description": ""
|
|
1102
|
+
}
|
|
1103
|
+
},
|
|
1104
|
+
"field_2": {
|
|
1105
|
+
"field_type": "path",
|
|
1106
|
+
"fields": {
|
|
1107
|
+
"name": "repo",
|
|
1108
|
+
"type": "string",
|
|
1109
|
+
"in": "path",
|
|
1110
|
+
"description": ""
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
"field_3": {
|
|
1114
|
+
"field_type": "path",
|
|
1115
|
+
"fields": {
|
|
1116
|
+
"name": "pull_number",
|
|
1117
|
+
"type": "integer",
|
|
1118
|
+
"in": "path",
|
|
1119
|
+
"description": ""
|
|
1120
|
+
}
|
|
1121
|
+
},
|
|
1122
|
+
"field_4": {
|
|
1123
|
+
"field_type": "query",
|
|
1124
|
+
"fields": {
|
|
1125
|
+
"name": "per_page",
|
|
1126
|
+
"type": "integer",
|
|
1127
|
+
"in": "query",
|
|
1128
|
+
"description": "Results per page (max 100)Default: 30"
|
|
1129
|
+
}
|
|
1130
|
+
},
|
|
1131
|
+
"field_5": {
|
|
1132
|
+
"field_type": "query",
|
|
1133
|
+
"fields": {
|
|
1134
|
+
"name": "page",
|
|
1135
|
+
"type": "integer",
|
|
1136
|
+
"in": "query",
|
|
1137
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"namespace_description": "Request reviewers for a pull request",
|
|
1143
|
+
"method": "post",
|
|
1144
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
|
|
1145
|
+
"field_0": {
|
|
1146
|
+
"field_type": "header",
|
|
1147
|
+
"fields": {
|
|
1148
|
+
"name": "accept",
|
|
1149
|
+
"type": "string",
|
|
1150
|
+
"in": "header",
|
|
1151
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1152
|
+
}
|
|
1153
|
+
},
|
|
1154
|
+
"field_1": {
|
|
1155
|
+
"field_type": "path",
|
|
1156
|
+
"fields": {
|
|
1157
|
+
"name": "owner",
|
|
1158
|
+
"type": "string",
|
|
1159
|
+
"in": "path",
|
|
1160
|
+
"description": ""
|
|
1161
|
+
}
|
|
1162
|
+
},
|
|
1163
|
+
"field_2": {
|
|
1164
|
+
"field_type": "path",
|
|
1165
|
+
"fields": {
|
|
1166
|
+
"name": "repo",
|
|
1167
|
+
"type": "string",
|
|
1168
|
+
"in": "path",
|
|
1169
|
+
"description": ""
|
|
1170
|
+
}
|
|
1171
|
+
},
|
|
1172
|
+
"field_3": {
|
|
1173
|
+
"field_type": "path",
|
|
1174
|
+
"fields": {
|
|
1175
|
+
"name": "pull_number",
|
|
1176
|
+
"type": "integer",
|
|
1177
|
+
"in": "path",
|
|
1178
|
+
"description": ""
|
|
1179
|
+
}
|
|
1180
|
+
},
|
|
1181
|
+
"field_4": {
|
|
1182
|
+
"field_type": "body",
|
|
1183
|
+
"fields": {
|
|
1184
|
+
"name": "reviewers",
|
|
1185
|
+
"type": "array of strings",
|
|
1186
|
+
"in": "body",
|
|
1187
|
+
"description": "An array of user logins that will be requested."
|
|
1188
|
+
}
|
|
1189
|
+
},
|
|
1190
|
+
"field_5": {
|
|
1191
|
+
"field_type": "body",
|
|
1192
|
+
"fields": {
|
|
1193
|
+
"name": "team_reviewers",
|
|
1194
|
+
"type": "array of strings",
|
|
1195
|
+
"in": "body",
|
|
1196
|
+
"description": "An array of team slugs that will be requested."
|
|
1197
|
+
}
|
|
1198
|
+
}
|
|
1199
|
+
},
|
|
1200
|
+
{
|
|
1201
|
+
"namespace_description": "Remove requested reviewers from a pull request",
|
|
1202
|
+
"method": "delete",
|
|
1203
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
|
|
1204
|
+
"field_0": {
|
|
1205
|
+
"field_type": "header",
|
|
1206
|
+
"fields": {
|
|
1207
|
+
"name": "accept",
|
|
1208
|
+
"type": "string",
|
|
1209
|
+
"in": "header",
|
|
1210
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1211
|
+
}
|
|
1212
|
+
},
|
|
1213
|
+
"field_1": {
|
|
1214
|
+
"field_type": "path",
|
|
1215
|
+
"fields": {
|
|
1216
|
+
"name": "owner",
|
|
1217
|
+
"type": "string",
|
|
1218
|
+
"in": "path",
|
|
1219
|
+
"description": ""
|
|
1220
|
+
}
|
|
1221
|
+
},
|
|
1222
|
+
"field_2": {
|
|
1223
|
+
"field_type": "path",
|
|
1224
|
+
"fields": {
|
|
1225
|
+
"name": "repo",
|
|
1226
|
+
"type": "string",
|
|
1227
|
+
"in": "path",
|
|
1228
|
+
"description": ""
|
|
1229
|
+
}
|
|
1230
|
+
},
|
|
1231
|
+
"field_3": {
|
|
1232
|
+
"field_type": "path",
|
|
1233
|
+
"fields": {
|
|
1234
|
+
"name": "pull_number",
|
|
1235
|
+
"type": "integer",
|
|
1236
|
+
"in": "path",
|
|
1237
|
+
"description": ""
|
|
1238
|
+
}
|
|
1239
|
+
},
|
|
1240
|
+
"field_4": {
|
|
1241
|
+
"field_type": "body",
|
|
1242
|
+
"fields": {
|
|
1243
|
+
"name": "reviewers",
|
|
1244
|
+
"type": "array of strings",
|
|
1245
|
+
"in": "body",
|
|
1246
|
+
"description": "Required. An array of user logins that will be removed."
|
|
1247
|
+
}
|
|
1248
|
+
},
|
|
1249
|
+
"field_5": {
|
|
1250
|
+
"field_type": "body",
|
|
1251
|
+
"fields": {
|
|
1252
|
+
"name": "team_reviewers",
|
|
1253
|
+
"type": "array of strings",
|
|
1254
|
+
"in": "body",
|
|
1255
|
+
"description": "An array of team slugs that will be removed."
|
|
1256
|
+
}
|
|
1257
|
+
}
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"namespace_description": "List reviews for a pull request",
|
|
1261
|
+
"method": "get",
|
|
1262
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
|
|
1263
|
+
"field_0": {
|
|
1264
|
+
"field_type": "header",
|
|
1265
|
+
"fields": {
|
|
1266
|
+
"name": "accept",
|
|
1267
|
+
"type": "string",
|
|
1268
|
+
"in": "header",
|
|
1269
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1270
|
+
}
|
|
1271
|
+
},
|
|
1272
|
+
"field_1": {
|
|
1273
|
+
"field_type": "path",
|
|
1274
|
+
"fields": {
|
|
1275
|
+
"name": "owner",
|
|
1276
|
+
"type": "string",
|
|
1277
|
+
"in": "path",
|
|
1278
|
+
"description": ""
|
|
1279
|
+
}
|
|
1280
|
+
},
|
|
1281
|
+
"field_2": {
|
|
1282
|
+
"field_type": "path",
|
|
1283
|
+
"fields": {
|
|
1284
|
+
"name": "repo",
|
|
1285
|
+
"type": "string",
|
|
1286
|
+
"in": "path",
|
|
1287
|
+
"description": ""
|
|
1288
|
+
}
|
|
1289
|
+
},
|
|
1290
|
+
"field_3": {
|
|
1291
|
+
"field_type": "path",
|
|
1292
|
+
"fields": {
|
|
1293
|
+
"name": "pull_number",
|
|
1294
|
+
"type": "integer",
|
|
1295
|
+
"in": "path",
|
|
1296
|
+
"description": ""
|
|
1297
|
+
}
|
|
1298
|
+
},
|
|
1299
|
+
"field_4": {
|
|
1300
|
+
"field_type": "query",
|
|
1301
|
+
"fields": {
|
|
1302
|
+
"name": "per_page",
|
|
1303
|
+
"type": "integer",
|
|
1304
|
+
"in": "query",
|
|
1305
|
+
"description": "Results per page (max 100)Default: 30"
|
|
1306
|
+
}
|
|
1307
|
+
},
|
|
1308
|
+
"field_5": {
|
|
1309
|
+
"field_type": "query",
|
|
1310
|
+
"fields": {
|
|
1311
|
+
"name": "page",
|
|
1312
|
+
"type": "integer",
|
|
1313
|
+
"in": "query",
|
|
1314
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
1315
|
+
}
|
|
1316
|
+
}
|
|
1317
|
+
},
|
|
1318
|
+
{
|
|
1319
|
+
"namespace_description": "Create a review for a pull request",
|
|
1320
|
+
"method": "post",
|
|
1321
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
|
|
1322
|
+
"field_0": {
|
|
1323
|
+
"field_type": "header",
|
|
1324
|
+
"fields": {
|
|
1325
|
+
"name": "accept",
|
|
1326
|
+
"type": "string",
|
|
1327
|
+
"in": "header",
|
|
1328
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1329
|
+
}
|
|
1330
|
+
},
|
|
1331
|
+
"field_1": {
|
|
1332
|
+
"field_type": "path",
|
|
1333
|
+
"fields": {
|
|
1334
|
+
"name": "owner",
|
|
1335
|
+
"type": "string",
|
|
1336
|
+
"in": "path",
|
|
1337
|
+
"description": ""
|
|
1338
|
+
}
|
|
1339
|
+
},
|
|
1340
|
+
"field_2": {
|
|
1341
|
+
"field_type": "path",
|
|
1342
|
+
"fields": {
|
|
1343
|
+
"name": "repo",
|
|
1344
|
+
"type": "string",
|
|
1345
|
+
"in": "path",
|
|
1346
|
+
"description": ""
|
|
1347
|
+
}
|
|
1348
|
+
},
|
|
1349
|
+
"field_3": {
|
|
1350
|
+
"field_type": "path",
|
|
1351
|
+
"fields": {
|
|
1352
|
+
"name": "pull_number",
|
|
1353
|
+
"type": "integer",
|
|
1354
|
+
"in": "path",
|
|
1355
|
+
"description": ""
|
|
1356
|
+
}
|
|
1357
|
+
},
|
|
1358
|
+
"field_4": {
|
|
1359
|
+
"field_type": "body",
|
|
1360
|
+
"fields": {
|
|
1361
|
+
"name": "commit_id",
|
|
1362
|
+
"type": "string",
|
|
1363
|
+
"in": "body",
|
|
1364
|
+
"description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value."
|
|
1365
|
+
}
|
|
1366
|
+
},
|
|
1367
|
+
"field_5": {
|
|
1368
|
+
"field_type": "body",
|
|
1369
|
+
"fields": {
|
|
1370
|
+
"name": "body",
|
|
1371
|
+
"type": "string",
|
|
1372
|
+
"in": "body",
|
|
1373
|
+
"description": "Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review."
|
|
1374
|
+
}
|
|
1375
|
+
},
|
|
1376
|
+
"field_6": {
|
|
1377
|
+
"field_type": "body",
|
|
1378
|
+
"fields": {
|
|
1379
|
+
"name": "event",
|
|
1380
|
+
"type": "string",
|
|
1381
|
+
"in": "body",
|
|
1382
|
+
"description": "The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready."
|
|
1383
|
+
}
|
|
1384
|
+
},
|
|
1385
|
+
"field_7": {
|
|
1386
|
+
"field_type": "body",
|
|
1387
|
+
"fields": {
|
|
1388
|
+
"name": "comments",
|
|
1389
|
+
"type": "array of objects",
|
|
1390
|
+
"in": "body",
|
|
1391
|
+
"description": "Use the following table to specify the location, destination, and contents of the draft review comment."
|
|
1392
|
+
}
|
|
1393
|
+
},
|
|
1394
|
+
"field_8": {
|
|
1395
|
+
"field_type": null,
|
|
1396
|
+
"fields": {
|
|
1397
|
+
"name": "Properties of thecommentsitemsName (Type)Descriptionpath (string)Required. The relative path to the file that necessitates a review comment.position (integer)The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.body (string)Required. Text of the review comment.line (integer)side (string)start_line (integer)start_side (string)",
|
|
1398
|
+
"type": null,
|
|
1399
|
+
"in": null,
|
|
1400
|
+
"description": null
|
|
1401
|
+
}
|
|
1402
|
+
}
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"namespace_description": "Get a review for a pull request",
|
|
1406
|
+
"method": "get",
|
|
1407
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
|
|
1408
|
+
"field_0": {
|
|
1409
|
+
"field_type": "header",
|
|
1410
|
+
"fields": {
|
|
1411
|
+
"name": "accept",
|
|
1412
|
+
"type": "string",
|
|
1413
|
+
"in": "header",
|
|
1414
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1415
|
+
}
|
|
1416
|
+
},
|
|
1417
|
+
"field_1": {
|
|
1418
|
+
"field_type": "path",
|
|
1419
|
+
"fields": {
|
|
1420
|
+
"name": "owner",
|
|
1421
|
+
"type": "string",
|
|
1422
|
+
"in": "path",
|
|
1423
|
+
"description": ""
|
|
1424
|
+
}
|
|
1425
|
+
},
|
|
1426
|
+
"field_2": {
|
|
1427
|
+
"field_type": "path",
|
|
1428
|
+
"fields": {
|
|
1429
|
+
"name": "repo",
|
|
1430
|
+
"type": "string",
|
|
1431
|
+
"in": "path",
|
|
1432
|
+
"description": ""
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
"field_3": {
|
|
1436
|
+
"field_type": "path",
|
|
1437
|
+
"fields": {
|
|
1438
|
+
"name": "pull_number",
|
|
1439
|
+
"type": "integer",
|
|
1440
|
+
"in": "path",
|
|
1441
|
+
"description": ""
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
"field_4": {
|
|
1445
|
+
"field_type": "path",
|
|
1446
|
+
"fields": {
|
|
1447
|
+
"name": "review_id",
|
|
1448
|
+
"type": "integer",
|
|
1449
|
+
"in": "path",
|
|
1450
|
+
"description": "review_id parameter"
|
|
1451
|
+
}
|
|
1452
|
+
}
|
|
1453
|
+
},
|
|
1454
|
+
{
|
|
1455
|
+
"namespace_description": "Update a review for a pull request",
|
|
1456
|
+
"method": "put",
|
|
1457
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
|
|
1458
|
+
"field_0": {
|
|
1459
|
+
"field_type": "header",
|
|
1460
|
+
"fields": {
|
|
1461
|
+
"name": "accept",
|
|
1462
|
+
"type": "string",
|
|
1463
|
+
"in": "header",
|
|
1464
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1465
|
+
}
|
|
1466
|
+
},
|
|
1467
|
+
"field_1": {
|
|
1468
|
+
"field_type": "path",
|
|
1469
|
+
"fields": {
|
|
1470
|
+
"name": "owner",
|
|
1471
|
+
"type": "string",
|
|
1472
|
+
"in": "path",
|
|
1473
|
+
"description": ""
|
|
1474
|
+
}
|
|
1475
|
+
},
|
|
1476
|
+
"field_2": {
|
|
1477
|
+
"field_type": "path",
|
|
1478
|
+
"fields": {
|
|
1479
|
+
"name": "repo",
|
|
1480
|
+
"type": "string",
|
|
1481
|
+
"in": "path",
|
|
1482
|
+
"description": ""
|
|
1483
|
+
}
|
|
1484
|
+
},
|
|
1485
|
+
"field_3": {
|
|
1486
|
+
"field_type": "path",
|
|
1487
|
+
"fields": {
|
|
1488
|
+
"name": "pull_number",
|
|
1489
|
+
"type": "integer",
|
|
1490
|
+
"in": "path",
|
|
1491
|
+
"description": ""
|
|
1492
|
+
}
|
|
1493
|
+
},
|
|
1494
|
+
"field_4": {
|
|
1495
|
+
"field_type": "path",
|
|
1496
|
+
"fields": {
|
|
1497
|
+
"name": "review_id",
|
|
1498
|
+
"type": "integer",
|
|
1499
|
+
"in": "path",
|
|
1500
|
+
"description": "review_id parameter"
|
|
1501
|
+
}
|
|
1502
|
+
},
|
|
1503
|
+
"field_5": {
|
|
1504
|
+
"field_type": "body",
|
|
1505
|
+
"fields": {
|
|
1506
|
+
"name": "body",
|
|
1507
|
+
"type": "string",
|
|
1508
|
+
"in": "body",
|
|
1509
|
+
"description": "Required. The body text of the pull request review."
|
|
1510
|
+
}
|
|
1511
|
+
}
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
"namespace_description": "Delete a pending review for a pull request",
|
|
1515
|
+
"method": "delete",
|
|
1516
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
|
|
1517
|
+
"field_0": {
|
|
1518
|
+
"field_type": "header",
|
|
1519
|
+
"fields": {
|
|
1520
|
+
"name": "accept",
|
|
1521
|
+
"type": "string",
|
|
1522
|
+
"in": "header",
|
|
1523
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1524
|
+
}
|
|
1525
|
+
},
|
|
1526
|
+
"field_1": {
|
|
1527
|
+
"field_type": "path",
|
|
1528
|
+
"fields": {
|
|
1529
|
+
"name": "owner",
|
|
1530
|
+
"type": "string",
|
|
1531
|
+
"in": "path",
|
|
1532
|
+
"description": ""
|
|
1533
|
+
}
|
|
1534
|
+
},
|
|
1535
|
+
"field_2": {
|
|
1536
|
+
"field_type": "path",
|
|
1537
|
+
"fields": {
|
|
1538
|
+
"name": "repo",
|
|
1539
|
+
"type": "string",
|
|
1540
|
+
"in": "path",
|
|
1541
|
+
"description": ""
|
|
1542
|
+
}
|
|
1543
|
+
},
|
|
1544
|
+
"field_3": {
|
|
1545
|
+
"field_type": "path",
|
|
1546
|
+
"fields": {
|
|
1547
|
+
"name": "pull_number",
|
|
1548
|
+
"type": "integer",
|
|
1549
|
+
"in": "path",
|
|
1550
|
+
"description": ""
|
|
1551
|
+
}
|
|
1552
|
+
},
|
|
1553
|
+
"field_4": {
|
|
1554
|
+
"field_type": "path",
|
|
1555
|
+
"fields": {
|
|
1556
|
+
"name": "review_id",
|
|
1557
|
+
"type": "integer",
|
|
1558
|
+
"in": "path",
|
|
1559
|
+
"description": "review_id parameter"
|
|
1560
|
+
}
|
|
1561
|
+
}
|
|
1562
|
+
},
|
|
1563
|
+
{
|
|
1564
|
+
"namespace_description": "List comments for a pull request review",
|
|
1565
|
+
"method": "get",
|
|
1566
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
|
|
1567
|
+
"field_0": {
|
|
1568
|
+
"field_type": "header",
|
|
1569
|
+
"fields": {
|
|
1570
|
+
"name": "accept",
|
|
1571
|
+
"type": "string",
|
|
1572
|
+
"in": "header",
|
|
1573
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1574
|
+
}
|
|
1575
|
+
},
|
|
1576
|
+
"field_1": {
|
|
1577
|
+
"field_type": "path",
|
|
1578
|
+
"fields": {
|
|
1579
|
+
"name": "owner",
|
|
1580
|
+
"type": "string",
|
|
1581
|
+
"in": "path",
|
|
1582
|
+
"description": ""
|
|
1583
|
+
}
|
|
1584
|
+
},
|
|
1585
|
+
"field_2": {
|
|
1586
|
+
"field_type": "path",
|
|
1587
|
+
"fields": {
|
|
1588
|
+
"name": "repo",
|
|
1589
|
+
"type": "string",
|
|
1590
|
+
"in": "path",
|
|
1591
|
+
"description": ""
|
|
1592
|
+
}
|
|
1593
|
+
},
|
|
1594
|
+
"field_3": {
|
|
1595
|
+
"field_type": "path",
|
|
1596
|
+
"fields": {
|
|
1597
|
+
"name": "pull_number",
|
|
1598
|
+
"type": "integer",
|
|
1599
|
+
"in": "path",
|
|
1600
|
+
"description": ""
|
|
1601
|
+
}
|
|
1602
|
+
},
|
|
1603
|
+
"field_4": {
|
|
1604
|
+
"field_type": "path",
|
|
1605
|
+
"fields": {
|
|
1606
|
+
"name": "review_id",
|
|
1607
|
+
"type": "integer",
|
|
1608
|
+
"in": "path",
|
|
1609
|
+
"description": "review_id parameter"
|
|
1610
|
+
}
|
|
1611
|
+
},
|
|
1612
|
+
"field_5": {
|
|
1613
|
+
"field_type": "query",
|
|
1614
|
+
"fields": {
|
|
1615
|
+
"name": "per_page",
|
|
1616
|
+
"type": "integer",
|
|
1617
|
+
"in": "query",
|
|
1618
|
+
"description": "Results per page (max 100)Default: 30"
|
|
1619
|
+
}
|
|
1620
|
+
},
|
|
1621
|
+
"field_6": {
|
|
1622
|
+
"field_type": "query",
|
|
1623
|
+
"fields": {
|
|
1624
|
+
"name": "page",
|
|
1625
|
+
"type": "integer",
|
|
1626
|
+
"in": "query",
|
|
1627
|
+
"description": "Page number of the results to fetch.Default: 1"
|
|
1628
|
+
}
|
|
1629
|
+
}
|
|
1630
|
+
},
|
|
1631
|
+
{
|
|
1632
|
+
"namespace_description": "Dismiss a review for a pull request",
|
|
1633
|
+
"method": "put",
|
|
1634
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals",
|
|
1635
|
+
"field_0": {
|
|
1636
|
+
"field_type": "header",
|
|
1637
|
+
"fields": {
|
|
1638
|
+
"name": "accept",
|
|
1639
|
+
"type": "string",
|
|
1640
|
+
"in": "header",
|
|
1641
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1642
|
+
}
|
|
1643
|
+
},
|
|
1644
|
+
"field_1": {
|
|
1645
|
+
"field_type": "path",
|
|
1646
|
+
"fields": {
|
|
1647
|
+
"name": "owner",
|
|
1648
|
+
"type": "string",
|
|
1649
|
+
"in": "path",
|
|
1650
|
+
"description": ""
|
|
1651
|
+
}
|
|
1652
|
+
},
|
|
1653
|
+
"field_2": {
|
|
1654
|
+
"field_type": "path",
|
|
1655
|
+
"fields": {
|
|
1656
|
+
"name": "repo",
|
|
1657
|
+
"type": "string",
|
|
1658
|
+
"in": "path",
|
|
1659
|
+
"description": ""
|
|
1660
|
+
}
|
|
1661
|
+
},
|
|
1662
|
+
"field_3": {
|
|
1663
|
+
"field_type": "path",
|
|
1664
|
+
"fields": {
|
|
1665
|
+
"name": "pull_number",
|
|
1666
|
+
"type": "integer",
|
|
1667
|
+
"in": "path",
|
|
1668
|
+
"description": ""
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
"field_4": {
|
|
1672
|
+
"field_type": "path",
|
|
1673
|
+
"fields": {
|
|
1674
|
+
"name": "review_id",
|
|
1675
|
+
"type": "integer",
|
|
1676
|
+
"in": "path",
|
|
1677
|
+
"description": "review_id parameter"
|
|
1678
|
+
}
|
|
1679
|
+
},
|
|
1680
|
+
"field_5": {
|
|
1681
|
+
"field_type": "body",
|
|
1682
|
+
"fields": {
|
|
1683
|
+
"name": "message",
|
|
1684
|
+
"type": "string",
|
|
1685
|
+
"in": "body",
|
|
1686
|
+
"description": "Required. The message for the pull request review dismissal"
|
|
1687
|
+
}
|
|
1688
|
+
},
|
|
1689
|
+
"field_6": {
|
|
1690
|
+
"field_type": "body",
|
|
1691
|
+
"fields": {
|
|
1692
|
+
"name": "event",
|
|
1693
|
+
"type": "string",
|
|
1694
|
+
"in": "body",
|
|
1695
|
+
"description": ""
|
|
1696
|
+
}
|
|
1697
|
+
}
|
|
1698
|
+
},
|
|
1699
|
+
{
|
|
1700
|
+
"namespace_description": "Submit a review for a pull request",
|
|
1701
|
+
"method": "post",
|
|
1702
|
+
"endpoint": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events",
|
|
1703
|
+
"field_0": {
|
|
1704
|
+
"field_type": "header",
|
|
1705
|
+
"fields": {
|
|
1706
|
+
"name": "accept",
|
|
1707
|
+
"type": "string",
|
|
1708
|
+
"in": "header",
|
|
1709
|
+
"description": "Setting toapplication/vnd.github.v3+json is recommended."
|
|
1710
|
+
}
|
|
1711
|
+
},
|
|
1712
|
+
"field_1": {
|
|
1713
|
+
"field_type": "path",
|
|
1714
|
+
"fields": {
|
|
1715
|
+
"name": "owner",
|
|
1716
|
+
"type": "string",
|
|
1717
|
+
"in": "path",
|
|
1718
|
+
"description": ""
|
|
1719
|
+
}
|
|
1720
|
+
},
|
|
1721
|
+
"field_2": {
|
|
1722
|
+
"field_type": "path",
|
|
1723
|
+
"fields": {
|
|
1724
|
+
"name": "repo",
|
|
1725
|
+
"type": "string",
|
|
1726
|
+
"in": "path",
|
|
1727
|
+
"description": ""
|
|
1728
|
+
}
|
|
1729
|
+
},
|
|
1730
|
+
"field_3": {
|
|
1731
|
+
"field_type": "path",
|
|
1732
|
+
"fields": {
|
|
1733
|
+
"name": "pull_number",
|
|
1734
|
+
"type": "integer",
|
|
1735
|
+
"in": "path",
|
|
1736
|
+
"description": ""
|
|
1737
|
+
}
|
|
1738
|
+
},
|
|
1739
|
+
"field_4": {
|
|
1740
|
+
"field_type": "path",
|
|
1741
|
+
"fields": {
|
|
1742
|
+
"name": "review_id",
|
|
1743
|
+
"type": "integer",
|
|
1744
|
+
"in": "path",
|
|
1745
|
+
"description": "review_id parameter"
|
|
1746
|
+
}
|
|
1747
|
+
},
|
|
1748
|
+
"field_5": {
|
|
1749
|
+
"field_type": "body",
|
|
1750
|
+
"fields": {
|
|
1751
|
+
"name": "body",
|
|
1752
|
+
"type": "string",
|
|
1753
|
+
"in": "body",
|
|
1754
|
+
"description": "The body text of the pull request review"
|
|
1755
|
+
}
|
|
1756
|
+
},
|
|
1757
|
+
"field_6": {
|
|
1758
|
+
"field_type": "body",
|
|
1759
|
+
"fields": {
|
|
1760
|
+
"name": "event",
|
|
1761
|
+
"type": "string",
|
|
1762
|
+
"in": "body",
|
|
1763
|
+
"description": "Required. The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action."
|
|
1764
|
+
}
|
|
1765
|
+
}
|
|
1766
|
+
}
|
|
1767
|
+
]
|
|
1768
|
+
}
|