-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathgithub-mini-schema.graphql
More file actions
1078 lines (883 loc) · 18 KB
/
Copy pathgithub-mini-schema.graphql
File metadata and controls
1078 lines (883 loc) · 18 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
"""
An ISO-8601 encoded date string.
"""
scalar Date
"""
An ISO-8601 encoded UTC date string.
"""
scalar DateTime
"""
Git SSH string
"""
scalar GitSSHRemote
"""
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
"""
scalar URI
"""
A string containing HTML code.
"""
scalar HTML
"""
An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.
"""
scalar GitTimestamp
"""
A Git object ID.
"""
scalar GitObjectID
"""
The query root of GitHub's GraphQL interface.
"""
type Query {
"""
Lookup a organization by login.
"""
organization(
"""
The organization's login.
"""
login: String!
): Organization
"""
Lookup a given repository by the owner and repository name.
"""
repository(
"""
Follow repository renames. If disabled, a repository referenced by its old name will return an error.
"""
followRenames: Boolean = true
"""
The name of the repository
"""
name: String!
"""
The login field of a user or organization
"""
owner: String!
): Repository
}
"""
A list of repositories owned by the subject.
"""
type RepositoryConnection {
"""
A list of edges.
"""
edges: [RepositoryEdge]
"""
A list of nodes.
"""
nodes: [Repository]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
"""
The total size in kilobytes of all repositories in the connection.
"""
totalDiskUsage: Int!
}
"""
An edge in a connection.
"""
type RepositoryEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Repository
}
"""
A repository contains the content for a project.
"""
type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable {
id: ID!
"""
The number of kilobytes this repository occupies on disk.
"""
diskUsage: Int
"""
Returns how many forks there are of this repository in the whole network.
"""
forkCount: Int!
"""
A list of direct forked repositories.
"""
forks(
"""
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
"""
If non-null, filters repositories according to privacy
"""
privacy: RepositoryPrivacy
): RepositoryConnection!
"""
The name of the repository.
"""
name: String!
"""
The SSH URL to clone this repository
"""
sshUrl: GitSSHRemote!
"""
The HTTP URL for this repository
"""
url: URI!
"""
The Ref associated with the repository's default branch.
"""
defaultBranchRef: Ref
"""
The User owner of the repository.
"""
owner: RepositoryOwner!
"""
A list of issues that have been opened in the repository.
"""
issues(
"""
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 list of states to filter the issues by.
"""
states: [IssueState!]
): IssueConnection!
}
"""
Information about pagination in a connection.
"""
type PageInfo {
"""
When paginating forwards, the cursor to continue.
"""
endCursor: String
"""
When paginating forwards, are there more items?
"""
hasNextPage: Boolean!
"""
When paginating backwards, are there more items?
"""
hasPreviousPage: Boolean!
"""
When paginating backwards, the cursor to continue.
"""
startCursor: String
}
"""
The privacy of a repository
"""
enum RepositoryPrivacy {
"""
Private
"""
PRIVATE
"""
Public
"""
PUBLIC
}
"""
An account on GitHub, with one or more owners, that has repositories, members and teams.
"""
type Organization {
id: ID!
"""
The organization's public email.
"""
email: String
"""
Whether the organization has verified its profile email and website.
"""
isVerified: Boolean!
"""
The organization's login name.
"""
login: String!
"""
The organization's public profile name.
"""
name: String
"""
The HTTP URL for this organization.
"""
url: URI!
"""
A list of repositories that the user owns.
"""
repositories(
"""
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
): RepositoryConnection!
}
"""
Represents a Git reference.
"""
type Ref implements Node {
"""
The ref name.
"""
name: String!
"""
The ref's prefix, such as `refs/heads/` or `refs/tags/`.
"""
prefix: String!
"""
The repository the ref belongs to.
"""
repository: Repository!
"""
The object the ref points to. Returns null when object does not exist.
"""
target: GitObject
}
"""
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!
}
"""
Represents a Git commit.
"""
type Commit implements GitObject & Node & 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!
"""
The number of changed files in this commit. If GitHub is unable to calculate
the number of changed files (for example due to a timeout), this will return
`null`. We recommend using this field instead of `changedFiles`.
"""
changedFilesIfAvailable: Int
"""
The HTTP path for this Git object
"""
commitResourcePath: URI!
"""
The HTTP URL for this Git object
"""
commitUrl: URI!
"""
The datetime when this commit was committed.
"""
committedDate: DateTime!
"""
Check if committed via GitHub web UI.
"""
committedViaWeb: Boolean!
"""
Committer details of the commit.
"""
committer: GitActor
"""
The number of deletions in this commit.
"""
deletions: Int!
"""
The linear commit history starting from (and including) this commit, in the same order as `git log`.
"""
history(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
If non-null, filters history to only show commits with matching authorship.
"""
author: CommitAuthor
"""
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
"""
If non-null, filters history to only show commits touching files under this path.
"""
path: String
"""
Allows specifying a beginning time or date for fetching commits.
"""
since: GitTimestamp
"""
Allows specifying an ending time or date for fetching commits.
"""
until: GitTimestamp
): CommitHistoryConnection!
id: ID!
"""
The Git commit message
"""
message: String!
"""
The Git commit message body
"""
messageBody: String!
"""
The commit message body rendered to HTML.
"""
messageBodyHTML: HTML!
"""
The Git commit message headline
"""
messageHeadline: String!
"""
The commit message headline rendered to HTML.
"""
messageHeadlineHTML: HTML!
"""
The Git object ID
"""
oid: GitObjectID!
"""
The organization this commit was made on behalf of.
"""
onBehalfOf: Organization
"""
The datetime when this commit was pushed.
"""
pushedDate: DateTime
"""
The Repository this commit belongs to
"""
repository: Repository!
"""
The HTTP path for this commit
"""
resourcePath: URI!
"""
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
"""
tarballUrl: URI!
"""
The HTTP path for the tree of this commit
"""
treeResourcePath: URI!
"""
The HTTP URL for the tree of this commit
"""
treeUrl: URI!
"""
The HTTP URL for this commit
"""
url: URI!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Returns a URL to download a zipball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
"""
zipballUrl: URI!
}
"""
Represents an actor in a Git commit (ie. an author or committer).
"""
type GitActor {
"""
A URL pointing to the author's public avatar.
"""
avatarUrl(
"""
The size of the resulting square image.
"""
size: Int
): URI!
"""
The timestamp of the Git action (authoring or committing).
"""
date: GitTimestamp
"""
The email in the Git commit.
"""
email: String
"""
The name in the Git commit.
"""
name: String
}
"""
The connection type for Commit.
"""
type CommitHistoryConnection {
"""
A list of edges.
"""
edges: [CommitEdge]
"""
A list of nodes.
"""
nodes: [Commit]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type CommitEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Commit
}
"""
Specifies an author for filtering Git commits.
"""
input CommitAuthor {
"""
Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
"""
emails: [String!]
"""
ID of a User to filter by. If non-null, only commits authored by this user
will be returned. This field takes precedence over emails.
"""
id: ID
}
"""
Represents an owner of a Repository.
"""
interface RepositoryOwner {
id: ID!
"""
The username used to login.
"""
login: String!
"""
A list of repositories that the user owns.
"""
repositories(
"""
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
"""
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!
}
"""
The connection type for Issue.
"""
type IssueConnection {
"""
A list of edges.
"""
edges: [IssueEdge]
"""
A list of nodes.
"""
nodes: [Issue]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
Identifies the total count of items in the connection.
"""
totalCount: Int!
}
"""
An edge in a connection.
"""
type IssueEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Issue
}
"""
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
"""
type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & ProjectNextOwner & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
"""
Identifies the body of the issue.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The http path for this issue body
"""
bodyResourcePath: URI!
"""
Identifies the body of the issue rendered to text.
"""
bodyText: String!
"""
The http URL for this issue body
"""
bodyUrl: URI!
"""
`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
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Indicates whether or not this issue is currently pinned to the repository issues list
"""
isPinned: Boolean
"""
Is this issue read by the viewer
"""
isReadByViewer: Boolean
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
`true` if the object is locked
"""
locked: Boolean!
"""
Identifies the issue number.
"""
number: Int!
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
The repository associated with this node.
"""
repository: Repository!
"""
The HTTP path for this issue
"""
resourcePath: URI!
"""
Identifies the state of the issue.
"""
state: IssueState!
"""
Identifies the issue title.
"""
title: String!
"""
Identifies the issue title rendered to HTML.
"""
titleHTML: String!
"""
A list of issues that track this issue
"""
trackedInIssues(
"""
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
): IssueConnection!
"""
A list of issues tracked inside the current issue
"""
trackedIssues(
"""
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
): IssueConnection!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The HTTP URL for this issue
"""
url: URI!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
}
"""
The possible states of an issue.
"""
enum IssueState {
"""
An issue that has been closed
"""
CLOSED
"""
An issue that is still open
"""
OPEN
}