Skip to content
Navigation Menu
{{ message }}
forked from atom/github
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema.graphql
More file actions
10909 lines (8198 loc) · 274 KB
/
Copy pathschema.graphql
File metadata and controls
10909 lines (8198 loc) · 274 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
"""Autogenerated input type of AcceptTopicSuggestion"""
input AcceptTopicSuggestionInput {
"""The Node ID of the repository."""
repositoryId: ID!
"""The name of the suggested topic."""
name: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AcceptTopicSuggestion"""
type AcceptTopicSuggestionPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The accepted topic.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `topic` will change from `Topic!` to `Topic`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
topic: Topic!
}
"""
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!
}
"""Autogenerated input type of AddComment"""
input AddCommentInput {
"""The Node ID of the subject to modify."""
subjectId: ID!
"""The contents of the comment."""
body: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddComment"""
type AddCommentPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The edge from the subject's comment connection.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `commentEdge` will change from `IssueCommentEdge!` to `IssueCommentEdge`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
commentEdge: IssueCommentEdge!
"""
The subject
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `subject` will change from `Node!` to `Node`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
subject: Node!
"""
The edge from the subject's timeline connection.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `timelineEdge` will change from `IssueTimelineItemEdge!` to `IssueTimelineItemEdge`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
timelineEdge: IssueTimelineItemEdge!
}
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
type AddedToProjectEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Autogenerated input type of AddProjectCard"""
input AddProjectCardInput {
"""The Node ID of the ProjectColumn."""
projectColumnId: ID!
"""
The content of the card. Must be a member of the ProjectCardItem union
"""
contentId: ID
"""The note on the card."""
note: String
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddProjectCard"""
type AddProjectCardPayload {
"""
The edge from the ProjectColumn's card connection.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `cardEdge` will change from `ProjectCardEdge!` to `ProjectCardEdge`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
cardEdge: ProjectCardEdge!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The ProjectColumn
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `projectColumn` will change from `Project!` to `ProjectColumn`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
projectColumn: Project!
}
"""Autogenerated input type of AddProjectColumn"""
input AddProjectColumnInput {
"""The Node ID of the project."""
projectId: ID!
"""The name of the column."""
name: String!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddProjectColumn"""
type AddProjectColumnPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The edge from the project's column connection.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `columnEdge` will change from `ProjectColumnEdge!` to `ProjectColumnEdge`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
columnEdge: ProjectColumnEdge!
"""
The project
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `project` will change from `Project!` to `Project`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
project: Project!
}
"""Autogenerated input type of AddPullRequestReviewComment"""
input AddPullRequestReviewCommentInput {
"""The Node ID of the review to modify."""
pullRequestReviewId: ID!
"""The SHA of the commit to comment on."""
commitOID: GitObjectID
"""The text of the comment."""
body: String!
"""The relative path of the file to comment on."""
path: String
"""The line index in the diff to comment on."""
position: Int
"""The comment id to reply to."""
inReplyTo: ID
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddPullRequestReviewComment"""
type AddPullRequestReviewCommentPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The newly created comment.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `comment` will change from `PullRequestReviewComment!` to `PullRequestReviewComment`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
comment: PullRequestReviewComment!
"""
The edge from the review's comment connection.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `commentEdge` will change from
`PullRequestReviewCommentEdge!` to `PullRequestReviewCommentEdge`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
commentEdge: PullRequestReviewCommentEdge!
}
"""Autogenerated input type of AddPullRequestReview"""
input AddPullRequestReviewInput {
"""The Node ID of the pull request to modify."""
pullRequestId: ID!
"""The commit OID the review pertains to."""
commitOID: GitObjectID
"""The contents of the review body comment."""
body: String
"""The event to perform on the pull request review."""
event: PullRequestReviewEvent
"""The review line comments."""
comments: [DraftPullRequestReviewComment]
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddPullRequestReview"""
type AddPullRequestReviewPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The newly created pull request review.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `pullRequestReview` will change from `PullRequestReview!` to `PullRequestReview`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
pullRequestReview: PullRequestReview!
"""
The edge from the pull request's review connection.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `reviewEdge` will change from `PullRequestReviewEdge!` to `PullRequestReviewEdge`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
reviewEdge: PullRequestReviewEdge!
}
"""Autogenerated input type of AddReaction"""
input AddReactionInput {
"""The Node ID of the subject to modify."""
subjectId: ID!
"""The name of the emoji to react with."""
content: ReactionContent!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddReaction"""
type AddReactionPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The reaction object.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `reaction` will change from `Reaction!` to `Reaction`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
reaction: Reaction!
"""
The reactable subject.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `subject` will change from `Reactable!` to `Reactable`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
subject: Reactable!
}
"""Autogenerated input type of AddStar"""
input AddStarInput {
"""The Starrable ID to star."""
starrableId: ID!
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
}
"""Autogenerated return type of AddStar"""
type AddStarPayload {
"""A unique identifier for the client performing the mutation."""
clientMutationId: String
"""
The starrable.
**Upcoming Change on 2019-01-01 UTC**
**Description:** Type for `starrable` will change from `Starrable!` to `Starrable`.
**Reason:** In preparation for an upcoming change to the way we report
mutation errors, non-nullable payload fields are becoming nullable.
"""
starrable: Starrable!
}
"""A GitHub App."""
type App implements Node {
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
"""The description of the app."""
description: String
id: ID!
"""The hex color code, without the leading '#', for the logo background."""
logoBackgroundColor: String!
"""A URL pointing to the app's logo."""
logoUrl(
"""The size of the resulting image."""
size: Int
): URI!
"""The name of the app."""
name: String!
"""A slug based on the name of the app for use in URLs."""
slug: String!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The URL to the app's homepage."""
url: URI!
}
"""An edge in a connection."""
type AppEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: App
}
"""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!
}
"""Represents an 'assigned' event on any assignable object."""
type AssignedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the assignable associated with the event."""
assignable: Assignable!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""Identifies the user who was assigned."""
user: User
}
"""
Represents a 'base_ref_changed' event on a given issue or pull request.
"""
type BaseRefChangedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Represents a 'base_ref_force_pushed' event on a given pull request."""
type BaseRefForcePushedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""
Identifies the after commit SHA for the 'base_ref_force_pushed' event.
"""
afterCommit: Commit
"""
Identifies the before commit SHA for the 'base_ref_force_pushed' event.
"""
beforeCommit: Commit
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""PullRequest referenced by event."""
pullRequest: PullRequest!
"""
Identifies the fully qualified ref name for the 'base_ref_force_pushed' event.
"""
ref: Ref
}
"""Represents a Git blame."""
type Blame {
"""The list of ranges from a Git blame."""
ranges: [BlameRange!]!
}
"""Represents a range of information from a Git blame."""
type BlameRange {
"""
Identifies the recency of the change, from 1 (new) to 10 (old). This is
calculated as a 2-quantile and determines the length of distance between the
median age of all the changes in the file and the recency of the current
range's change.
"""
age: Int!
"""Identifies the line author"""
commit: Commit!
"""The ending line for the range"""
endingLine: Int!
"""The starting line for the range"""
startingLine: Int!
}
"""Represents a Git blob."""
type Blob implements Node & GitObject {
"""An abbreviated version of the Git object ID"""
abbreviatedOid: String!
"""Byte size of Blob object"""
byteSize: Int!
"""The HTTP path for this Git object"""
commitResourcePath: URI!
"""The HTTP URL for this Git object"""
commitUrl: URI!
id: ID!
"""Indicates whether the Blob is binary or text"""
isBinary: Boolean!
"""Indicates whether the contents is truncated"""
isTruncated: Boolean!
"""The Git object ID"""
oid: GitObjectID!
"""The Repository the Git object belongs to"""
repository: Repository!
"""UTF8 text data or null if the Blob is binary"""
text: String
}
"""A special type of user which takes actions on behalf of GitHub Apps."""
type Bot implements Node & Actor & UniformResourceLocatable {
"""A URL pointing to the GitHub App's public avatar."""
avatarUrl(
"""The size of the resulting square image."""
size: Int
): URI!
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
"""The username of the actor."""
login: String!
"""The HTTP path for this bot"""
resourcePath: URI!
"""Identifies the date and time when the object was last updated."""
updatedAt: DateTime!
"""The HTTP URL for this bot"""
url: URI!
}
"""A branch protection rule."""
type BranchProtectionRule implements Node {
"""
A list of conflicts matching branches protection rule and other branch protection rules
"""
branchProtectionRuleConflicts(
"""
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
): BranchProtectionRuleConflictConnection!
"""The actor who created this branch protection rule."""
creator: Actor
"""Identifies the primary key from the database."""
databaseId: Int
"""
Will new commits pushed to matching branches dismiss pull request review approvals.
"""
dismissesStaleReviews: Boolean!
id: ID!
"""Can admins overwrite branch protection."""
isAdminEnforced: Boolean!
"""Repository refs that are protected by this rule"""
matchingRefs(
"""
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
): RefConnection!
"""Identifies the protection rule pattern."""
pattern: String!
"""A list push allowances for this branch protection rule."""
pushAllowances(
"""
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
): PushAllowanceConnection!
"""The repository associated with this branch protection rule."""
repository: Repository
"""Number of approving reviews required to update matching branches."""
requiredApprovingReviewCount: Int
"""
List of required status check contexts that must pass for commits to be accepted to matching branches.
"""
requiredStatusCheckContexts: [String]
"""Are approving reviews required to update matching branches."""
requiresApprovingReviews: Boolean!
"""Are commits required to be signed."""
requiresCommitSignatures: Boolean!
"""Are status checks required to update matching branches."""
requiresStatusChecks: Boolean!
"""Are branches required to be up to date before merging."""
requiresStrictStatusChecks: Boolean!
"""Is pushing to matching branches restricted."""
restrictsPushes: Boolean!
"""Is dismissal of pull request reviews restricted."""
restrictsReviewDismissals: Boolean!
"""A list review dismissal allowances for this branch protection rule."""
reviewDismissalAllowances(
"""
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
): ReviewDismissalAllowanceConnection!
}
"""A conflict between two branch protection rules."""
type BranchProtectionRuleConflict {
"""Identifies the branch protection rule."""
branchProtectionRule: BranchProtectionRule
"""Identifies the conflicting branch protection rule."""
conflictingBranchProtectionRule: BranchProtectionRule
"""Identifies the branch ref that has conflicting rules"""
ref: Ref
}
"""The connection type for BranchProtectionRuleConflict."""
type BranchProtectionRuleConflictConnection {
"""A list of edges."""
edges: [BranchProtectionRuleConflictEdge]
"""A list of nodes."""
nodes: [BranchProtectionRuleConflict]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type BranchProtectionRuleConflictEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: BranchProtectionRuleConflict
}
"""The connection type for BranchProtectionRule."""
type BranchProtectionRuleConnection {
"""A list of edges."""
edges: [BranchProtectionRuleEdge]
"""A list of nodes."""
nodes: [BranchProtectionRule]
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""Identifies the total count of items in the connection."""
totalCount: Int!
}
"""An edge in a connection."""
type BranchProtectionRuleEdge {
"""A cursor for use in pagination."""
cursor: String!
"""The item at the end of the edge."""
node: BranchProtectionRule
}
"""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 'closed' event on any `Closable`."""
type ClosedEvent implements Node & UniformResourceLocatable {
"""Identifies the actor who performed the event."""
actor: Actor
"""Object that was closed."""
closable: Closable!
"""Object which triggered the creation of this event."""
closer: Closer
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
id: ID!
"""The HTTP path for this closed event."""
resourcePath: URI!
"""The HTTP URL for this closed event."""
url: URI!
}
"""The object which triggered a `ClosedEvent`."""
union Closer = Commit | PullRequest
"""The Code of Conduct for a repository"""
type CodeOfConduct {
"""The body of the CoC"""
body: String
"""The key for the CoC"""
key: String!
"""The formal name of the CoC"""
name: String!
"""The path to the CoC"""
url: URI
}
"""Collaborators affiliation level with a subject."""
enum CollaboratorAffiliation {
"""All outside collaborators of an organization-owned subject."""
OUTSIDE
"""
All collaborators with permissions to an organization-owned subject, regardless of organization membership status.
"""
DIRECT
"""All collaborators the authenticated user can see."""
ALL
}
"""Types that can be inside Collection Items."""
union CollectionItemContent = Repository | Organization | User
"""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!
}
"""A comment author association with repository."""
enum CommentAuthorAssociation {
"""Author is a member of the organization that owns the repository."""
MEMBER
"""Author is the owner of the repository."""
OWNER
"""Author has been invited to collaborate on the repository."""
COLLABORATOR
"""Author has previously committed to the repository."""
CONTRIBUTOR
"""Author has not previously committed to the repository."""
FIRST_TIME_CONTRIBUTOR
"""Author has not previously committed to GitHub."""
FIRST_TIMER
"""Author has no association with the repository."""
NONE
}
"""The possible errors that will prevent a user from updating a comment."""
enum CommentCannotUpdateReason {
"""
You must be the author or have write access to this repository to update this comment.
"""
INSUFFICIENT_ACCESS
"""Unable to create comment because issue is locked."""
LOCKED
"""You must be logged in to update this comment."""
LOGIN_REQUIRED
"""Repository is under maintenance."""
MAINTENANCE
"""At least one email address must be verified to update this comment."""
VERIFIED_EMAIL_REQUIRED
"""You cannot update this comment"""
DENIED
}
"""
Represents a 'comment_deleted' event on a given issue or pull request.
"""
type CommentDeletedEvent implements Node {
"""Identifies the actor who performed the event."""
actor: Actor
"""Identifies the date and time when the object was created."""
createdAt: DateTime!
"""Identifies the primary key from the database."""
databaseId: Int
id: ID!
}
"""Represents a Git commit."""
type Commit implements Node & GitObject & Subscribable & UniformResourceLocatable {
"""An abbreviated version of the Git object ID"""
abbreviatedOid: String!
"""The number of additions in this commit."""
additions: Int!
"""Authorship details of the commit."""
author: GitActor
"""Check if the committer and the author match."""
authoredByCommitter: Boolean!
"""The datetime when this commit was authored."""
authoredDate: DateTime!
"""Fetches `git blame` information."""
blame(
"""The file whose Git blame information you want."""
path: String!
): Blame!
"""The number of changed files in this commit."""
changedFiles: Int!
"""Comments made on the commit."""
comments(
"""
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
You can’t perform that action at this time.