-
Notifications
You must be signed in to change notification settings - Fork 13
/
github-schema.graphql
24436 lines (22995 loc) · 906 KB
/
github-schema.graphql
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
# This file was generated based on ".graphqlconfig". Do not edit manually.
schema {
query: Query
mutation: Mutation
}
directive @requiredCapabilities(requiredCapabilities: [String!]) on SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
"Represents an object which can take actions on GitHub. Typically a User or Bot."
interface Actor {
"A URL pointing to the actor's public avatar."
avatarUrl(
"The size of the resulting square image."
size: Int
): URI!
"The username of the actor."
login: String!
"The HTTP path for this actor."
resourcePath: URI!
"The HTTP URL for this actor."
url: URI!
}
"An object that can have users assigned to it."
interface Assignable {
"A list of Users assigned to this object."
assignees(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int
): UserConnection!
}
"An entry in the audit log."
interface AuditEntry {
"The action name"
action: String!
"The user who initiated the action"
actor: AuditEntryActor
"The IP address of the actor"
actorIp: String
"A readable representation of the actor's location"
actorLocation: ActorLocation
"The username of the user who initiated the action"
actorLogin: String
"The HTTP path for the actor."
actorResourcePath: URI
"The HTTP URL for the actor."
actorUrl: URI
"The time the action was initiated"
createdAt: PreciseDateTime!
"The corresponding operation type for the action"
operationType: OperationType
"The user affected by the action"
user: User
"For actions involving two users, the actor is the initiator and the user is the affected user."
userLogin: String
"The HTTP path for the user."
userResourcePath: URI
"The HTTP URL for the user."
userUrl: URI
}
"An object that can be closed"
interface Closable {
"`true` if the object is closed (definition of closed may depend on type)"
closed: Boolean!
"Identifies the date and time when the object was closed."
closedAt: DateTime
}
"Represents a comment."
interface Comment {
"The actor who authored the comment."
author: Actor
"Author's association with the subject of the comment."
authorAssociation: CommentAuthorAssociation!
"The body as Markdown."
body: String!
"The body rendered to HTML."
bodyHTML: HTML!
"The body rendered to text."
bodyText: String!
"Identifies the date and time when the object was created."
createdAt: DateTime!
"Check if this comment was created via an email reply."
createdViaEmail: Boolean!
"The actor who edited the comment."
editor: Actor
id: ID!
"Check if this comment was edited and includes an edit with the creation data"
includesCreatedEdit: Boolean!
"The moment the editor made the last edit"
lastEditedAt: DateTime
"Identifies when the comment was published at."
publishedAt: DateTime
"Identifies the date and time when the object was last updated."
updatedAt: DateTime!
"A list of edits to this content."
userContentEdits(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int
): UserContentEditConnection
"Did the viewer author this comment."
viewerDidAuthor: Boolean!
}
"Represents a contribution a user made on GitHub, such as opening an issue."
interface Contribution {
"""
Whether this contribution is associated with a record you do not have access to. For
example, your own 'first issue' contribution may have been made on a repository you can no
longer access.
"""
isRestricted: Boolean!
"When this contribution was made."
occurredAt: DateTime!
"The HTTP path for this contribution."
resourcePath: URI!
"The HTTP URL for this contribution."
url: URI!
"""
The user who made this contribution.
"""
user: User!
}
"Entities that can be deleted."
interface Deletable {
"Check if the current viewer can delete this object."
viewerCanDelete: Boolean!
}
"Metadata for an audit entry containing enterprise account information."
interface EnterpriseAuditEntryData {
"The HTTP path for this enterprise."
enterpriseResourcePath: URI
"The slug of the enterprise."
enterpriseSlug: String
"The HTTP URL for this enterprise."
enterpriseUrl: URI
}
"Represents a Git object."
interface GitObject {
"An abbreviated version of the Git object ID"
abbreviatedOid: String!
"The HTTP path for this Git object"
commitResourcePath: URI!
"The HTTP URL for this Git object"
commitUrl: URI!
id: ID!
"The Git object ID"
oid: GitObjectID!
"The Repository the Git object belongs to"
repository: Repository!
}
"Information about a signature (GPG or S/MIME) on a Commit or Tag."
interface GitSignature {
"Email used to sign this object."
email: String!
"True if the signature is valid and verified by GitHub."
isValid: Boolean!
"Payload for GPG signing object. Raw ODB object without the signature header."
payload: String!
"ASCII-armored signature header from object."
signature: String!
"GitHub user corresponding to the email signing this commit."
signer: User
"The state of this signature. `VALID` if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid."
state: GitSignatureState!
"True if the signature was made with GitHub's signing key."
wasSignedByGitHub: Boolean!
}
"An individual line of a hovercard"
interface HovercardContext {
"A string describing this context"
message: String!
"An octicon to accompany this context"
octicon: String!
}
"An object that can have labels assigned to it."
interface Labelable {
"A list of labels associated with the object."
labels(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for labels returned from the connection."
orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
): LabelConnection
}
"An object that can be locked."
interface Lockable {
"Reason that the conversation was locked."
activeLockReason: LockReason
"`true` if the object is locked"
locked: Boolean!
}
"Entities that have members who can set status messages."
interface MemberStatusable {
"Get the status messages members of this entity have set that are either public or visible only to the organization."
memberStatuses(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for user statuses returned from the connection."
orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
): UserStatusConnection!
}
"Represents an Octoshift migration."
interface Migration {
"The Octoshift migration flag to continue on error."
continueOnError: Boolean!
"Identifies the date and time when the object was created."
createdAt: DateTime!
"The reason the migration failed."
failureReason: String
id: ID!
"The URL for the migration log (expires 1 day after migration completes)."
migrationLogUrl: URI
"The Octoshift migration source."
migrationSource: MigrationSource!
"The target repository name."
repositoryName: String!
"The Octoshift migration source URL."
sourceUrl: URI!
"The Octoshift migration state."
state: MigrationState!
}
"Entities that can be minimized."
interface Minimizable {
"Returns whether or not a comment has been minimized."
isMinimized: Boolean!
"Returns why the comment was minimized. One of `abuse`, `off-topic`, `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and formatting of these values differs from the inputs to the `MinimizeComment` mutation."
minimizedReason: String
"Check if the current viewer can minimize this object."
viewerCanMinimize: Boolean!
}
"An object with an ID."
interface Node {
"ID of the object."
id: ID!
}
"Metadata for an audit entry with action oauth_application.*"
interface OauthApplicationAuditEntryData {
"The name of the OAuth Application."
oauthApplicationName: String
"The HTTP path for the OAuth Application"
oauthApplicationResourcePath: URI
"The HTTP URL for the OAuth Application"
oauthApplicationUrl: URI
}
"Metadata for an audit entry with action org.*"
interface OrganizationAuditEntryData {
"The Organization associated with the Audit Entry."
organization: Organization
"The name of the Organization."
organizationName: String
"The HTTP path for the organization"
organizationResourcePath: URI
"The HTTP URL for the organization"
organizationUrl: URI
}
"Represents an owner of a package."
interface PackageOwner {
id: ID!
"A list of packages under the owner."
packages(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Find packages by their names."
names: [String],
"Ordering of the returned packages."
orderBy: PackageOrder = {field: CREATED_AT, direction: DESC},
"Filter registry package by type."
packageType: PackageType,
"Find packages in a repository by ID."
repositoryId: ID
): PackageConnection!
}
"Represents any entity on GitHub that has a profile page."
interface ProfileOwner {
"Determine if this repository owner has any items that can be pinned to their profile."
anyPinnableItems(
"Filter to only a particular kind of pinnable item."
type: PinnableItemType
): Boolean!
"The public profile email."
email: String
id: ID!
"Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity."
itemShowcase: ProfileItemShowcase!
"The public profile location."
location: String
"The username used to login."
login: String!
"The public profile name."
name: String
"A list of repositories and gists this profile owner can pin to their profile."
pinnableItems(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Filter the types of pinnable items that are returned."
types: [PinnableItemType!]
): PinnableItemConnection!
"A list of repositories and gists this profile owner has pinned to their profile"
pinnedItems(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Filter the types of pinned items that are returned."
types: [PinnableItemType!]
): PinnableItemConnection!
"Returns how many more items this profile owner can pin to their profile."
pinnedItemsRemaining: Int!
"Can the viewer pin repositories and gists to the profile?"
viewerCanChangePinnedItems: Boolean!
"The public profile website URL."
websiteUrl: URI
}
"Common fields across different field types"
interface ProjectNextFieldCommon {
"Identifies the date and time when the object was created."
createdAt: DateTime! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"The field's type."
dataType: ProjectNextFieldType! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"Identifies the primary key from the database."
databaseId: Int @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
id: ID! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"The project field's name."
name: String! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"The project that contains this field."
project: ProjectNext! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"The field's settings."
settings: String @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"Identifies the date and time when the object was last updated."
updatedAt: DateTime! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
}
"Represents an owner of a project (beta)."
interface ProjectNextOwner {
id: ID!
"Find a project by project (beta) number."
projectNext(
"The project (beta) number."
number: Int!
): ProjectNext @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
"A list of projects (beta) under the owner."
projectsNext(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"A project (beta) to search for under the the owner."
query: String,
"How to order the returned projects (beta)."
sortBy: ProjectNextOrderField = TITLE
): ProjectNextConnection! @deprecated(reason: "The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` API. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Removal on 2022-10-01 UTC.")
}
"Represents an owner of a Project."
interface ProjectOwner {
id: ID!
"Find project by number."
project(
"The project number to find."
number: Int!
): Project
"A list of projects under the owner."
projects(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for projects returned from the connection"
orderBy: ProjectOrder,
"Query to search projects by, currently only searching by name."
search: String,
"A list of states to filter the projects by."
states: [ProjectState!]
): ProjectConnection!
"The HTTP path listing owners projects"
projectsResourcePath: URI!
"The HTTP URL listing owners projects"
projectsUrl: URI!
"Can the current viewer create new projects on this owner."
viewerCanCreateProjects: Boolean!
}
"Common fields across different project field types"
interface ProjectV2FieldCommon {
"Identifies the date and time when the object was created."
createdAt: DateTime!
"The field's type."
dataType: ProjectV2FieldType!
"Identifies the primary key from the database."
databaseId: Int
id: ID!
"The project field's name."
name: String!
"The project that contains this field."
project: ProjectV2!
"Identifies the date and time when the object was last updated."
updatedAt: DateTime!
}
"Common fields across different project field value types"
interface ProjectV2ItemFieldValueCommon {
"Identifies the date and time when the object was created."
createdAt: DateTime!
"The actor who created the item."
creator: Actor
"Identifies the primary key from the database."
databaseId: Int
"The project field that contains this value."
field: ProjectV2FieldConfiguration!
id: ID!
"The project item that contains this value."
item: ProjectV2Item!
"Identifies the date and time when the object was last updated."
updatedAt: DateTime!
}
"Represents an owner of a project (beta)."
interface ProjectV2Owner {
id: ID!
"Find a project by number."
projectV2(
"The project number."
number: Int!
): ProjectV2
"A list of projects under the owner."
projectsV2(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"How to order the returned projects."
orderBy: ProjectV2Order = {field: NUMBER, direction: DESC},
"A project to search for under the the owner."
query: String
): ProjectV2Connection!
}
"Recent projects for the owner."
interface ProjectV2Recent {
"Recent projects that this user has modified in the context of the owner."
recentProjects(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int
): ProjectV2Connection!
}
"Represents a subject that can be reacted on."
interface Reactable {
"Identifies the primary key from the database."
databaseId: Int
id: ID!
"A list of reactions grouped by content left on the subject."
reactionGroups: [ReactionGroup!]
"A list of Reactions left on the Issue."
reactions(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Allows filtering Reactions by emoji."
content: ReactionContent,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Allows specifying the order in which reactions are returned."
orderBy: ReactionOrder
): ReactionConnection!
"Can user react to this subject"
viewerCanReact: Boolean!
}
"Metadata for an audit entry with action repo.*"
interface RepositoryAuditEntryData {
"The repository associated with the action"
repository: Repository
"The name of the repository"
repositoryName: String
"The HTTP path for the repository"
repositoryResourcePath: URI
"The HTTP URL for the repository"
repositoryUrl: URI
}
"Represents an author of discussions in repositories."
interface RepositoryDiscussionAuthor {
"Discussions this user has started."
repositoryDiscussions(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions."
answered: Boolean,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for discussions returned from the connection."
orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC},
"Filter discussions to only those in a specific repository."
repositoryId: ID
): DiscussionConnection!
}
"Represents an author of discussion comments in repositories."
interface RepositoryDiscussionCommentAuthor {
"Discussion comments this user has authored."
repositoryDiscussionComments(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Filter discussion comments to only those that were marked as the answer"
onlyAnswers: Boolean = false,
"Filter discussion comments to only those in a specific repository."
repositoryId: ID
): DiscussionCommentConnection!
}
"A subset of repository info."
interface RepositoryInfo {
"Identifies the date and time when the object was created."
createdAt: DateTime!
"The description of the repository."
description: String
"The description of the repository rendered to HTML."
descriptionHTML: HTML!
"Returns how many forks there are of this repository in the whole network."
forkCount: Int!
"Indicates if the repository has issues feature enabled."
hasIssuesEnabled: Boolean!
"Indicates if the repository has the Projects feature enabled."
hasProjectsEnabled: Boolean!
"Indicates if the repository has wiki feature enabled."
hasWikiEnabled: Boolean!
"The repository's URL."
homepageUrl: URI
"Indicates if the repository is unmaintained."
isArchived: Boolean!
"Identifies if the repository is a fork."
isFork: Boolean!
"Indicates if a repository is either owned by an organization, or is a private fork of an organization repository."
isInOrganization: Boolean!
"Indicates if the repository has been locked or not."
isLocked: Boolean!
"Identifies if the repository is a mirror."
isMirror: Boolean!
"Identifies if the repository is private or internal."
isPrivate: Boolean!
"Identifies if the repository is a template that can be used to generate new repositories."
isTemplate: Boolean!
"The license associated with the repository"
licenseInfo: License
"The reason the repository has been locked."
lockReason: RepositoryLockReason
"The repository's original mirror URL."
mirrorUrl: URI
"The name of the repository."
name: String!
"The repository's name with owner."
nameWithOwner: String!
"The image used to represent this repository in Open Graph data."
openGraphImageUrl: URI!
"The User owner of the repository."
owner: RepositoryOwner!
"Identifies when the repository was last pushed to."
pushedAt: DateTime
"The HTTP path for this repository"
resourcePath: URI!
"A description of the repository, rendered to HTML without any links in it."
shortDescriptionHTML(
"How many characters to return."
limit: Int = 200
): HTML!
"Identifies the date and time when the object was last updated."
updatedAt: DateTime!
"The HTTP URL for this repository"
url: URI!
"Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar."
usesCustomOpenGraphImage: Boolean!
"Indicates the repository's visibility level."
visibility: RepositoryVisibility!
}
"Represents a object that belongs to a repository."
interface RepositoryNode {
"The repository associated with this node."
repository: Repository!
}
"Represents an owner of a Repository."
interface RepositoryOwner {
"A URL pointing to the owner's public avatar."
avatarUrl(
"The size of the resulting square image."
size: Int
): URI!
id: ID!
"The username used to login."
login: String!
"A list of repositories that the user owns."
repositories(
"Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns."
affiliations: [RepositoryAffiliation],
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"If non-null, filters repositories according to whether they are forks of another repository"
isFork: Boolean,
"If non-null, filters repositories according to whether they have been locked"
isLocked: Boolean,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for repositories returned from the connection"
orderBy: RepositoryOrder,
"Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns."
ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR],
"If non-null, filters repositories according to privacy"
privacy: RepositoryPrivacy
): RepositoryConnection!
"Find Repository."
repository(
"Follow repository renames. If disabled, a repository referenced by its old name will return an error."
followRenames: Boolean = true,
"Name of Repository to find."
name: String!
): Repository
"The HTTP URL for the owner."
resourcePath: URI!
"The HTTP URL for the owner."
url: URI!
}
"Represents a type that can be required by a pull request for merging."
interface RequirableByPullRequest {
"Whether this is required to pass before merging for a specific pull request."
isRequired(
"The id of the pull request this is required for"
pullRequestId: ID,
"The number of the pull request this is required for"
pullRequestNumber: Int
): Boolean!
}
"Entities that can be sponsored through GitHub Sponsors"
interface Sponsorable {
"The estimated next GitHub Sponsors payout for this user/organization in cents (USD)."
estimatedNextSponsorsPayoutInCents: Int!
"True if this user/organization has a GitHub Sponsors listing."
hasSponsorsListing: Boolean!
"Check if the given account is sponsoring this user/organization."
isSponsoredBy(
"The target account's login."
accountLogin: String!
): Boolean!
"True if the viewer is sponsored by this user/organization."
isSponsoringViewer: Boolean!
"The estimated monthly GitHub Sponsors income for this user/organization in cents (USD)."
monthlyEstimatedSponsorsIncomeInCents: Int!
"List of users and organizations this entity is sponsoring."
sponsoring(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for the users and organizations returned from the connection."
orderBy: SponsorOrder = {field: RELEVANCE, direction: DESC}
): SponsorConnection!
"List of sponsors for this user or organization."
sponsors(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for sponsors returned from the connection."
orderBy: SponsorOrder = {field: RELEVANCE, direction: DESC},
"If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see."
tierId: ID
): SponsorConnection!
"Events involving this sponsorable, such as new sponsorships."
sponsorsActivities(
"Filter activities to only the specified actions."
actions: [SponsorsActivityAction!] = [],
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for activity returned from the connection."
orderBy: SponsorsActivityOrder = {field: TIMESTAMP, direction: DESC},
"Filter activities returned to only those that occurred in the most recent specified time period. Set to ALL to avoid filtering by when the activity occurred."
period: SponsorsActivityPeriod = MONTH
): SponsorsActivityConnection!
"The GitHub Sponsors listing for this user or organization."
sponsorsListing: SponsorsListing
"The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor. Only returns a sponsorship if it is active."
sponsorshipForViewerAsSponsor: Sponsorship
"The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving. Only returns a sponsorship if it is active."
sponsorshipForViewerAsSponsorable: Sponsorship
"List of sponsorship updates sent from this sponsorable to sponsors."
sponsorshipNewsletters(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for sponsorship updates returned from the connection."
orderBy: SponsorshipNewsletterOrder = {field: CREATED_AT, direction: DESC}
): SponsorshipNewsletterConnection!
"This object's sponsorships as the maintainer."
sponsorshipsAsMaintainer(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Whether or not to include private sponsorships in the result set"
includePrivate: Boolean = false,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer."
orderBy: SponsorshipOrder
): SponsorshipConnection!
"This object's sponsorships as the sponsor."
sponsorshipsAsSponsor(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer."
orderBy: SponsorshipOrder
): SponsorshipConnection!
"Whether or not the viewer is able to sponsor this user/organization."
viewerCanSponsor: Boolean!
"True if the viewer is sponsoring this user/organization."
viewerIsSponsoring: Boolean!
}
"Things that can be starred."
interface Starrable {
id: ID!
"""
Returns a count of how many stargazers there are on this object
"""
stargazerCount: Int!
"A list of users who have starred this starrable."
stargazers(
"Returns the elements in the list that come after the specified cursor."
after: String,
"Returns the elements in the list that come before the specified cursor."
before: String,
"Returns the first _n_ elements from the list."
first: Int,
"Returns the last _n_ elements from the list."
last: Int,
"Order for connection"
orderBy: StarOrder
): StargazerConnection!
"Returns a boolean indicating whether the viewing user has starred this starrable."
viewerHasStarred: Boolean!
}
"Entities that can be subscribed to for web and email notifications."
interface Subscribable {
id: ID!
"Check if the viewer is able to change their subscription status for the repository."
viewerCanSubscribe: Boolean!
"Identifies if the viewer is watching, not watching, or ignoring the subscribable entity."
viewerSubscription: SubscriptionState
}
"Metadata for an audit entry with action team.*"
interface TeamAuditEntryData {
"The team associated with the action"
team: Team
"The name of the team"
teamName: String
"The HTTP path for this team"
teamResourcePath: URI
"The HTTP URL for this team"
teamUrl: URI
}
"Metadata for an audit entry with a topic."
interface TopicAuditEntryData {
"The name of the topic added to the repository"
topic: Topic
"The name of the topic added to the repository"
topicName: String
}
"Represents a type that can be retrieved by a URL."
interface UniformResourceLocatable {
"The HTML path to this resource."
resourcePath: URI!
"The URL to this resource."
url: URI!
}
"Entities that can be updated."
interface Updatable {
"Check if the current viewer can update this object."
viewerCanUpdate: Boolean!
}
"Comments that can be updated."
interface UpdatableComment {
"Reasons why the current viewer can not update this comment."
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
}
"A subject that may be upvoted."
interface Votable {
"Number of upvotes that this subject has received."
upvoteCount: Int!
"Whether or not the current user can add or remove an upvote on this subject."
viewerCanUpvote: Boolean!
"Whether or not the current user has already upvoted this subject."
viewerHasUpvoted: Boolean!
}
"Types that can be assigned to issues."
union Assignee = Bot | Mannequin | Organization | User
"Types that can initiate an audit log event."
union AuditEntryActor = Bot | Organization | User
"Types which can be actors for `BranchActorAllowance` objects."
union BranchActorAllowanceActor = App | Team | User
"The object which triggered a `ClosedEvent`."
union Closer = Commit | PullRequest
"Represents either a issue the viewer can access or a restricted contribution."
union CreatedIssueOrRestrictedContribution = CreatedIssueContribution | RestrictedContribution
"Represents either a pull request the viewer can access or a restricted contribution."
union CreatedPullRequestOrRestrictedContribution = CreatedPullRequestContribution | RestrictedContribution
"Represents either a repository the viewer can access or a restricted contribution."
union CreatedRepositoryOrRestrictedContribution = CreatedRepositoryContribution | RestrictedContribution
"Users and teams."
union DeploymentReviewer = Team | User
"An object that is a member of an enterprise."
union EnterpriseMember = EnterpriseUserAccount | User
"Types that can own an IP allow list."
union IpAllowListOwner = App | Enterprise | Organization
"Used for return value of Repository.issueOrPullRequest."
union IssueOrPullRequest = Issue | PullRequest
"An item in an issue timeline"
union IssueTimelineItem = AssignedEvent | ClosedEvent | Commit | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MilestonedEvent | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
"An item in an issue timeline"
union IssueTimelineItems = AddedToProjectEvent | AssignedEvent | ClosedEvent | CommentDeletedEvent | ConnectedEvent | ConvertedNoteToIssueEvent | ConvertedToDiscussionEvent | CrossReferencedEvent | DemilestonedEvent | DisconnectedEvent | IssueComment | LabeledEvent | LockedEvent | MarkedAsDuplicateEvent | MentionedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnmarkedAsDuplicateEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
"Types that can be inside a Milestone."
union MilestoneItem = Issue | PullRequest
"Types of memberships that can be restored for an Organization member."
union OrgRestoreMemberAuditEntryMembership = OrgRestoreMemberMembershipOrganizationAuditEntryData | OrgRestoreMemberMembershipRepositoryAuditEntryData | OrgRestoreMemberMembershipTeamAuditEntryData
"An audit entry in an organization audit log."
union OrganizationAuditEntry = MembersCanDeleteReposClearAuditEntry | MembersCanDeleteReposDisableAuditEntry | MembersCanDeleteReposEnableAuditEntry | OauthApplicationCreateAuditEntry | OrgAddBillingManagerAuditEntry | OrgAddMemberAuditEntry | OrgBlockUserAuditEntry | OrgConfigDisableCollaboratorsOnlyAuditEntry | OrgConfigEnableCollaboratorsOnlyAuditEntry | OrgCreateAuditEntry | OrgDisableOauthAppRestrictionsAuditEntry | OrgDisableSamlAuditEntry | OrgDisableTwoFactorRequirementAuditEntry | OrgEnableOauthAppRestrictionsAuditEntry | OrgEnableSamlAuditEntry | OrgEnableTwoFactorRequirementAuditEntry | OrgInviteMemberAuditEntry | OrgInviteToBusinessAuditEntry | OrgOauthAppAccessApprovedAuditEntry | OrgOauthAppAccessDeniedAuditEntry | OrgOauthAppAccessRequestedAuditEntry | OrgRemoveBillingManagerAuditEntry | OrgRemoveMemberAuditEntry | OrgRemoveOutsideCollaboratorAuditEntry | OrgRestoreMemberAuditEntry | OrgUnblockUserAuditEntry | OrgUpdateDefaultRepositoryPermissionAuditEntry | OrgUpdateMemberAuditEntry | OrgUpdateMemberRepositoryCreationPermissionAuditEntry | OrgUpdateMemberRepositoryInvitationPermissionAuditEntry | PrivateRepositoryForkingDisableAuditEntry | PrivateRepositoryForkingEnableAuditEntry | RepoAccessAuditEntry | RepoAddMemberAuditEntry | RepoAddTopicAuditEntry | RepoArchivedAuditEntry | RepoChangeMergeSettingAuditEntry | RepoConfigDisableAnonymousGitAccessAuditEntry | RepoConfigDisableCollaboratorsOnlyAuditEntry | RepoConfigDisableContributorsOnlyAuditEntry | RepoConfigDisableSockpuppetDisallowedAuditEntry | RepoConfigEnableAnonymousGitAccessAuditEntry | RepoConfigEnableCollaboratorsOnlyAuditEntry | RepoConfigEnableContributorsOnlyAuditEntry | RepoConfigEnableSockpuppetDisallowedAuditEntry | RepoConfigLockAnonymousGitAccessAuditEntry | RepoConfigUnlockAnonymousGitAccessAuditEntry | RepoCreateAuditEntry | RepoDestroyAuditEntry | RepoRemoveMemberAuditEntry | RepoRemoveTopicAuditEntry | RepositoryVisibilityChangeDisableAuditEntry | RepositoryVisibilityChangeEnableAuditEntry | TeamAddMemberAuditEntry | TeamAddRepositoryAuditEntry | TeamChangeParentTeamAuditEntry | TeamRemoveMemberAuditEntry | TeamRemoveRepositoryAuditEntry
"Used for argument of CreateProjectV2 mutation."
union OrganizationOrUser = Organization | User
"Types that can grant permissions on a repository to a user"
union PermissionGranter = Organization | Repository | Team
"Types that can be pinned to a profile page."
union PinnableItem = Gist | Repository
"Types that can be inside Project Cards."
union ProjectCardItem = Issue | PullRequest
"Types that can be inside Project Items."
union ProjectNextItemContent = DraftIssue | Issue | PullRequest
"Configurations for project fields."
union ProjectV2FieldConfiguration = ProjectV2Field | ProjectV2IterationField | ProjectV2SingleSelectField
"Types that can be inside Project Items."
union ProjectV2ItemContent = DraftIssue | Issue | PullRequest
"Project field values"
union ProjectV2ItemFieldValue = ProjectV2ItemFieldDateValue | ProjectV2ItemFieldIterationValue | ProjectV2ItemFieldLabelValue | ProjectV2ItemFieldMilestoneValue | ProjectV2ItemFieldNumberValue | ProjectV2ItemFieldPullRequestValue | ProjectV2ItemFieldRepositoryValue | ProjectV2ItemFieldReviewerValue | ProjectV2ItemFieldSingleSelectValue | ProjectV2ItemFieldTextValue | ProjectV2ItemFieldUserValue