-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathgithub-user-issues-api-contains-oneof.yaml
More file actions
1498 lines (1498 loc) · 53.2 KB
/
github-user-issues-api-contains-oneof.yaml
File metadata and controls
1498 lines (1498 loc) · 53.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: GitHub v3 REST API - Subset
description: GitHub's v3 REST API.
termsOfService: https://docs.github.com/articles/github-terms-of-service
contact:
name: Support
url: https://support.github.com/contact?tags=dotcom-rest-api
license:
name: MIT
url: https://spdx.org/licenses/MIT
version: '1.1.4'
servers:
- url: https://api.github.com
paths:
/user/issues:
get:
tags:
- issues
summary: List user account issues assigned to the authenticated user
description: "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`."
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user
operationId: issues_list_for_authenticated_user
parameters:
- name: filter
in: query
description: 'Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you''re subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.'
style: form
explode: false
schema:
enum:
- assigned
- created
- mentioned
- subscribed
- repos
- all
type: string
default: assigned
- name: state
in: query
description: Indicates the state of the issues to return.
style: form
explode: false
schema:
enum:
- open
- closed
- all
type: string
default: open
- $ref: '#/components/parameters/labels'
- name: sort
in: query
description: What to sort results by.
style: form
explode: false
schema:
enum:
- created
- updated
- comments
type: string
default: created
- $ref: '#/components/parameters/direction'
- $ref: '#/components/parameters/since'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
responses:
'200':
description: Response
headers:
Link:
$ref: '#/components/headers/link'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/issue'
examples:
default:
$ref: '#/components/examples/issue-with-repo-items'
'404':
$ref: '#/components/responses/not_found'
'304':
$ref: '#/components/responses/not_modified'
components:
schemas:
issue:
title: Issue
required:
- assignee
- closed_at
- comments
- comments_url
- events_url
- html_url
- id
- node_id
- labels
- labels_url
- milestone
- number
- repository_url
- state
- locked
- title
- url
- user
- author_association
- created_at
- updated_at
type: object
properties:
id:
type: integer
format: int64
node_id:
type: string
url:
type: string
description: URL for the issue
format: uri
example: https://api.github.com/repositories/42/issues/1
repository_url:
type: string
format: uri
labels_url:
type: string
comments_url:
type: string
format: uri
events_url:
type: string
format: uri
html_url:
type: string
format: uri
number:
type: integer
description: Number uniquely identifying the issue within its repository
example: 42
state:
type: string
description: State of the issue; either 'open' or 'closed'
example: open
state_reason:
enum:
- completed
- reopened
- not_planned
type: string
description: The reason for the current state
nullable: true
example: not_planned
title:
type: string
description: Title of the issue
example: Widget creation fails in Safari on OS X 10.8
body:
type: string
description: Contents of the issue
nullable: true
example: 'It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?'
user:
$ref: '#/components/schemas/nullable-simple-user'
labels:
type: array
items:
oneOf:
- type: string
- type: object
properties:
id:
type: integer
format: int64
node_id:
type: string
url:
type: string
format: uri
name:
type: string
description:
type: string
nullable: true
color:
type: string
nullable: true
default:
type: boolean
description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
example:
- bug
- registration
assignee:
$ref: '#/components/schemas/nullable-simple-user'
assignees:
type: array
items:
$ref: '#/components/schemas/simple-user'
nullable: true
milestone:
$ref: '#/components/schemas/nullable-milestone'
locked:
type: boolean
active_lock_reason:
type: string
nullable: true
comments:
type: integer
pull_request:
required:
- diff_url
- html_url
- patch_url
- url
type: object
properties:
merged_at:
type: string
format: date-time
nullable: true
diff_url:
type: string
format: uri
nullable: true
html_url:
type: string
format: uri
nullable: true
patch_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
nullable: true
closed_at:
type: string
format: date-time
nullable: true
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
draft:
type: boolean
closed_by:
$ref: '#/components/schemas/nullable-simple-user'
body_html:
type: string
body_text:
type: string
timeline_url:
type: string
format: uri
repository:
$ref: '#/components/schemas/repository'
performed_via_github_app:
$ref: '#/components/schemas/nullable-integration'
author_association:
$ref: '#/components/schemas/author-association'
reactions:
$ref: '#/components/schemas/reaction-rollup'
description: 'Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.'
nullable-simple-user:
title: Simple User
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
type: object
properties:
name:
type: string
nullable: true
email:
type: string
nullable: true
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
nullable: true
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: 'https://api.github.com/users/octocat/following{/other_user}'
gists_url:
type: string
example: 'https://api.github.com/users/octocat/gists{/gist_id}'
starred_url:
type: string
example: 'https://api.github.com/users/octocat/starred{/owner}{/repo}'
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: 'https://api.github.com/users/octocat/events{/privacy}'
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
description: A GitHub user.
nullable: true
simple-user:
title: Simple User
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
type: object
properties:
name:
type: string
nullable: true
email:
type: string
nullable: true
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
nullable: true
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: 'https://api.github.com/users/octocat/following{/other_user}'
gists_url:
type: string
example: 'https://api.github.com/users/octocat/gists{/gist_id}'
starred_url:
type: string
example: 'https://api.github.com/users/octocat/starred{/owner}{/repo}'
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: 'https://api.github.com/users/octocat/events{/privacy}'
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
description: A GitHub user.
nullable-milestone:
title: Milestone
required:
- closed_issues
- creator
- description
- due_on
- closed_at
- id
- node_id
- labels_url
- html_url
- number
- open_issues
- state
- title
- url
- created_at
- updated_at
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id:
type: integer
example: 1002604
node_id:
type: string
example: MDk6TWlsZXN0b25lMTAwMjYwNA==
number:
type: integer
description: The number of the milestone.
example: 42
state:
enum:
- open
- closed
type: string
description: The state of the milestone.
default: open
example: open
title:
type: string
description: The title of the milestone.
example: v1.0
description:
type: string
nullable: true
example: Tracking milestone for version 1.0
creator:
$ref: '#/components/schemas/nullable-simple-user'
open_issues:
type: integer
example: 4
closed_issues:
type: integer
example: 8
created_at:
type: string
format: date-time
example: '2011-04-10T20:09:31.0000000+00:00'
updated_at:
type: string
format: date-time
example: '2014-03-03T18:58:10.0000000+00:00'
closed_at:
type: string
format: date-time
nullable: true
example: '2013-02-12T13:22:01.0000000+00:00'
due_on:
type: string
format: date-time
nullable: true
example: '2012-10-09T23:39:01.0000000+00:00'
description: A collection of related issues and pull requests.
nullable: true
repository:
title: Repository
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_downloads
- has_issues
- has_projects
- has_wiki
- has_pages
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
type: object
properties:
id:
type: integer
description: Unique identifier of the repository
example: 42
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
type: string
description: The name of the repository.
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
$ref: '#/components/schemas/nullable-license-simple'
forks:
type: integer
permissions:
required:
- admin
- pull
- push
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
owner:
$ref: '#/components/schemas/simple-user'
private:
type: boolean
description: Whether the repository is private or public.
default: false
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
nullable: true
example: This your first repo!
fork:
type: boolean
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}'
assignees_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/assignees{/user}'
blobs_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}'
branches_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/branches{/branch}'
collaborators_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}'
comments_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/comments{/number}'
commits_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/commits{/sha}'
compare_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}'
contents_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/contents/{+path}'
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}'
git_refs_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}'
git_tags_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}'
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}'
issue_events_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/issues/events{/number}'
issues_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/issues{/number}'
keys_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/keys{/key_id}'
labels_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/labels{/name}'
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/milestones{/number}'
notifications_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}'
pulls_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/pulls{/number}'
releases_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/releases{/id}'
ssh_url:
type: string
example: git@github.com:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/statuses/{sha}'
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: 'http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}'
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
nullable: true
example: git:git.example.com/octocat/Hello-World
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
nullable: true
example: https://github.com
language:
type: string
nullable: true
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
type: integer
description: 'The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.'
example: 108
default_branch:
type: string
description: The default branch of the repository.
example: master
open_issues_count:
type: integer
example: 0
is_template:
type: boolean
description: Whether this repository acts as a template that can be used to generate new repositories.
default: false
example: true
topics:
type: array
items:
type: string
has_issues:
type: boolean
description: Whether issues are enabled.
default: true
example: true
has_projects:
type: boolean
description: Whether projects are enabled.
default: true
example: true
has_wiki:
type: boolean
description: Whether the wiki is enabled.
default: true
example: true
has_pages:
type: boolean
has_downloads:
type: boolean
description: Whether downloads are enabled.
default: true
example: true
deprecated: true
has_discussions:
type: boolean
description: Whether discussions are enabled.
default: false
example: true
archived:
type: boolean
description: Whether the repository is archived.
default: false
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
type: string
description: 'The repository visibility: public, private, or internal.'
default: public
pushed_at:
type: string
format: date-time
nullable: true
example: '2011-01-26T19:06:43.0000000+00:00'
created_at:
type: string
format: date-time
nullable: true
example: '2011-01-26T19:01:12.0000000+00:00'
updated_at:
type: string
format: date-time
nullable: true
example: '2011-01-26T19:14:43.0000000+00:00'
allow_rebase_merge:
type: boolean
description: Whether to allow rebase merges for pull requests.
default: true
example: true
temp_clone_token:
type: string
allow_squash_merge:
type: boolean
description: Whether to allow squash merges for pull requests.
default: true
example: true
allow_auto_merge:
type: boolean
description: Whether to allow Auto-merge to be used on pull requests.
default: false
example: false
delete_branch_on_merge:
type: boolean
description: Whether to delete head branches when pull requests are merged
default: false
example: false
allow_update_branch:
type: boolean
description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
default: false
example: false
use_squash_pr_title_as_default:
type: boolean
description: Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
type: string
description: "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
squash_merge_commit_message:
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
type: string
description: "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
merge_commit_title:
enum:
- PR_TITLE
- MERGE_MESSAGE
type: string
description: "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
merge_commit_message:
enum:
- PR_BODY
- PR_TITLE
- BLANK
type: string
description: "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
allow_merge_commit:
type: boolean
description: Whether to allow merge commits for pull requests.
default: true
example: true
allow_forking:
type: boolean
description: Whether to allow forking this repo
web_commit_signoff_required:
type: boolean
description: Whether to require contributors to sign off on web-based commits
default: false
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
description: A repository on GitHub.
nullable-integration:
title: GitHub app
required:
- id