aboutsummaryrefslogtreecommitdiff
path: root/xtask/src
diff options
context:
space:
mode:
authorDmitry <[email protected]>2020-08-14 15:58:04 +0100
committerDmitry <[email protected]>2020-08-14 17:09:47 +0100
commitc8a6ecc075f5198a0b197d5d99afa517d4a9818d (patch)
tree913dd97be5e2c75c8ab0636c43d6b1fbe50037b2 /xtask/src
parent034db28c542c04b22147da6722328bc74ff99386 (diff)
Revert "replase sparse-checkout by github api"
This reverts commit 034db28c542c04b22147da6722328bc74ff99386.
Diffstat (limited to 'xtask/src')
-rw-r--r--xtask/src/codegen.rs6
-rw-r--r--xtask/src/codegen/gen_unstable_future_descriptor.rs175
-rw-r--r--xtask/src/codegen/last_commit_that_affected_path.graphql17
-rw-r--r--xtask/src/codegen/schema.graphql38281
4 files changed, 18 insertions, 38461 deletions
diff --git a/xtask/src/codegen.rs b/xtask/src/codegen.rs
index fca35792b..c7cac50fe 100644
--- a/xtask/src/codegen.rs
+++ b/xtask/src/codegen.rs
@@ -40,10 +40,8 @@ const AST_TOKENS: &str = "crates/ra_syntax/src/ast/generated/tokens.rs";
40const ASSISTS_DIR: &str = "crates/ra_assists/src/handlers"; 40const ASSISTS_DIR: &str = "crates/ra_assists/src/handlers";
41const ASSISTS_TESTS: &str = "crates/ra_assists/src/tests/generated.rs"; 41const ASSISTS_TESTS: &str = "crates/ra_assists/src/tests/generated.rs";
42 42
43const REPO_OWNER: &str = "rust-lang"; 43const REPOSITORY_URL: &str = "https://github.com/rust-lang/rust";
44const REPO_NAME: &str = "rust"; 44const UNSTABLE_FEATURE: &str = "crates/ra_ide/src/completion/unstable_feature_descriptor.rs";
45const REPO_PATH: &str = "src/doc/unstable-book/src";
46const GENERATION_DESTINATION: &str = "crates/ra_ide/src/completion/unstable_feature_descriptor.rs";
47 45
48#[derive(Debug, PartialEq, Eq, Clone, Copy)] 46#[derive(Debug, PartialEq, Eq, Clone, Copy)]
49pub enum Mode { 47pub enum Mode {
diff --git a/xtask/src/codegen/gen_unstable_future_descriptor.rs b/xtask/src/codegen/gen_unstable_future_descriptor.rs
index eaf063371..fee68c365 100644
--- a/xtask/src/codegen/gen_unstable_future_descriptor.rs
+++ b/xtask/src/codegen/gen_unstable_future_descriptor.rs
@@ -2,81 +2,27 @@
2 2
3use crate::codegen::update; 3use crate::codegen::update;
4use crate::codegen::{self, project_root, Mode, Result}; 4use crate::codegen::{self, project_root, Mode, Result};
5use chrono::prelude::*;
6use fs::read_to_string;
7use graphql_client::*;
8use proc_macro2::TokenStream;
9use quote::quote; 5use quote::quote;
10use regex::Regex;
11use reqwest;
12use serde::*;
13use std::fs; 6use std::fs;
14use std::fs::File;
15use std::io::copy;
16use std::io::prelude::*;
17use std::path::PathBuf;
18use std::process::Command; 7use std::process::Command;
19use walkdir::WalkDir; 8use walkdir::WalkDir;
20 9
21type URI = String; 10pub fn generate_unstable_future_descriptor(mode: Mode) -> Result<()> {
22type DateTime = String; 11 let path = project_root().join(codegen::STORAGE);
23 12 fs::create_dir_all(path.clone())?;
24#[derive(GraphQLQuery)]
25#[graphql(
26 schema_path = "src/codegen/schema.graphql",
27 query_path = "src/codegen/last_commit_that_affected_path.graphql"
28)]
29struct LastCommitThatAffectedPath;
30
31fn deep_destructuring(
32 response_body: Response<last_commit_that_affected_path::ResponseData>,
33) -> CommitInfo {
34 let t = response_body.data.unwrap().repository.unwrap().object.unwrap().on;
35
36 use last_commit_that_affected_path::LastCommitThatAffectedPathRepositoryObjectOn::Commit;
37 let commit = match t {
38 Commit(data) => data,
39 _ => panic!("type does not match"),
40 };
41 let edges = commit.history.edges.unwrap();
42 let node = edges.first().unwrap().as_ref().unwrap().node.as_ref().unwrap();
43 CommitInfo { commit_url: node.commit_url.clone(), committed_date: node.committed_date.clone() }
44}
45
46struct CommitInfo {
47 commit_url: String,
48 committed_date: String,
49}
50
51fn last_update(
52 owner: &str,
53 name: &str,
54 path: &str,
55 auth_token: Option<&str>,
56) -> Result<CommitInfo> {
57 let query =
58 LastCommitThatAffectedPath::build_query(last_commit_that_affected_path::Variables {
59 owner: owner.to_owned(),
60 name: name.to_owned(),
61 path: path.to_owned(),
62 });
63
64 let client = reqwest::blocking::Client::new();
65 let mut headers = reqwest::header::HeaderMap::new();
66 headers.insert("User-Agent", "https://github.com/rust-analyzer/rust-analyzer".parse()?);
67 let mut request = client.post("https://api.github.com/graphql").headers(headers).json(&query);
68
69 if auth_token.is_some() {
70 request = request.bearer_auth(auth_token.unwrap());
71 }
72
73 let response = request.send()?;
74 13
75 let response_body: Response<last_commit_that_affected_path::ResponseData> = response.json()?; 14 Command::new("git").current_dir(path.clone()).arg("init").output()?;
76 Ok(deep_destructuring(response_body)) 15 Command::new("git")
77} 16 .current_dir(path.clone())
17 .args(&["remote", "add", "-f", "origin", codegen::REPOSITORY_URL])
18 .output()?;
19 Command::new("git")
20 .current_dir(path.clone())
21 .args(&["sparse-checkout", "set", "/src/doc/unstable-book/src/"])
22 .output()?;
23 Command::new("git").current_dir(path.clone()).args(&["pull", "origin", "master"]).output()?;
78 24
79fn generate_descriptor(src_dir: PathBuf) -> Result<TokenStream> { 25 let src_dir = path.join("src/doc/unstable-book/src");
80 let files = WalkDir::new(src_dir.join("language-features")) 26 let files = WalkDir::new(src_dir.join("language-features"))
81 .into_iter() 27 .into_iter()
82 .chain(WalkDir::new(src_dir.join("library-features"))) 28 .chain(WalkDir::new(src_dir.join("library-features")))
@@ -107,98 +53,9 @@ fn generate_descriptor(src_dir: PathBuf) -> Result<TokenStream> {
107 #(#definitions),* 53 #(#definitions),*
108 ]; 54 ];
109 }; 55 };
110 Ok(ts)
111}
112
113fn add_anchor(text: impl std::fmt::Display, anchor: &str) -> String {
114 let anchor_str = format!(
115 r#"//The anchor is used to check if file is up to date and represent the time
116 //of the last commit that affected path where located data for generation
117 //ANCHOR: {}"#,
118 anchor
119 );
120 format!("{}\n\n{}\n", anchor_str, text)
121}
122
123fn is_actual(path: &PathBuf, str_datetime: &str) -> bool {
124 let re = Regex::new(r"//ANCHOR: (\S*)").unwrap();
125 let opt_str = fs::read_to_string(path);
126 if opt_str.is_err() {
127 return false;
128 }
129 let text = opt_str.unwrap();
130 let opt_datetime = re.captures(text.as_str());
131 if opt_datetime.is_none() {
132 return false;
133 }
134 let str_file_dt = opt_datetime.unwrap().get(1).unwrap().as_str();
135 let file_dt = str_file_dt.parse::<chrono::DateTime<Utc>>().unwrap();
136 let datetime = str_datetime.parse::<chrono::DateTime<Utc>>().unwrap();
137
138 file_dt == datetime
139}
140
141fn download_tar(
142 owner: &str,
143 name: &str,
144 auth_token: Option<&str>,
145 destination: &PathBuf,
146 fname: &str,
147) -> Result<()> {
148 let mut headers = reqwest::header::HeaderMap::new();
149 headers.insert("User-Agent", "https://github.com/rust-analyzer/rust-analyzer".parse()?);
150 let mut request = reqwest::blocking::Client::new()
151 .get(format!("https://api.github.com/repos/{}/{}/tarball", owner, name).as_str())
152 .headers(headers);
153
154 if auth_token.is_some() {
155 request = request.bearer_auth(auth_token.unwrap());
156 }
157
158 let response = request.send()?;
159 let download_url = response.url();
160
161 let mut response = reqwest::blocking::Client::new()
162 .get(download_url.as_str())
163 .send()?;
164
165 let mut n = fname.to_string();
166 n.push_str(".tar.gz");
167 let fpath = destination.join(n);
168 let mut file = File::create(fpath)?;
169 response.copy_to(&mut file)?;
170
171 Ok(())
172}
173
174pub fn generate_unstable_future_descriptor(mode: Mode) -> Result<()> {
175 const auth_token: Option<&str> = None;
176
177 let path = project_root().join(codegen::STORAGE);
178 fs::create_dir_all(path.clone())?;
179
180 let commit_info =
181 last_update(codegen::REPO_OWNER, codegen::REPO_NAME, codegen::REPO_PATH, auth_token)?;
182
183 if is_actual(
184 &project_root().join(codegen::GENERATION_DESTINATION),
185 commit_info.committed_date.as_str(),
186 ) {
187 return Ok(());
188 }
189
190 download_tar(codegen::REPO_OWNER, codegen::REPO_NAME, auth_token, &path, "repository")?;
191 Command::new("tar")
192 .args(&["-xvf", concat!("repository",".tar.gz"), "--wildcards", "*/src/doc/unstable-book/src", "--strip=1"])
193 .current_dir(codegen::STORAGE)
194 .output()?;
195
196 let src_dir = path.join(codegen::REPO_PATH);
197 let gen_holder = generate_descriptor(src_dir)?.to_string();
198 let gen_holder = add_anchor(gen_holder, commit_info.committed_date.as_str());
199 56
200 let destination = project_root().join(codegen::GENERATION_DESTINATION); 57 let destination = project_root().join(codegen::UNSTABLE_FEATURE);
201 let contents = crate::reformat(gen_holder)?; 58 let contents = crate::reformat(ts.to_string())?;
202 update(destination.as_path(), &contents, mode)?; 59 update(destination.as_path(), &contents, mode)?;
203 60
204 Ok(()) 61 Ok(())
diff --git a/xtask/src/codegen/last_commit_that_affected_path.graphql b/xtask/src/codegen/last_commit_that_affected_path.graphql
deleted file mode 100644
index 8b256f392..000000000
--- a/xtask/src/codegen/last_commit_that_affected_path.graphql
+++ /dev/null
@@ -1,17 +0,0 @@
1query LastCommitThatAffectedPath($owner: String!, $name: String!, $path: String!) {
2 repository(owner: $owner, name: $name) {
3 object(expression: "master") {
4 __typename
5 ... on Commit {
6 history(path: $path, first:1) {
7 edges {
8 node {
9 commitUrl
10 committedDate
11 }
12 }
13 }
14 }
15 }
16 }
17} \ No newline at end of file
diff --git a/xtask/src/codegen/schema.graphql b/xtask/src/codegen/schema.graphql
deleted file mode 100644
index 446c54b3e..000000000
--- a/xtask/src/codegen/schema.graphql
+++ /dev/null
@@ -1,38281 +0,0 @@
1"""
2Defines what type of global IDs are accepted for a mutation argument of type ID.
3"""
4directive @possibleTypes(
5 """
6 Abstract type of accepted global ID
7 """
8 abstractType: String
9
10 """
11 Accepted types of global IDs.
12 """
13 concreteTypes: [String!]!
14) on INPUT_FIELD_DEFINITION
15
16"""
17Marks an element of a GraphQL schema as only available via a preview header
18"""
19directive @preview(
20 """
21 The identifier of the API preview that toggles this field.
22 """
23 toggledBy: String!
24) on SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
25
26"""
27Autogenerated input type of AcceptEnterpriseAdministratorInvitation
28"""
29input AcceptEnterpriseAdministratorInvitationInput {
30 """
31 A unique identifier for the client performing the mutation.
32 """
33 clientMutationId: String
34
35 """
36 The id of the invitation being accepted
37 """
38 invitationId: ID! @possibleTypes(concreteTypes: ["EnterpriseAdministratorInvitation"])
39}
40
41"""
42Autogenerated return type of AcceptEnterpriseAdministratorInvitation
43"""
44type AcceptEnterpriseAdministratorInvitationPayload {
45 """
46 A unique identifier for the client performing the mutation.
47 """
48 clientMutationId: String
49
50 """
51 The invitation that was accepted.
52 """
53 invitation: EnterpriseAdministratorInvitation
54
55 """
56 A message confirming the result of accepting an administrator invitation.
57 """
58 message: String
59}
60
61"""
62Autogenerated input type of AcceptTopicSuggestion
63"""
64input AcceptTopicSuggestionInput {
65 """
66 A unique identifier for the client performing the mutation.
67 """
68 clientMutationId: String
69
70 """
71 The name of the suggested topic.
72 """
73 name: String!
74
75 """
76 The Node ID of the repository.
77 """
78 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
79}
80
81"""
82Autogenerated return type of AcceptTopicSuggestion
83"""
84type AcceptTopicSuggestionPayload {
85 """
86 A unique identifier for the client performing the mutation.
87 """
88 clientMutationId: String
89
90 """
91 The accepted topic.
92 """
93 topic: Topic
94}
95
96"""
97The possible capabilities for action executions setting.
98"""
99enum ActionExecutionCapabilitySetting {
100 """
101 All action executions are enabled.
102 """
103 ALL_ACTIONS
104
105 """
106 All action executions are disabled.
107 """
108 DISABLED
109
110 """
111 Only actions defined within the repo are allowed.
112 """
113 LOCAL_ACTIONS_ONLY
114
115 """
116 Organization administrators action execution capabilities.
117 """
118 NO_POLICY
119}
120
121"""
122Represents an object which can take actions on GitHub. Typically a User or Bot.
123"""
124interface Actor {
125 """
126 A URL pointing to the actor's public avatar.
127 """
128 avatarUrl(
129 """
130 The size of the resulting square image.
131 """
132 size: Int
133 ): URI!
134
135 """
136 The username of the actor.
137 """
138 login: String!
139
140 """
141 The HTTP path for this actor.
142 """
143 resourcePath: URI!
144
145 """
146 The HTTP URL for this actor.
147 """
148 url: URI!
149}
150
151"""
152Location information for an actor
153"""
154type ActorLocation {
155 """
156 City
157 """
158 city: String
159
160 """
161 Country name
162 """
163 country: String
164
165 """
166 Country code
167 """
168 countryCode: String
169
170 """
171 Region name
172 """
173 region: String
174
175 """
176 Region or state code
177 """
178 regionCode: String
179}
180
181"""
182Autogenerated input type of AddAssigneesToAssignable
183"""
184input AddAssigneesToAssignableInput {
185 """
186 The id of the assignable object to add assignees to.
187 """
188 assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
189
190 """
191 The id of users to add as assignees.
192 """
193 assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
194
195 """
196 A unique identifier for the client performing the mutation.
197 """
198 clientMutationId: String
199}
200
201"""
202Autogenerated return type of AddAssigneesToAssignable
203"""
204type AddAssigneesToAssignablePayload {
205 """
206 The item that was assigned.
207 """
208 assignable: Assignable
209
210 """
211 A unique identifier for the client performing the mutation.
212 """
213 clientMutationId: String
214}
215
216"""
217Autogenerated input type of AddComment
218"""
219input AddCommentInput {
220 """
221 The contents of the comment.
222 """
223 body: String!
224
225 """
226 A unique identifier for the client performing the mutation.
227 """
228 clientMutationId: String
229
230 """
231 The Node ID of the subject to modify.
232 """
233 subjectId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
234}
235
236"""
237Autogenerated return type of AddComment
238"""
239type AddCommentPayload {
240 """
241 A unique identifier for the client performing the mutation.
242 """
243 clientMutationId: String
244
245 """
246 The edge from the subject's comment connection.
247 """
248 commentEdge: IssueCommentEdge
249
250 """
251 The subject
252 """
253 subject: Node
254
255 """
256 The edge from the subject's timeline connection.
257 """
258 timelineEdge: IssueTimelineItemEdge
259}
260
261"""
262Autogenerated input type of AddLabelsToLabelable
263"""
264input AddLabelsToLabelableInput {
265 """
266 A unique identifier for the client performing the mutation.
267 """
268 clientMutationId: String
269
270 """
271 The ids of the labels to add.
272 """
273 labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"])
274
275 """
276 The id of the labelable object to add labels to.
277 """
278 labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
279}
280
281"""
282Autogenerated return type of AddLabelsToLabelable
283"""
284type AddLabelsToLabelablePayload {
285 """
286 A unique identifier for the client performing the mutation.
287 """
288 clientMutationId: String
289
290 """
291 The item that was labeled.
292 """
293 labelable: Labelable
294}
295
296"""
297Autogenerated input type of AddProjectCard
298"""
299input AddProjectCardInput {
300 """
301 A unique identifier for the client performing the mutation.
302 """
303 clientMutationId: String
304
305 """
306 The content of the card. Must be a member of the ProjectCardItem union
307 """
308 contentId: ID @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "ProjectCardItem")
309
310 """
311 The note on the card.
312 """
313 note: String
314
315 """
316 The Node ID of the ProjectColumn.
317 """
318 projectColumnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
319}
320
321"""
322Autogenerated return type of AddProjectCard
323"""
324type AddProjectCardPayload {
325 """
326 The edge from the ProjectColumn's card connection.
327 """
328 cardEdge: ProjectCardEdge
329
330 """
331 A unique identifier for the client performing the mutation.
332 """
333 clientMutationId: String
334
335 """
336 The ProjectColumn
337 """
338 projectColumn: ProjectColumn
339}
340
341"""
342Autogenerated input type of AddProjectColumn
343"""
344input AddProjectColumnInput {
345 """
346 A unique identifier for the client performing the mutation.
347 """
348 clientMutationId: String
349
350 """
351 The name of the column.
352 """
353 name: String!
354
355 """
356 The Node ID of the project.
357 """
358 projectId: ID! @possibleTypes(concreteTypes: ["Project"])
359}
360
361"""
362Autogenerated return type of AddProjectColumn
363"""
364type AddProjectColumnPayload {
365 """
366 A unique identifier for the client performing the mutation.
367 """
368 clientMutationId: String
369
370 """
371 The edge from the project's column connection.
372 """
373 columnEdge: ProjectColumnEdge
374
375 """
376 The project
377 """
378 project: Project
379}
380
381"""
382Autogenerated input type of AddPullRequestReviewComment
383"""
384input AddPullRequestReviewCommentInput {
385 """
386 The text of the comment.
387 """
388 body: String!
389
390 """
391 A unique identifier for the client performing the mutation.
392 """
393 clientMutationId: String
394
395 """
396 The SHA of the commit to comment on.
397 """
398 commitOID: GitObjectID
399
400 """
401 The comment id to reply to.
402 """
403 inReplyTo: ID @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
404
405 """
406 The relative path of the file to comment on.
407 """
408 path: String
409
410 """
411 The line index in the diff to comment on.
412 """
413 position: Int
414
415 """
416 The node ID of the pull request reviewing
417 """
418 pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"])
419
420 """
421 The Node ID of the review to modify.
422 """
423 pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
424}
425
426"""
427Autogenerated return type of AddPullRequestReviewComment
428"""
429type AddPullRequestReviewCommentPayload {
430 """
431 A unique identifier for the client performing the mutation.
432 """
433 clientMutationId: String
434
435 """
436 The newly created comment.
437 """
438 comment: PullRequestReviewComment
439
440 """
441 The edge from the review's comment connection.
442 """
443 commentEdge: PullRequestReviewCommentEdge
444}
445
446"""
447Autogenerated input type of AddPullRequestReview
448"""
449input AddPullRequestReviewInput {
450 """
451 The contents of the review body comment.
452 """
453 body: String
454
455 """
456 A unique identifier for the client performing the mutation.
457 """
458 clientMutationId: String
459
460 """
461 The review line comments.
462 """
463 comments: [DraftPullRequestReviewComment]
464
465 """
466 The commit OID the review pertains to.
467 """
468 commitOID: GitObjectID
469
470 """
471 The event to perform on the pull request review.
472 """
473 event: PullRequestReviewEvent
474
475 """
476 The Node ID of the pull request to modify.
477 """
478 pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
479
480 """
481 The review line comment threads.
482 """
483 threads: [DraftPullRequestReviewThread]
484}
485
486"""
487Autogenerated return type of AddPullRequestReview
488"""
489type AddPullRequestReviewPayload {
490 """
491 A unique identifier for the client performing the mutation.
492 """
493 clientMutationId: String
494
495 """
496 The newly created pull request review.
497 """
498 pullRequestReview: PullRequestReview
499
500 """
501 The edge from the pull request's review connection.
502 """
503 reviewEdge: PullRequestReviewEdge
504}
505
506"""
507Autogenerated input type of AddPullRequestReviewThread
508"""
509input AddPullRequestReviewThreadInput {
510 """
511 Body of the thread's first comment.
512 """
513 body: String!
514
515 """
516 A unique identifier for the client performing the mutation.
517 """
518 clientMutationId: String
519
520 """
521 The line of the blob to which the thread refers. The end of the line range for multi-line comments.
522 """
523 line: Int!
524
525 """
526 Path to the file being commented on.
527 """
528 path: String!
529
530 """
531 The Node ID of the review to modify.
532 """
533 pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
534
535 """
536 The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
537 """
538 side: DiffSide = RIGHT
539
540 """
541 The first line of the range to which the comment refers.
542 """
543 startLine: Int
544
545 """
546 The side of the diff on which the start line resides.
547 """
548 startSide: DiffSide = RIGHT
549}
550
551"""
552Autogenerated return type of AddPullRequestReviewThread
553"""
554type AddPullRequestReviewThreadPayload {
555 """
556 A unique identifier for the client performing the mutation.
557 """
558 clientMutationId: String
559
560 """
561 The newly created thread.
562 """
563 thread: PullRequestReviewThread
564}
565
566"""
567Autogenerated input type of AddReaction
568"""
569input AddReactionInput {
570 """
571 A unique identifier for the client performing the mutation.
572 """
573 clientMutationId: String
574
575 """
576 The name of the emoji to react with.
577 """
578 content: ReactionContent!
579
580 """
581 The Node ID of the subject to modify.
582 """
583 subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "Issue", "IssueComment", "PullRequest", "PullRequestReview", "PullRequestReviewComment", "TeamDiscussion", "TeamDiscussionComment"], abstractType: "Reactable")
584}
585
586"""
587Autogenerated return type of AddReaction
588"""
589type AddReactionPayload {
590 """
591 A unique identifier for the client performing the mutation.
592 """
593 clientMutationId: String
594
595 """
596 The reaction object.
597 """
598 reaction: Reaction
599
600 """
601 The reactable subject.
602 """
603 subject: Reactable
604}
605
606"""
607Autogenerated input type of AddStar
608"""
609input AddStarInput {
610 """
611 A unique identifier for the client performing the mutation.
612 """
613 clientMutationId: String
614
615 """
616 The Starrable ID to star.
617 """
618 starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable")
619}
620
621"""
622Autogenerated return type of AddStar
623"""
624type AddStarPayload {
625 """
626 A unique identifier for the client performing the mutation.
627 """
628 clientMutationId: String
629
630 """
631 The starrable.
632 """
633 starrable: Starrable
634}
635
636"""
637Represents a 'added_to_project' event on a given issue or pull request.
638"""
639type AddedToProjectEvent implements Node {
640 """
641 Identifies the actor who performed the event.
642 """
643 actor: Actor
644
645 """
646 Identifies the date and time when the object was created.
647 """
648 createdAt: DateTime!
649
650 """
651 Identifies the primary key from the database.
652 """
653 databaseId: Int
654 id: ID!
655
656 """
657 Project referenced by event.
658 """
659 project: Project @preview(toggledBy: "starfox-preview")
660
661 """
662 Project card referenced by this project event.
663 """
664 projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
665
666 """
667 Column name referenced by this project event.
668 """
669 projectColumnName: String! @preview(toggledBy: "starfox-preview")
670}
671
672"""
673A GitHub App.
674"""
675type App implements Node {
676 """
677 Identifies the date and time when the object was created.
678 """
679 createdAt: DateTime!
680
681 """
682 Identifies the primary key from the database.
683 """
684 databaseId: Int
685
686 """
687 The description of the app.
688 """
689 description: String
690 id: ID!
691
692 """
693 The hex color code, without the leading '#', for the logo background.
694 """
695 logoBackgroundColor: String!
696
697 """
698 A URL pointing to the app's logo.
699 """
700 logoUrl(
701 """
702 The size of the resulting image.
703 """
704 size: Int
705 ): URI!
706
707 """
708 The name of the app.
709 """
710 name: String!
711
712 """
713 A slug based on the name of the app for use in URLs.
714 """
715 slug: String!
716
717 """
718 Identifies the date and time when the object was last updated.
719 """
720 updatedAt: DateTime!
721
722 """
723 The URL to the app's homepage.
724 """
725 url: URI!
726}
727
728"""
729Autogenerated input type of ArchiveRepository
730"""
731input ArchiveRepositoryInput {
732 """
733 A unique identifier for the client performing the mutation.
734 """
735 clientMutationId: String
736
737 """
738 The ID of the repository to mark as archived.
739 """
740 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
741}
742
743"""
744Autogenerated return type of ArchiveRepository
745"""
746type ArchiveRepositoryPayload {
747 """
748 A unique identifier for the client performing the mutation.
749 """
750 clientMutationId: String
751
752 """
753 The repository that was marked as archived.
754 """
755 repository: Repository
756}
757
758"""
759An object that can have users assigned to it.
760"""
761interface Assignable {
762 """
763 A list of Users assigned to this object.
764 """
765 assignees(
766 """
767 Returns the elements in the list that come after the specified cursor.
768 """
769 after: String
770
771 """
772 Returns the elements in the list that come before the specified cursor.
773 """
774 before: String
775
776 """
777 Returns the first _n_ elements from the list.
778 """
779 first: Int
780
781 """
782 Returns the last _n_ elements from the list.
783 """
784 last: Int
785 ): UserConnection!
786}
787
788"""
789Represents an 'assigned' event on any assignable object.
790"""
791type AssignedEvent implements Node {
792 """
793 Identifies the actor who performed the event.
794 """
795 actor: Actor
796
797 """
798 Identifies the assignable associated with the event.
799 """
800 assignable: Assignable!
801
802 """
803 Identifies the user or mannequin that was assigned.
804 """
805 assignee: Assignee
806
807 """
808 Identifies the date and time when the object was created.
809 """
810 createdAt: DateTime!
811 id: ID!
812
813 """
814 Identifies the user who was assigned.
815 """
816 user: User @deprecated(reason: "Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.")
817}
818
819"""
820Types that can be assigned to issues.
821"""
822union Assignee = Bot | Mannequin | Organization | User
823
824"""
825An entry in the audit log.
826"""
827interface AuditEntry {
828 """
829 The action name
830 """
831 action: String!
832
833 """
834 The user who initiated the action
835 """
836 actor: AuditEntryActor
837
838 """
839 The IP address of the actor
840 """
841 actorIp: String
842
843 """
844 A readable representation of the actor's location
845 """
846 actorLocation: ActorLocation
847
848 """
849 The username of the user who initiated the action
850 """
851 actorLogin: String
852
853 """
854 The HTTP path for the actor.
855 """
856 actorResourcePath: URI
857
858 """
859 The HTTP URL for the actor.
860 """
861 actorUrl: URI
862
863 """
864 The time the action was initiated
865 """
866 createdAt: PreciseDateTime!
867
868 """
869 The corresponding operation type for the action
870 """
871 operationType: OperationType
872
873 """
874 The user affected by the action
875 """
876 user: User
877
878 """
879 For actions involving two users, the actor is the initiator and the user is the affected user.
880 """
881 userLogin: String
882
883 """
884 The HTTP path for the user.
885 """
886 userResourcePath: URI
887
888 """
889 The HTTP URL for the user.
890 """
891 userUrl: URI
892}
893
894"""
895Types that can initiate an audit log event.
896"""
897union AuditEntryActor = Bot | Organization | User
898
899"""
900Ordering options for Audit Log connections.
901"""
902input AuditLogOrder {
903 """
904 The ordering direction.
905 """
906 direction: OrderDirection
907
908 """
909 The field to order Audit Logs by.
910 """
911 field: AuditLogOrderField
912}
913
914"""
915Properties by which Audit Log connections can be ordered.
916"""
917enum AuditLogOrderField {
918 """
919 Order audit log entries by timestamp
920 """
921 CREATED_AT
922}
923
924"""
925Represents a 'automatic_base_change_failed' event on a given pull request.
926"""
927type AutomaticBaseChangeFailedEvent implements Node {
928 """
929 Identifies the actor who performed the event.
930 """
931 actor: Actor
932
933 """
934 Identifies the date and time when the object was created.
935 """
936 createdAt: DateTime!
937 id: ID!
938
939 """
940 The new base for this PR
941 """
942 newBase: String!
943
944 """
945 The old base for this PR
946 """
947 oldBase: String!
948
949 """
950 PullRequest referenced by event.
951 """
952 pullRequest: PullRequest!
953}
954
955"""
956Represents a 'automatic_base_change_succeeded' event on a given pull request.
957"""
958type AutomaticBaseChangeSucceededEvent implements Node {
959 """
960 Identifies the actor who performed the event.
961 """
962 actor: Actor
963
964 """
965 Identifies the date and time when the object was created.
966 """
967 createdAt: DateTime!
968 id: ID!
969
970 """
971 The new base for this PR
972 """
973 newBase: String!
974
975 """
976 The old base for this PR
977 """
978 oldBase: String!
979
980 """
981 PullRequest referenced by event.
982 """
983 pullRequest: PullRequest!
984}
985
986"""
987Represents a 'base_ref_changed' event on a given issue or pull request.
988"""
989type BaseRefChangedEvent implements Node {
990 """
991 Identifies the actor who performed the event.
992 """
993 actor: Actor
994
995 """
996 Identifies the date and time when the object was created.
997 """
998 createdAt: DateTime!
999
1000 """
1001 Identifies the primary key from the database.
1002 """
1003 databaseId: Int
1004 id: ID!
1005}
1006
1007"""
1008Represents a 'base_ref_force_pushed' event on a given pull request.
1009"""
1010type BaseRefForcePushedEvent implements Node {
1011 """
1012 Identifies the actor who performed the event.
1013 """
1014 actor: Actor
1015
1016 """
1017 Identifies the after commit SHA for the 'base_ref_force_pushed' event.
1018 """
1019 afterCommit: Commit
1020
1021 """
1022 Identifies the before commit SHA for the 'base_ref_force_pushed' event.
1023 """
1024 beforeCommit: Commit
1025
1026 """
1027 Identifies the date and time when the object was created.
1028 """
1029 createdAt: DateTime!
1030 id: ID!
1031
1032 """
1033 PullRequest referenced by event.
1034 """
1035 pullRequest: PullRequest!
1036
1037 """
1038 Identifies the fully qualified ref name for the 'base_ref_force_pushed' event.
1039 """
1040 ref: Ref
1041}
1042
1043"""
1044Represents a Git blame.
1045"""
1046type Blame {
1047 """
1048 The list of ranges from a Git blame.
1049 """
1050 ranges: [BlameRange!]!
1051}
1052
1053"""
1054Represents a range of information from a Git blame.
1055"""
1056type BlameRange {
1057 """
1058 Identifies the recency of the change, from 1 (new) to 10 (old). This is
1059 calculated as a 2-quantile and determines the length of distance between the
1060 median age of all the changes in the file and the recency of the current
1061 range's change.
1062 """
1063 age: Int!
1064
1065 """
1066 Identifies the line author
1067 """
1068 commit: Commit!
1069
1070 """
1071 The ending line for the range
1072 """
1073 endingLine: Int!
1074
1075 """
1076 The starting line for the range
1077 """
1078 startingLine: Int!
1079}
1080
1081"""
1082Represents a Git blob.
1083"""
1084type Blob implements GitObject & Node {
1085 """
1086 An abbreviated version of the Git object ID
1087 """
1088 abbreviatedOid: String!
1089
1090 """
1091 Byte size of Blob object
1092 """
1093 byteSize: Int!
1094
1095 """
1096 The HTTP path for this Git object
1097 """
1098 commitResourcePath: URI!
1099
1100 """
1101 The HTTP URL for this Git object
1102 """
1103 commitUrl: URI!
1104 id: ID!
1105
1106 """
1107 Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.
1108 """
1109 isBinary: Boolean
1110
1111 """
1112 Indicates whether the contents is truncated
1113 """
1114 isTruncated: Boolean!
1115
1116 """
1117 The Git object ID
1118 """
1119 oid: GitObjectID!
1120
1121 """
1122 The Repository the Git object belongs to
1123 """
1124 repository: Repository!
1125
1126 """
1127 UTF8 text data or null if the Blob is binary
1128 """
1129 text: String
1130}
1131
1132"""
1133A special type of user which takes actions on behalf of GitHub Apps.
1134"""
1135type Bot implements Actor & Node & UniformResourceLocatable {
1136 """
1137 A URL pointing to the GitHub App's public avatar.
1138 """
1139 avatarUrl(
1140 """
1141 The size of the resulting square image.
1142 """
1143 size: Int
1144 ): URI!
1145
1146 """
1147 Identifies the date and time when the object was created.
1148 """
1149 createdAt: DateTime!
1150
1151 """
1152 Identifies the primary key from the database.
1153 """
1154 databaseId: Int
1155 id: ID!
1156
1157 """
1158 The username of the actor.
1159 """
1160 login: String!
1161
1162 """
1163 The HTTP path for this bot
1164 """
1165 resourcePath: URI!
1166
1167 """
1168 Identifies the date and time when the object was last updated.
1169 """
1170 updatedAt: DateTime!
1171
1172 """
1173 The HTTP URL for this bot
1174 """
1175 url: URI!
1176}
1177
1178"""
1179A branch protection rule.
1180"""
1181type BranchProtectionRule implements Node {
1182 """
1183 A list of conflicts matching branches protection rule and other branch protection rules
1184 """
1185 branchProtectionRuleConflicts(
1186 """
1187 Returns the elements in the list that come after the specified cursor.
1188 """
1189 after: String
1190
1191 """
1192 Returns the elements in the list that come before the specified cursor.
1193 """
1194 before: String
1195
1196 """
1197 Returns the first _n_ elements from the list.
1198 """
1199 first: Int
1200
1201 """
1202 Returns the last _n_ elements from the list.
1203 """
1204 last: Int
1205 ): BranchProtectionRuleConflictConnection!
1206
1207 """
1208 The actor who created this branch protection rule.
1209 """
1210 creator: Actor
1211
1212 """
1213 Identifies the primary key from the database.
1214 """
1215 databaseId: Int
1216
1217 """
1218 Will new commits pushed to matching branches dismiss pull request review approvals.
1219 """
1220 dismissesStaleReviews: Boolean!
1221 id: ID!
1222
1223 """
1224 Can admins overwrite branch protection.
1225 """
1226 isAdminEnforced: Boolean!
1227
1228 """
1229 Repository refs that are protected by this rule
1230 """
1231 matchingRefs(
1232 """
1233 Returns the elements in the list that come after the specified cursor.
1234 """
1235 after: String
1236
1237 """
1238 Returns the elements in the list that come before the specified cursor.
1239 """
1240 before: String
1241
1242 """
1243 Returns the first _n_ elements from the list.
1244 """
1245 first: Int
1246
1247 """
1248 Returns the last _n_ elements from the list.
1249 """
1250 last: Int
1251
1252 """
1253 Filters refs with query on name
1254 """
1255 query: String
1256 ): RefConnection!
1257
1258 """
1259 Identifies the protection rule pattern.
1260 """
1261 pattern: String!
1262
1263 """
1264 A list push allowances for this branch protection rule.
1265 """
1266 pushAllowances(
1267 """
1268 Returns the elements in the list that come after the specified cursor.
1269 """
1270 after: String
1271
1272 """
1273 Returns the elements in the list that come before the specified cursor.
1274 """
1275 before: String
1276
1277 """
1278 Returns the first _n_ elements from the list.
1279 """
1280 first: Int
1281
1282 """
1283 Returns the last _n_ elements from the list.
1284 """
1285 last: Int
1286 ): PushAllowanceConnection!
1287
1288 """
1289 The repository associated with this branch protection rule.
1290 """
1291 repository: Repository
1292
1293 """
1294 Number of approving reviews required to update matching branches.
1295 """
1296 requiredApprovingReviewCount: Int
1297
1298 """
1299 List of required status check contexts that must pass for commits to be accepted to matching branches.
1300 """
1301 requiredStatusCheckContexts: [String]
1302
1303 """
1304 Are approving reviews required to update matching branches.
1305 """
1306 requiresApprovingReviews: Boolean!
1307
1308 """
1309 Are reviews from code owners required to update matching branches.
1310 """
1311 requiresCodeOwnerReviews: Boolean!
1312
1313 """
1314 Are commits required to be signed.
1315 """
1316 requiresCommitSignatures: Boolean!
1317
1318 """
1319 Are status checks required to update matching branches.
1320 """
1321 requiresStatusChecks: Boolean!
1322
1323 """
1324 Are branches required to be up to date before merging.
1325 """
1326 requiresStrictStatusChecks: Boolean!
1327
1328 """
1329 Is pushing to matching branches restricted.
1330 """
1331 restrictsPushes: Boolean!
1332
1333 """
1334 Is dismissal of pull request reviews restricted.
1335 """
1336 restrictsReviewDismissals: Boolean!
1337
1338 """
1339 A list review dismissal allowances for this branch protection rule.
1340 """
1341 reviewDismissalAllowances(
1342 """
1343 Returns the elements in the list that come after the specified cursor.
1344 """
1345 after: String
1346
1347 """
1348 Returns the elements in the list that come before the specified cursor.
1349 """
1350 before: String
1351
1352 """
1353 Returns the first _n_ elements from the list.
1354 """
1355 first: Int
1356
1357 """
1358 Returns the last _n_ elements from the list.
1359 """
1360 last: Int
1361 ): ReviewDismissalAllowanceConnection!
1362}
1363
1364"""
1365A conflict between two branch protection rules.
1366"""
1367type BranchProtectionRuleConflict {
1368 """
1369 Identifies the branch protection rule.
1370 """
1371 branchProtectionRule: BranchProtectionRule
1372
1373 """
1374 Identifies the conflicting branch protection rule.
1375 """
1376 conflictingBranchProtectionRule: BranchProtectionRule
1377
1378 """
1379 Identifies the branch ref that has conflicting rules
1380 """
1381 ref: Ref
1382}
1383
1384"""
1385The connection type for BranchProtectionRuleConflict.
1386"""
1387type BranchProtectionRuleConflictConnection {
1388 """
1389 A list of edges.
1390 """
1391 edges: [BranchProtectionRuleConflictEdge]
1392
1393 """
1394 A list of nodes.
1395 """
1396 nodes: [BranchProtectionRuleConflict]
1397
1398 """
1399 Information to aid in pagination.
1400 """
1401 pageInfo: PageInfo!
1402
1403 """
1404 Identifies the total count of items in the connection.
1405 """
1406 totalCount: Int!
1407}
1408
1409"""
1410An edge in a connection.
1411"""
1412type BranchProtectionRuleConflictEdge {
1413 """
1414 A cursor for use in pagination.
1415 """
1416 cursor: String!
1417
1418 """
1419 The item at the end of the edge.
1420 """
1421 node: BranchProtectionRuleConflict
1422}
1423
1424"""
1425The connection type for BranchProtectionRule.
1426"""
1427type BranchProtectionRuleConnection {
1428 """
1429 A list of edges.
1430 """
1431 edges: [BranchProtectionRuleEdge]
1432
1433 """
1434 A list of nodes.
1435 """
1436 nodes: [BranchProtectionRule]
1437
1438 """
1439 Information to aid in pagination.
1440 """
1441 pageInfo: PageInfo!
1442
1443 """
1444 Identifies the total count of items in the connection.
1445 """
1446 totalCount: Int!
1447}
1448
1449"""
1450An edge in a connection.
1451"""
1452type BranchProtectionRuleEdge {
1453 """
1454 A cursor for use in pagination.
1455 """
1456 cursor: String!
1457
1458 """
1459 The item at the end of the edge.
1460 """
1461 node: BranchProtectionRule
1462}
1463
1464"""
1465Autogenerated input type of CancelEnterpriseAdminInvitation
1466"""
1467input CancelEnterpriseAdminInvitationInput {
1468 """
1469 A unique identifier for the client performing the mutation.
1470 """
1471 clientMutationId: String
1472
1473 """
1474 The Node ID of the pending enterprise administrator invitation.
1475 """
1476 invitationId: ID! @possibleTypes(concreteTypes: ["EnterpriseAdministratorInvitation"])
1477}
1478
1479"""
1480Autogenerated return type of CancelEnterpriseAdminInvitation
1481"""
1482type CancelEnterpriseAdminInvitationPayload {
1483 """
1484 A unique identifier for the client performing the mutation.
1485 """
1486 clientMutationId: String
1487
1488 """
1489 The invitation that was canceled.
1490 """
1491 invitation: EnterpriseAdministratorInvitation
1492
1493 """
1494 A message confirming the result of canceling an administrator invitation.
1495 """
1496 message: String
1497}
1498
1499"""
1500Autogenerated input type of ChangeUserStatus
1501"""
1502input ChangeUserStatusInput {
1503 """
1504 A unique identifier for the client performing the mutation.
1505 """
1506 clientMutationId: String
1507
1508 """
1509 The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :grinning:.
1510 """
1511 emoji: String
1512
1513 """
1514 If set, the user status will not be shown after this date.
1515 """
1516 expiresAt: DateTime
1517
1518 """
1519 Whether this status should indicate you are not fully available on GitHub, e.g., you are away.
1520 """
1521 limitedAvailability: Boolean = false
1522
1523 """
1524 A short description of your current status.
1525 """
1526 message: String
1527
1528 """
1529 The ID of the organization whose members will be allowed to see the status. If
1530 omitted, the status will be publicly visible.
1531 """
1532 organizationId: ID @possibleTypes(concreteTypes: ["Organization"])
1533}
1534
1535"""
1536Autogenerated return type of ChangeUserStatus
1537"""
1538type ChangeUserStatusPayload {
1539 """
1540 A unique identifier for the client performing the mutation.
1541 """
1542 clientMutationId: String
1543
1544 """
1545 Your updated status.
1546 """
1547 status: UserStatus
1548}
1549
1550"""
1551A single check annotation.
1552"""
1553type CheckAnnotation @preview(toggledBy: "antiope-preview") {
1554 """
1555 The annotation's severity level.
1556 """
1557 annotationLevel: CheckAnnotationLevel
1558
1559 """
1560 The path to the file that this annotation was made on.
1561 """
1562 blobUrl: URI!
1563
1564 """
1565 Identifies the primary key from the database.
1566 """
1567 databaseId: Int
1568
1569 """
1570 The position of this annotation.
1571 """
1572 location: CheckAnnotationSpan!
1573
1574 """
1575 The annotation's message.
1576 """
1577 message: String!
1578
1579 """
1580 The path that this annotation was made on.
1581 """
1582 path: String!
1583
1584 """
1585 Additional information about the annotation.
1586 """
1587 rawDetails: String
1588
1589 """
1590 The annotation's title
1591 """
1592 title: String
1593}
1594
1595"""
1596The connection type for CheckAnnotation.
1597"""
1598type CheckAnnotationConnection {
1599 """
1600 A list of edges.
1601 """
1602 edges: [CheckAnnotationEdge]
1603
1604 """
1605 A list of nodes.
1606 """
1607 nodes: [CheckAnnotation] @preview(toggledBy: "antiope-preview")
1608
1609 """
1610 Information to aid in pagination.
1611 """
1612 pageInfo: PageInfo!
1613
1614 """
1615 Identifies the total count of items in the connection.
1616 """
1617 totalCount: Int!
1618}
1619
1620"""
1621Information from a check run analysis to specific lines of code.
1622"""
1623input CheckAnnotationData @preview(toggledBy: "antiope-preview") {
1624 """
1625 Represents an annotation's information level
1626 """
1627 annotationLevel: CheckAnnotationLevel!
1628
1629 """
1630 The location of the annotation
1631 """
1632 location: CheckAnnotationRange!
1633
1634 """
1635 A short description of the feedback for these lines of code.
1636 """
1637 message: String!
1638
1639 """
1640 The path of the file to add an annotation to.
1641 """
1642 path: String!
1643
1644 """
1645 Details about this annotation.
1646 """
1647 rawDetails: String
1648
1649 """
1650 The title that represents the annotation.
1651 """
1652 title: String
1653}
1654
1655"""
1656An edge in a connection.
1657"""
1658type CheckAnnotationEdge {
1659 """
1660 A cursor for use in pagination.
1661 """
1662 cursor: String!
1663
1664 """
1665 The item at the end of the edge.
1666 """
1667 node: CheckAnnotation @preview(toggledBy: "antiope-preview")
1668}
1669
1670"""
1671Represents an annotation's information level.
1672"""
1673enum CheckAnnotationLevel @preview(toggledBy: "antiope-preview") {
1674 """
1675 An annotation indicating an inescapable error.
1676 """
1677 FAILURE
1678
1679 """
1680 An annotation indicating some information.
1681 """
1682 NOTICE
1683
1684 """
1685 An annotation indicating an ignorable error.
1686 """
1687 WARNING
1688}
1689
1690"""
1691A character position in a check annotation.
1692"""
1693type CheckAnnotationPosition @preview(toggledBy: "antiope-preview") {
1694 """
1695 Column number (1 indexed).
1696 """
1697 column: Int
1698
1699 """
1700 Line number (1 indexed).
1701 """
1702 line: Int!
1703}
1704
1705"""
1706Information from a check run analysis to specific lines of code.
1707"""
1708input CheckAnnotationRange @preview(toggledBy: "antiope-preview") {
1709 """
1710 The ending column of the range.
1711 """
1712 endColumn: Int
1713
1714 """
1715 The ending line of the range.
1716 """
1717 endLine: Int!
1718
1719 """
1720 The starting column of the range.
1721 """
1722 startColumn: Int
1723
1724 """
1725 The starting line of the range.
1726 """
1727 startLine: Int!
1728}
1729
1730"""
1731An inclusive pair of positions for a check annotation.
1732"""
1733type CheckAnnotationSpan @preview(toggledBy: "antiope-preview") {
1734 """
1735 End position (inclusive).
1736 """
1737 end: CheckAnnotationPosition!
1738
1739 """
1740 Start position (inclusive).
1741 """
1742 start: CheckAnnotationPosition!
1743}
1744
1745"""
1746The possible states for a check suite or run conclusion.
1747"""
1748enum CheckConclusionState @preview(toggledBy: "antiope-preview") {
1749 """
1750 The check suite or run requires action.
1751 """
1752 ACTION_REQUIRED
1753
1754 """
1755 The check suite or run has been cancelled.
1756 """
1757 CANCELLED
1758
1759 """
1760 The check suite or run has failed.
1761 """
1762 FAILURE
1763
1764 """
1765 The check suite or run was neutral.
1766 """
1767 NEUTRAL
1768
1769 """
1770 The check suite or run was skipped.
1771 """
1772 SKIPPED
1773
1774 """
1775 The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.
1776 """
1777 STALE
1778
1779 """
1780 The check suite or run has succeeded.
1781 """
1782 SUCCESS
1783
1784 """
1785 The check suite or run has timed out.
1786 """
1787 TIMED_OUT
1788}
1789
1790"""
1791A check run.
1792"""
1793type CheckRun implements Node & UniformResourceLocatable @preview(toggledBy: "antiope-preview") {
1794 """
1795 The check run's annotations
1796 """
1797 annotations(
1798 """
1799 Returns the elements in the list that come after the specified cursor.
1800 """
1801 after: String
1802
1803 """
1804 Returns the elements in the list that come before the specified cursor.
1805 """
1806 before: String
1807
1808 """
1809 Returns the first _n_ elements from the list.
1810 """
1811 first: Int
1812
1813 """
1814 Returns the last _n_ elements from the list.
1815 """
1816 last: Int
1817 ): CheckAnnotationConnection
1818
1819 """
1820 The check suite that this run is a part of.
1821 """
1822 checkSuite: CheckSuite!
1823
1824 """
1825 Identifies the date and time when the check run was completed.
1826 """
1827 completedAt: DateTime
1828
1829 """
1830 The conclusion of the check run.
1831 """
1832 conclusion: CheckConclusionState
1833
1834 """
1835 Identifies the primary key from the database.
1836 """
1837 databaseId: Int
1838
1839 """
1840 The URL from which to find full details of the check run on the integrator's site.
1841 """
1842 detailsUrl: URI
1843
1844 """
1845 A reference for the check run on the integrator's system.
1846 """
1847 externalId: String
1848 id: ID!
1849
1850 """
1851 The name of the check for this check run.
1852 """
1853 name: String!
1854
1855 """
1856 The permalink to the check run summary.
1857 """
1858 permalink: URI!
1859
1860 """
1861 The repository associated with this check run.
1862 """
1863 repository: Repository!
1864
1865 """
1866 The HTTP path for this check run.
1867 """
1868 resourcePath: URI!
1869
1870 """
1871 Identifies the date and time when the check run was started.
1872 """
1873 startedAt: DateTime
1874
1875 """
1876 The current status of the check run.
1877 """
1878 status: CheckStatusState!
1879
1880 """
1881 A string representing the check run's summary
1882 """
1883 summary: String
1884
1885 """
1886 A string representing the check run's text
1887 """
1888 text: String
1889
1890 """
1891 A string representing the check run
1892 """
1893 title: String
1894
1895 """
1896 The HTTP URL for this check run.
1897 """
1898 url: URI!
1899}
1900
1901"""
1902Possible further actions the integrator can perform.
1903"""
1904input CheckRunAction @preview(toggledBy: "antiope-preview") {
1905 """
1906 A short explanation of what this action would do.
1907 """
1908 description: String!
1909
1910 """
1911 A reference for the action on the integrator's system.
1912 """
1913 identifier: String!
1914
1915 """
1916 The text to be displayed on a button in the web UI.
1917 """
1918 label: String!
1919}
1920
1921"""
1922The connection type for CheckRun.
1923"""
1924type CheckRunConnection {
1925 """
1926 A list of edges.
1927 """
1928 edges: [CheckRunEdge]
1929
1930 """
1931 A list of nodes.
1932 """
1933 nodes: [CheckRun] @preview(toggledBy: "antiope-preview")
1934
1935 """
1936 Information to aid in pagination.
1937 """
1938 pageInfo: PageInfo!
1939
1940 """
1941 Identifies the total count of items in the connection.
1942 """
1943 totalCount: Int!
1944}
1945
1946"""
1947An edge in a connection.
1948"""
1949type CheckRunEdge {
1950 """
1951 A cursor for use in pagination.
1952 """
1953 cursor: String!
1954
1955 """
1956 The item at the end of the edge.
1957 """
1958 node: CheckRun @preview(toggledBy: "antiope-preview")
1959}
1960
1961"""
1962The filters that are available when fetching check runs.
1963"""
1964input CheckRunFilter @preview(toggledBy: "antiope-preview") {
1965 """
1966 Filters the check runs created by this application ID.
1967 """
1968 appId: Int
1969
1970 """
1971 Filters the check runs by this name.
1972 """
1973 checkName: String
1974
1975 """
1976 Filters the check runs by this type.
1977 """
1978 checkType: CheckRunType
1979
1980 """
1981 Filters the check runs by this status.
1982 """
1983 status: CheckStatusState
1984}
1985
1986"""
1987Descriptive details about the check run.
1988"""
1989input CheckRunOutput @preview(toggledBy: "antiope-preview") {
1990 """
1991 The annotations that are made as part of the check run.
1992 """
1993 annotations: [CheckAnnotationData!]
1994
1995 """
1996 Images attached to the check run output displayed in the GitHub pull request UI.
1997 """
1998 images: [CheckRunOutputImage!]
1999
2000 """
2001 The summary of the check run (supports Commonmark).
2002 """
2003 summary: String!
2004
2005 """
2006 The details of the check run (supports Commonmark).
2007 """
2008 text: String
2009
2010 """
2011 A title to provide for this check run.
2012 """
2013 title: String!
2014}
2015
2016"""
2017Images attached to the check run output displayed in the GitHub pull request UI.
2018"""
2019input CheckRunOutputImage @preview(toggledBy: "antiope-preview") {
2020 """
2021 The alternative text for the image.
2022 """
2023 alt: String!
2024
2025 """
2026 A short image description.
2027 """
2028 caption: String
2029
2030 """
2031 The full URL of the image.
2032 """
2033 imageUrl: URI!
2034}
2035
2036"""
2037The possible types of check runs.
2038"""
2039enum CheckRunType @preview(toggledBy: "antiope-preview") {
2040 """
2041 Every check run available.
2042 """
2043 ALL
2044
2045 """
2046 The latest check run.
2047 """
2048 LATEST
2049}
2050
2051"""
2052The possible states for a check suite or run status.
2053"""
2054enum CheckStatusState @preview(toggledBy: "antiope-preview") {
2055 """
2056 The check suite or run has been completed.
2057 """
2058 COMPLETED
2059
2060 """
2061 The check suite or run is in progress.
2062 """
2063 IN_PROGRESS
2064
2065 """
2066 The check suite or run has been queued.
2067 """
2068 QUEUED
2069
2070 """
2071 The check suite or run has been requested.
2072 """
2073 REQUESTED
2074}
2075
2076"""
2077A check suite.
2078"""
2079type CheckSuite implements Node @preview(toggledBy: "antiope-preview") {
2080 """
2081 The GitHub App which created this check suite.
2082 """
2083 app: App
2084
2085 """
2086 The name of the branch for this check suite.
2087 """
2088 branch: Ref
2089
2090 """
2091 The check runs associated with a check suite.
2092 """
2093 checkRuns(
2094 """
2095 Returns the elements in the list that come after the specified cursor.
2096 """
2097 after: String
2098
2099 """
2100 Returns the elements in the list that come before the specified cursor.
2101 """
2102 before: String
2103
2104 """
2105 Filters the check runs by this type.
2106 """
2107 filterBy: CheckRunFilter
2108
2109 """
2110 Returns the first _n_ elements from the list.
2111 """
2112 first: Int
2113
2114 """
2115 Returns the last _n_ elements from the list.
2116 """
2117 last: Int
2118 ): CheckRunConnection
2119
2120 """
2121 The commit for this check suite
2122 """
2123 commit: Commit!
2124
2125 """
2126 The conclusion of this check suite.
2127 """
2128 conclusion: CheckConclusionState
2129
2130 """
2131 Identifies the date and time when the object was created.
2132 """
2133 createdAt: DateTime!
2134
2135 """
2136 Identifies the primary key from the database.
2137 """
2138 databaseId: Int
2139 id: ID!
2140
2141 """
2142 A list of open pull requests matching the check suite.
2143 """
2144 matchingPullRequests(
2145 """
2146 Returns the elements in the list that come after the specified cursor.
2147 """
2148 after: String
2149
2150 """
2151 The base ref name to filter the pull requests by.
2152 """
2153 baseRefName: String
2154
2155 """
2156 Returns the elements in the list that come before the specified cursor.
2157 """
2158 before: String
2159
2160 """
2161 Returns the first _n_ elements from the list.
2162 """
2163 first: Int
2164
2165 """
2166 The head ref name to filter the pull requests by.
2167 """
2168 headRefName: String
2169
2170 """
2171 A list of label names to filter the pull requests by.
2172 """
2173 labels: [String!]
2174
2175 """
2176 Returns the last _n_ elements from the list.
2177 """
2178 last: Int
2179
2180 """
2181 Ordering options for pull requests returned from the connection.
2182 """
2183 orderBy: IssueOrder
2184
2185 """
2186 A list of states to filter the pull requests by.
2187 """
2188 states: [PullRequestState!]
2189 ): PullRequestConnection
2190
2191 """
2192 The push that triggered this check suite.
2193 """
2194 push: Push
2195
2196 """
2197 The repository associated with this check suite.
2198 """
2199 repository: Repository!
2200
2201 """
2202 The HTTP path for this check suite
2203 """
2204 resourcePath: URI!
2205
2206 """
2207 The status of this check suite.
2208 """
2209 status: CheckStatusState!
2210
2211 """
2212 Identifies the date and time when the object was last updated.
2213 """
2214 updatedAt: DateTime!
2215
2216 """
2217 The HTTP URL for this check suite
2218 """
2219 url: URI!
2220}
2221
2222"""
2223The auto-trigger preferences that are available for check suites.
2224"""
2225input CheckSuiteAutoTriggerPreference @preview(toggledBy: "antiope-preview") {
2226 """
2227 The node ID of the application that owns the check suite.
2228 """
2229 appId: ID!
2230
2231 """
2232 Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository.
2233 """
2234 setting: Boolean!
2235}
2236
2237"""
2238The connection type for CheckSuite.
2239"""
2240type CheckSuiteConnection {
2241 """
2242 A list of edges.
2243 """
2244 edges: [CheckSuiteEdge]
2245
2246 """
2247 A list of nodes.
2248 """
2249 nodes: [CheckSuite] @preview(toggledBy: "antiope-preview")
2250
2251 """
2252 Information to aid in pagination.
2253 """
2254 pageInfo: PageInfo!
2255
2256 """
2257 Identifies the total count of items in the connection.
2258 """
2259 totalCount: Int!
2260}
2261
2262"""
2263An edge in a connection.
2264"""
2265type CheckSuiteEdge {
2266 """
2267 A cursor for use in pagination.
2268 """
2269 cursor: String!
2270
2271 """
2272 The item at the end of the edge.
2273 """
2274 node: CheckSuite @preview(toggledBy: "antiope-preview")
2275}
2276
2277"""
2278The filters that are available when fetching check suites.
2279"""
2280input CheckSuiteFilter @preview(toggledBy: "antiope-preview") {
2281 """
2282 Filters the check suites created by this application ID.
2283 """
2284 appId: Int
2285
2286 """
2287 Filters the check suites by this name.
2288 """
2289 checkName: String
2290}
2291
2292"""
2293Autogenerated input type of ClearLabelsFromLabelable
2294"""
2295input ClearLabelsFromLabelableInput {
2296 """
2297 A unique identifier for the client performing the mutation.
2298 """
2299 clientMutationId: String
2300
2301 """
2302 The id of the labelable object to clear the labels from.
2303 """
2304 labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
2305}
2306
2307"""
2308Autogenerated return type of ClearLabelsFromLabelable
2309"""
2310type ClearLabelsFromLabelablePayload {
2311 """
2312 A unique identifier for the client performing the mutation.
2313 """
2314 clientMutationId: String
2315
2316 """
2317 The item that was unlabeled.
2318 """
2319 labelable: Labelable
2320}
2321
2322"""
2323Autogenerated input type of CloneProject
2324"""
2325input CloneProjectInput {
2326 """
2327 The description of the project.
2328 """
2329 body: String
2330
2331 """
2332 A unique identifier for the client performing the mutation.
2333 """
2334 clientMutationId: String
2335
2336 """
2337 Whether or not to clone the source project's workflows.
2338 """
2339 includeWorkflows: Boolean!
2340
2341 """
2342 The name of the project.
2343 """
2344 name: String!
2345
2346 """
2347 The visibility of the project, defaults to false (private).
2348 """
2349 public: Boolean
2350
2351 """
2352 The source project to clone.
2353 """
2354 sourceId: ID! @possibleTypes(concreteTypes: ["Project"])
2355
2356 """
2357 The owner ID to create the project under.
2358 """
2359 targetOwnerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
2360}
2361
2362"""
2363Autogenerated return type of CloneProject
2364"""
2365type CloneProjectPayload {
2366 """
2367 A unique identifier for the client performing the mutation.
2368 """
2369 clientMutationId: String
2370
2371 """
2372 The id of the JobStatus for populating cloned fields.
2373 """
2374 jobStatusId: String
2375
2376 """
2377 The new cloned project.
2378 """
2379 project: Project
2380}
2381
2382"""
2383Autogenerated input type of CloneTemplateRepository
2384"""
2385input CloneTemplateRepositoryInput {
2386 """
2387 A unique identifier for the client performing the mutation.
2388 """
2389 clientMutationId: String
2390
2391 """
2392 A short description of the new repository.
2393 """
2394 description: String
2395
2396 """
2397 Whether to copy all branches from the template to the new repository. Defaults
2398 to copying only the default branch of the template.
2399 """
2400 includeAllBranches: Boolean = false
2401
2402 """
2403 The name of the new repository.
2404 """
2405 name: String!
2406
2407 """
2408 The ID of the owner for the new repository.
2409 """
2410 ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "RepositoryOwner")
2411
2412 """
2413 The Node ID of the template repository.
2414 """
2415 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
2416
2417 """
2418 Indicates the repository's visibility level.
2419 """
2420 visibility: RepositoryVisibility!
2421}
2422
2423"""
2424Autogenerated return type of CloneTemplateRepository
2425"""
2426type CloneTemplateRepositoryPayload {
2427 """
2428 A unique identifier for the client performing the mutation.
2429 """
2430 clientMutationId: String
2431
2432 """
2433 The new repository.
2434 """
2435 repository: Repository
2436}
2437
2438"""
2439An object that can be closed
2440"""
2441interface Closable {
2442 """
2443 `true` if the object is closed (definition of closed may depend on type)
2444 """
2445 closed: Boolean!
2446
2447 """
2448 Identifies the date and time when the object was closed.
2449 """
2450 closedAt: DateTime
2451}
2452
2453"""
2454Autogenerated input type of CloseIssue
2455"""
2456input CloseIssueInput {
2457 """
2458 A unique identifier for the client performing the mutation.
2459 """
2460 clientMutationId: String
2461
2462 """
2463 ID of the issue to be closed.
2464 """
2465 issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
2466}
2467
2468"""
2469Autogenerated return type of CloseIssue
2470"""
2471type CloseIssuePayload {
2472 """
2473 A unique identifier for the client performing the mutation.
2474 """
2475 clientMutationId: String
2476
2477 """
2478 The issue that was closed.
2479 """
2480 issue: Issue
2481}
2482
2483"""
2484Autogenerated input type of ClosePullRequest
2485"""
2486input ClosePullRequestInput {
2487 """
2488 A unique identifier for the client performing the mutation.
2489 """
2490 clientMutationId: String
2491
2492 """
2493 ID of the pull request to be closed.
2494 """
2495 pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
2496}
2497
2498"""
2499Autogenerated return type of ClosePullRequest
2500"""
2501type ClosePullRequestPayload {
2502 """
2503 A unique identifier for the client performing the mutation.
2504 """
2505 clientMutationId: String
2506
2507 """
2508 The pull request that was closed.
2509 """
2510 pullRequest: PullRequest
2511}
2512
2513"""
2514Represents a 'closed' event on any `Closable`.
2515"""
2516type ClosedEvent implements Node & UniformResourceLocatable {
2517 """
2518 Identifies the actor who performed the event.
2519 """
2520 actor: Actor
2521
2522 """
2523 Object that was closed.
2524 """
2525 closable: Closable!
2526
2527 """
2528 Object which triggered the creation of this event.
2529 """
2530 closer: Closer
2531
2532 """
2533 Identifies the date and time when the object was created.
2534 """
2535 createdAt: DateTime!
2536 id: ID!
2537
2538 """
2539 The HTTP path for this closed event.
2540 """
2541 resourcePath: URI!
2542
2543 """
2544 The HTTP URL for this closed event.
2545 """
2546 url: URI!
2547}
2548
2549"""
2550The object which triggered a `ClosedEvent`.
2551"""
2552union Closer = Commit | PullRequest
2553
2554"""
2555The Code of Conduct for a repository
2556"""
2557type CodeOfConduct implements Node {
2558 """
2559 The body of the Code of Conduct
2560 """
2561 body: String
2562 id: ID!
2563
2564 """
2565 The key for the Code of Conduct
2566 """
2567 key: String!
2568
2569 """
2570 The formal name of the Code of Conduct
2571 """
2572 name: String!
2573
2574 """
2575 The HTTP path for this Code of Conduct
2576 """
2577 resourcePath: URI
2578
2579 """
2580 The HTTP URL for this Code of Conduct
2581 """
2582 url: URI
2583}
2584
2585"""
2586Collaborators affiliation level with a subject.
2587"""
2588enum CollaboratorAffiliation {
2589 """
2590 All collaborators the authenticated user can see.
2591 """
2592 ALL
2593
2594 """
2595 All collaborators with permissions to an organization-owned subject, regardless of organization membership status.
2596 """
2597 DIRECT
2598
2599 """
2600 All outside collaborators of an organization-owned subject.
2601 """
2602 OUTSIDE
2603}
2604
2605"""
2606Represents a comment.
2607"""
2608interface Comment {
2609 """
2610 The actor who authored the comment.
2611 """
2612 author: Actor
2613
2614 """
2615 Author's association with the subject of the comment.
2616 """
2617 authorAssociation: CommentAuthorAssociation!
2618
2619 """
2620 The body as Markdown.
2621 """
2622 body: String!
2623
2624 """
2625 The body rendered to HTML.
2626 """
2627 bodyHTML: HTML!
2628
2629 """
2630 The body rendered to text.
2631 """
2632 bodyText: String!
2633
2634 """
2635 Identifies the date and time when the object was created.
2636 """
2637 createdAt: DateTime!
2638
2639 """
2640 Check if this comment was created via an email reply.
2641 """
2642 createdViaEmail: Boolean!
2643
2644 """
2645 The actor who edited the comment.
2646 """
2647 editor: Actor
2648 id: ID!
2649
2650 """
2651 Check if this comment was edited and includes an edit with the creation data
2652 """
2653 includesCreatedEdit: Boolean!
2654
2655 """
2656 The moment the editor made the last edit
2657 """
2658 lastEditedAt: DateTime
2659
2660 """
2661 Identifies when the comment was published at.
2662 """
2663 publishedAt: DateTime
2664
2665 """
2666 Identifies the date and time when the object was last updated.
2667 """
2668 updatedAt: DateTime!
2669
2670 """
2671 A list of edits to this content.
2672 """
2673 userContentEdits(
2674 """
2675 Returns the elements in the list that come after the specified cursor.
2676 """
2677 after: String
2678
2679 """
2680 Returns the elements in the list that come before the specified cursor.
2681 """
2682 before: String
2683
2684 """
2685 Returns the first _n_ elements from the list.
2686 """
2687 first: Int
2688
2689 """
2690 Returns the last _n_ elements from the list.
2691 """
2692 last: Int
2693 ): UserContentEditConnection
2694
2695 """
2696 Did the viewer author this comment.
2697 """
2698 viewerDidAuthor: Boolean!
2699}
2700
2701"""
2702A comment author association with repository.
2703"""
2704enum CommentAuthorAssociation {
2705 """
2706 Author has been invited to collaborate on the repository.
2707 """
2708 COLLABORATOR
2709
2710 """
2711 Author has previously committed to the repository.
2712 """
2713 CONTRIBUTOR
2714
2715 """
2716 Author has not previously committed to GitHub.
2717 """
2718 FIRST_TIMER
2719
2720 """
2721 Author has not previously committed to the repository.
2722 """
2723 FIRST_TIME_CONTRIBUTOR
2724
2725 """
2726 Author is a member of the organization that owns the repository.
2727 """
2728 MEMBER
2729
2730 """
2731 Author has no association with the repository.
2732 """
2733 NONE
2734
2735 """
2736 Author is the owner of the repository.
2737 """
2738 OWNER
2739}
2740
2741"""
2742The possible errors that will prevent a user from updating a comment.
2743"""
2744enum CommentCannotUpdateReason {
2745 """
2746 Unable to create comment because repository is archived.
2747 """
2748 ARCHIVED
2749
2750 """
2751 You cannot update this comment
2752 """
2753 DENIED
2754
2755 """
2756 You must be the author or have write access to this repository to update this comment.
2757 """
2758 INSUFFICIENT_ACCESS
2759
2760 """
2761 Unable to create comment because issue is locked.
2762 """
2763 LOCKED
2764
2765 """
2766 You must be logged in to update this comment.
2767 """
2768 LOGIN_REQUIRED
2769
2770 """
2771 Repository is under maintenance.
2772 """
2773 MAINTENANCE
2774
2775 """
2776 At least one email address must be verified to update this comment.
2777 """
2778 VERIFIED_EMAIL_REQUIRED
2779}
2780
2781"""
2782Represents a 'comment_deleted' event on a given issue or pull request.
2783"""
2784type CommentDeletedEvent implements Node {
2785 """
2786 Identifies the actor who performed the event.
2787 """
2788 actor: Actor
2789
2790 """
2791 Identifies the date and time when the object was created.
2792 """
2793 createdAt: DateTime!
2794
2795 """
2796 Identifies the primary key from the database.
2797 """
2798 databaseId: Int
2799 id: ID!
2800}
2801
2802"""
2803Represents a Git commit.
2804"""
2805type Commit implements GitObject & Node & Subscribable & UniformResourceLocatable {
2806 """
2807 An abbreviated version of the Git object ID
2808 """
2809 abbreviatedOid: String!
2810
2811 """
2812 The number of additions in this commit.
2813 """
2814 additions: Int!
2815
2816 """
2817 The pull requests associated with a commit
2818 """
2819 associatedPullRequests(
2820 """
2821 Returns the elements in the list that come after the specified cursor.
2822 """
2823 after: String
2824
2825 """
2826 Returns the elements in the list that come before the specified cursor.
2827 """
2828 before: String
2829
2830 """
2831 Returns the first _n_ elements from the list.
2832 """
2833 first: Int
2834
2835 """
2836 Returns the last _n_ elements from the list.
2837 """
2838 last: Int
2839
2840 """
2841 Ordering options for pull requests.
2842 """
2843 orderBy: PullRequestOrder = {field: CREATED_AT, direction: ASC}
2844 ): PullRequestConnection
2845
2846 """
2847 Authorship details of the commit.
2848 """
2849 author: GitActor
2850
2851 """
2852 Check if the committer and the author match.
2853 """
2854 authoredByCommitter: Boolean!
2855
2856 """
2857 The datetime when this commit was authored.
2858 """
2859 authoredDate: DateTime!
2860
2861 """
2862 Fetches `git blame` information.
2863 """
2864 blame(
2865 """
2866 The file whose Git blame information you want.
2867 """
2868 path: String!
2869 ): Blame!
2870
2871 """
2872 The number of changed files in this commit.
2873 """
2874 changedFiles: Int!
2875
2876 """
2877 The check suites associated with a commit.
2878 """
2879 checkSuites(
2880 """
2881 Returns the elements in the list that come after the specified cursor.
2882 """
2883 after: String
2884
2885 """
2886 Returns the elements in the list that come before the specified cursor.
2887 """
2888 before: String
2889
2890 """
2891 Filters the check suites by this type.
2892 """
2893 filterBy: CheckSuiteFilter
2894
2895 """
2896 Returns the first _n_ elements from the list.
2897 """
2898 first: Int
2899
2900 """
2901 Returns the last _n_ elements from the list.
2902 """
2903 last: Int
2904 ): CheckSuiteConnection @preview(toggledBy: "antiope-preview")
2905
2906 """
2907 Comments made on the commit.
2908 """
2909 comments(
2910 """
2911 Returns the elements in the list that come after the specified cursor.
2912 """
2913 after: String
2914
2915 """
2916 Returns the elements in the list that come before the specified cursor.
2917 """
2918 before: String
2919
2920 """
2921 Returns the first _n_ elements from the list.
2922 """
2923 first: Int
2924
2925 """
2926 Returns the last _n_ elements from the list.
2927 """
2928 last: Int
2929 ): CommitCommentConnection!
2930
2931 """
2932 The HTTP path for this Git object
2933 """
2934 commitResourcePath: URI!
2935
2936 """
2937 The HTTP URL for this Git object
2938 """
2939 commitUrl: URI!
2940
2941 """
2942 The datetime when this commit was committed.
2943 """
2944 committedDate: DateTime!
2945
2946 """
2947 Check if commited via GitHub web UI.
2948 """
2949 committedViaWeb: Boolean!
2950
2951 """
2952 Committership details of the commit.
2953 """
2954 committer: GitActor
2955
2956 """
2957 The number of deletions in this commit.
2958 """
2959 deletions: Int!
2960
2961 """
2962 The deployments associated with a commit.
2963 """
2964 deployments(
2965 """
2966 Returns the elements in the list that come after the specified cursor.
2967 """
2968 after: String
2969
2970 """
2971 Returns the elements in the list that come before the specified cursor.
2972 """
2973 before: String
2974
2975 """
2976 Environments to list deployments for
2977 """
2978 environments: [String!]
2979
2980 """
2981 Returns the first _n_ elements from the list.
2982 """
2983 first: Int
2984
2985 """
2986 Returns the last _n_ elements from the list.
2987 """
2988 last: Int
2989
2990 """
2991 Ordering options for deployments returned from the connection.
2992 """
2993 orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
2994 ): DeploymentConnection
2995
2996 """
2997 The linear commit history starting from (and including) this commit, in the same order as `git log`.
2998 """
2999 history(
3000 """
3001 Returns the elements in the list that come after the specified cursor.
3002 """
3003 after: String
3004
3005 """
3006 If non-null, filters history to only show commits with matching authorship.
3007 """
3008 author: CommitAuthor
3009
3010 """
3011 Returns the elements in the list that come before the specified cursor.
3012 """
3013 before: String
3014
3015 """
3016 Returns the first _n_ elements from the list.
3017 """
3018 first: Int
3019
3020 """
3021 Returns the last _n_ elements from the list.
3022 """
3023 last: Int
3024
3025 """
3026 If non-null, filters history to only show commits touching files under this path.
3027 """
3028 path: String
3029
3030 """
3031 Allows specifying a beginning time or date for fetching commits.
3032 """
3033 since: GitTimestamp
3034
3035 """
3036 Allows specifying an ending time or date for fetching commits.
3037 """
3038 until: GitTimestamp
3039 ): CommitHistoryConnection!
3040 id: ID!
3041
3042 """
3043 The Git commit message
3044 """
3045 message: String!
3046
3047 """
3048 The Git commit message body
3049 """
3050 messageBody: String!
3051
3052 """
3053 The commit message body rendered to HTML.
3054 """
3055 messageBodyHTML: HTML!
3056
3057 """
3058 The Git commit message headline
3059 """
3060 messageHeadline: String!
3061
3062 """
3063 The commit message headline rendered to HTML.
3064 """
3065 messageHeadlineHTML: HTML!
3066
3067 """
3068 The Git object ID
3069 """
3070 oid: GitObjectID!
3071
3072 """
3073 The organization this commit was made on behalf of.
3074 """
3075 onBehalfOf: Organization
3076
3077 """
3078 The parents of a commit.
3079 """
3080 parents(
3081 """
3082 Returns the elements in the list that come after the specified cursor.
3083 """
3084 after: String
3085
3086 """
3087 Returns the elements in the list that come before the specified cursor.
3088 """
3089 before: String
3090
3091 """
3092 Returns the first _n_ elements from the list.
3093 """
3094 first: Int
3095
3096 """
3097 Returns the last _n_ elements from the list.
3098 """
3099 last: Int
3100 ): CommitConnection!
3101
3102 """
3103 The datetime when this commit was pushed.
3104 """
3105 pushedDate: DateTime
3106
3107 """
3108 The Repository this commit belongs to
3109 """
3110 repository: Repository!
3111
3112 """
3113 The HTTP path for this commit
3114 """
3115 resourcePath: URI!
3116
3117 """
3118 Commit signing information, if present.
3119 """
3120 signature: GitSignature
3121
3122 """
3123 Status information for this commit
3124 """
3125 status: Status
3126
3127 """
3128 Check and Status rollup information for this commit.
3129 """
3130 statusCheckRollup: StatusCheckRollup
3131
3132 """
3133 Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
3134 """
3135 submodules(
3136 """
3137 Returns the elements in the list that come after the specified cursor.
3138 """
3139 after: String
3140
3141 """
3142 Returns the elements in the list that come before the specified cursor.
3143 """
3144 before: String
3145
3146 """
3147 Returns the first _n_ elements from the list.
3148 """
3149 first: Int
3150
3151 """
3152 Returns the last _n_ elements from the list.
3153 """
3154 last: Int
3155 ): SubmoduleConnection!
3156
3157 """
3158 Returns a URL to download a tarball archive for a repository.
3159 Note: For private repositories, these links are temporary and expire after five minutes.
3160 """
3161 tarballUrl: URI!
3162
3163 """
3164 Commit's root Tree
3165 """
3166 tree: Tree!
3167
3168 """
3169 The HTTP path for the tree of this commit
3170 """
3171 treeResourcePath: URI!
3172
3173 """
3174 The HTTP URL for the tree of this commit
3175 """
3176 treeUrl: URI!
3177
3178 """
3179 The HTTP URL for this commit
3180 """
3181 url: URI!
3182
3183 """
3184 Check if the viewer is able to change their subscription status for the repository.
3185 """
3186 viewerCanSubscribe: Boolean!
3187
3188 """
3189 Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
3190 """
3191 viewerSubscription: SubscriptionState
3192
3193 """
3194 Returns a URL to download a zipball archive for a repository.
3195 Note: For private repositories, these links are temporary and expire after five minutes.
3196 """
3197 zipballUrl: URI!
3198}
3199
3200"""
3201Specifies an author for filtering Git commits.
3202"""
3203input CommitAuthor {
3204 """
3205 Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
3206 """
3207 emails: [String!]
3208
3209 """
3210 ID of a User to filter by. If non-null, only commits authored by this user
3211 will be returned. This field takes precedence over emails.
3212 """
3213 id: ID
3214}
3215
3216"""
3217Represents a comment on a given Commit.
3218"""
3219type CommitComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
3220 """
3221 The actor who authored the comment.
3222 """
3223 author: Actor
3224
3225 """
3226 Author's association with the subject of the comment.
3227 """
3228 authorAssociation: CommentAuthorAssociation!
3229
3230 """
3231 Identifies the comment body.
3232 """
3233 body: String!
3234
3235 """
3236 The body rendered to HTML.
3237 """
3238 bodyHTML: HTML!
3239
3240 """
3241 The body rendered to text.
3242 """
3243 bodyText: String!
3244
3245 """
3246 Identifies the commit associated with the comment, if the commit exists.
3247 """
3248 commit: Commit
3249
3250 """
3251 Identifies the date and time when the object was created.
3252 """
3253 createdAt: DateTime!
3254
3255 """
3256 Check if this comment was created via an email reply.
3257 """
3258 createdViaEmail: Boolean!
3259
3260 """
3261 Identifies the primary key from the database.
3262 """
3263 databaseId: Int
3264
3265 """
3266 The actor who edited the comment.
3267 """
3268 editor: Actor
3269 id: ID!
3270
3271 """
3272 Check if this comment was edited and includes an edit with the creation data
3273 """
3274 includesCreatedEdit: Boolean!
3275
3276 """
3277 Returns whether or not a comment has been minimized.
3278 """
3279 isMinimized: Boolean!
3280
3281 """
3282 The moment the editor made the last edit
3283 """
3284 lastEditedAt: DateTime
3285
3286 """
3287 Returns why the comment was minimized.
3288 """
3289 minimizedReason: String
3290
3291 """
3292 Identifies the file path associated with the comment.
3293 """
3294 path: String
3295
3296 """
3297 Identifies the line position associated with the comment.
3298 """
3299 position: Int
3300
3301 """
3302 Identifies when the comment was published at.
3303 """
3304 publishedAt: DateTime
3305
3306 """
3307 A list of reactions grouped by content left on the subject.
3308 """
3309 reactionGroups: [ReactionGroup!]
3310
3311 """
3312 A list of Reactions left on the Issue.
3313 """
3314 reactions(
3315 """
3316 Returns the elements in the list that come after the specified cursor.
3317 """
3318 after: String
3319
3320 """
3321 Returns the elements in the list that come before the specified cursor.
3322 """
3323 before: String
3324
3325 """
3326 Allows filtering Reactions by emoji.
3327 """
3328 content: ReactionContent
3329
3330 """
3331 Returns the first _n_ elements from the list.
3332 """
3333 first: Int
3334
3335 """
3336 Returns the last _n_ elements from the list.
3337 """
3338 last: Int
3339
3340 """
3341 Allows specifying the order in which reactions are returned.
3342 """
3343 orderBy: ReactionOrder
3344 ): ReactionConnection!
3345
3346 """
3347 The repository associated with this node.
3348 """
3349 repository: Repository!
3350
3351 """
3352 The HTTP path permalink for this commit comment.
3353 """
3354 resourcePath: URI!
3355
3356 """
3357 Identifies the date and time when the object was last updated.
3358 """
3359 updatedAt: DateTime!
3360
3361 """
3362 The HTTP URL permalink for this commit comment.
3363 """
3364 url: URI!
3365
3366 """
3367 A list of edits to this content.
3368 """
3369 userContentEdits(
3370 """
3371 Returns the elements in the list that come after the specified cursor.
3372 """
3373 after: String
3374
3375 """
3376 Returns the elements in the list that come before the specified cursor.
3377 """
3378 before: String
3379
3380 """
3381 Returns the first _n_ elements from the list.
3382 """
3383 first: Int
3384
3385 """
3386 Returns the last _n_ elements from the list.
3387 """
3388 last: Int
3389 ): UserContentEditConnection
3390
3391 """
3392 Check if the current viewer can delete this object.
3393 """
3394 viewerCanDelete: Boolean!
3395
3396 """
3397 Check if the current viewer can minimize this object.
3398 """
3399 viewerCanMinimize: Boolean!
3400
3401 """
3402 Can user react to this subject
3403 """
3404 viewerCanReact: Boolean!
3405
3406 """
3407 Check if the current viewer can update this object.
3408 """
3409 viewerCanUpdate: Boolean!
3410
3411 """
3412 Reasons why the current viewer can not update this comment.
3413 """
3414 viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
3415
3416 """
3417 Did the viewer author this comment.
3418 """
3419 viewerDidAuthor: Boolean!
3420}
3421
3422"""
3423The connection type for CommitComment.
3424"""
3425type CommitCommentConnection {
3426 """
3427 A list of edges.
3428 """
3429 edges: [CommitCommentEdge]
3430
3431 """
3432 A list of nodes.
3433 """
3434 nodes: [CommitComment]
3435
3436 """
3437 Information to aid in pagination.
3438 """
3439 pageInfo: PageInfo!
3440
3441 """
3442 Identifies the total count of items in the connection.
3443 """
3444 totalCount: Int!
3445}
3446
3447"""
3448An edge in a connection.
3449"""
3450type CommitCommentEdge {
3451 """
3452 A cursor for use in pagination.
3453 """
3454 cursor: String!
3455
3456 """
3457 The item at the end of the edge.
3458 """
3459 node: CommitComment
3460}
3461
3462"""
3463A thread of comments on a commit.
3464"""
3465type CommitCommentThread implements Node & RepositoryNode {
3466 """
3467 The comments that exist in this thread.
3468 """
3469 comments(
3470 """
3471 Returns the elements in the list that come after the specified cursor.
3472 """
3473 after: String
3474
3475 """
3476 Returns the elements in the list that come before the specified cursor.
3477 """
3478 before: String
3479
3480 """
3481 Returns the first _n_ elements from the list.
3482 """
3483 first: Int
3484
3485 """
3486 Returns the last _n_ elements from the list.
3487 """
3488 last: Int
3489 ): CommitCommentConnection!
3490
3491 """
3492 The commit the comments were made on.
3493 """
3494 commit: Commit
3495 id: ID!
3496
3497 """
3498 The file the comments were made on.
3499 """
3500 path: String
3501
3502 """
3503 The position in the diff for the commit that the comment was made on.
3504 """
3505 position: Int
3506
3507 """
3508 The repository associated with this node.
3509 """
3510 repository: Repository!
3511}
3512
3513"""
3514The connection type for Commit.
3515"""
3516type CommitConnection {
3517 """
3518 A list of edges.
3519 """
3520 edges: [CommitEdge]
3521
3522 """
3523 A list of nodes.
3524 """
3525 nodes: [Commit]
3526
3527 """
3528 Information to aid in pagination.
3529 """
3530 pageInfo: PageInfo!
3531
3532 """
3533 Identifies the total count of items in the connection.
3534 """
3535 totalCount: Int!
3536}
3537
3538"""
3539Ordering options for commit contribution connections.
3540"""
3541input CommitContributionOrder {
3542 """
3543 The ordering direction.
3544 """
3545 direction: OrderDirection!
3546
3547 """
3548 The field by which to order commit contributions.
3549 """
3550 field: CommitContributionOrderField!
3551}
3552
3553"""
3554Properties by which commit contribution connections can be ordered.
3555"""
3556enum CommitContributionOrderField {
3557 """
3558 Order commit contributions by how many commits they represent.
3559 """
3560 COMMIT_COUNT
3561
3562 """
3563 Order commit contributions by when they were made.
3564 """
3565 OCCURRED_AT
3566}
3567
3568"""
3569This aggregates commits made by a user within one repository.
3570"""
3571type CommitContributionsByRepository {
3572 """
3573 The commit contributions, each representing a day.
3574 """
3575 contributions(
3576 """
3577 Returns the elements in the list that come after the specified cursor.
3578 """
3579 after: String
3580
3581 """
3582 Returns the elements in the list that come before the specified cursor.
3583 """
3584 before: String
3585
3586 """
3587 Returns the first _n_ elements from the list.
3588 """
3589 first: Int
3590
3591 """
3592 Returns the last _n_ elements from the list.
3593 """
3594 last: Int
3595
3596 """
3597 Ordering options for commit contributions returned from the connection.
3598 """
3599 orderBy: CommitContributionOrder = {field: OCCURRED_AT, direction: DESC}
3600 ): CreatedCommitContributionConnection!
3601
3602 """
3603 The repository in which the commits were made.
3604 """
3605 repository: Repository!
3606
3607 """
3608 The HTTP path for the user's commits to the repository in this time range.
3609 """
3610 resourcePath: URI!
3611
3612 """
3613 The HTTP URL for the user's commits to the repository in this time range.
3614 """
3615 url: URI!
3616}
3617
3618"""
3619An edge in a connection.
3620"""
3621type CommitEdge {
3622 """
3623 A cursor for use in pagination.
3624 """
3625 cursor: String!
3626
3627 """
3628 The item at the end of the edge.
3629 """
3630 node: Commit
3631}
3632
3633"""
3634The connection type for Commit.
3635"""
3636type CommitHistoryConnection {
3637 """
3638 A list of edges.
3639 """
3640 edges: [CommitEdge]
3641
3642 """
3643 A list of nodes.
3644 """
3645 nodes: [Commit]
3646
3647 """
3648 Information to aid in pagination.
3649 """
3650 pageInfo: PageInfo!
3651
3652 """
3653 Identifies the total count of items in the connection.
3654 """
3655 totalCount: Int!
3656}
3657
3658"""
3659Represents a 'connected' event on a given issue or pull request.
3660"""
3661type ConnectedEvent implements Node {
3662 """
3663 Identifies the actor who performed the event.
3664 """
3665 actor: Actor
3666
3667 """
3668 Identifies the date and time when the object was created.
3669 """
3670 createdAt: DateTime!
3671 id: ID!
3672
3673 """
3674 Reference originated in a different repository.
3675 """
3676 isCrossRepository: Boolean!
3677
3678 """
3679 Issue or pull request that made the reference.
3680 """
3681 source: ReferencedSubject!
3682
3683 """
3684 Issue or pull request which was connected.
3685 """
3686 subject: ReferencedSubject!
3687}
3688
3689"""
3690A content attachment
3691"""
3692type ContentAttachment {
3693 """
3694 The body text of the content attachment. This parameter supports markdown.
3695 """
3696 body: String!
3697
3698 """
3699 The content reference that the content attachment is attached to.
3700 """
3701 contentReference: ContentReference!
3702
3703 """
3704 Identifies the primary key from the database.
3705 """
3706 databaseId: Int!
3707 id: ID!
3708
3709 """
3710 The title of the content attachment.
3711 """
3712 title: String!
3713}
3714
3715"""
3716A content reference
3717"""
3718type ContentReference {
3719 """
3720 Identifies the primary key from the database.
3721 """
3722 databaseId: Int!
3723 id: ID!
3724
3725 """
3726 The reference of the content reference.
3727 """
3728 reference: String!
3729}
3730
3731"""
3732Represents a contribution a user made on GitHub, such as opening an issue.
3733"""
3734interface Contribution {
3735 """
3736 Whether this contribution is associated with a record you do not have access to. For
3737 example, your own 'first issue' contribution may have been made on a repository you can no
3738 longer access.
3739 """
3740 isRestricted: Boolean!
3741
3742 """
3743 When this contribution was made.
3744 """
3745 occurredAt: DateTime!
3746
3747 """
3748 The HTTP path for this contribution.
3749 """
3750 resourcePath: URI!
3751
3752 """
3753 The HTTP URL for this contribution.
3754 """
3755 url: URI!
3756
3757 """
3758 The user who made this contribution.
3759 """
3760 user: User!
3761}
3762
3763"""
3764A calendar of contributions made on GitHub by a user.
3765"""
3766type ContributionCalendar {
3767 """
3768 A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.
3769 """
3770 colors: [String!]!
3771
3772 """
3773 Determine if the color set was chosen because it's currently Halloween.
3774 """
3775 isHalloween: Boolean!
3776
3777 """
3778 A list of the months of contributions in this calendar.
3779 """
3780 months: [ContributionCalendarMonth!]!
3781
3782 """
3783 The count of total contributions in the calendar.
3784 """
3785 totalContributions: Int!
3786
3787 """
3788 A list of the weeks of contributions in this calendar.
3789 """
3790 weeks: [ContributionCalendarWeek!]!
3791}
3792
3793"""
3794Represents a single day of contributions on GitHub by a user.
3795"""
3796type ContributionCalendarDay {
3797 """
3798 The hex color code that represents how many contributions were made on this day compared to others in the calendar.
3799 """
3800 color: String!
3801
3802 """
3803 How many contributions were made by the user on this day.
3804 """
3805 contributionCount: Int!
3806
3807 """
3808 The day this square represents.
3809 """
3810 date: Date!
3811
3812 """
3813 A number representing which day of the week this square represents, e.g., 1 is Monday.
3814 """
3815 weekday: Int!
3816}
3817
3818"""
3819A month of contributions in a user's contribution graph.
3820"""
3821type ContributionCalendarMonth {
3822 """
3823 The date of the first day of this month.
3824 """
3825 firstDay: Date!
3826
3827 """
3828 The name of the month.
3829 """
3830 name: String!
3831
3832 """
3833 How many weeks started in this month.
3834 """
3835 totalWeeks: Int!
3836
3837 """
3838 The year the month occurred in.
3839 """
3840 year: Int!
3841}
3842
3843"""
3844A week of contributions in a user's contribution graph.
3845"""
3846type ContributionCalendarWeek {
3847 """
3848 The days of contributions in this week.
3849 """
3850 contributionDays: [ContributionCalendarDay!]!
3851
3852 """
3853 The date of the earliest square in this week.
3854 """
3855 firstDay: Date!
3856}
3857
3858"""
3859Ordering options for contribution connections.
3860"""
3861input ContributionOrder {
3862 """
3863 The ordering direction.
3864 """
3865 direction: OrderDirection!
3866}
3867
3868"""
3869A contributions collection aggregates contributions such as opened issues and commits created by a user.
3870"""
3871type ContributionsCollection {
3872 """
3873 Commit contributions made by the user, grouped by repository.
3874 """
3875 commitContributionsByRepository(
3876 """
3877 How many repositories should be included.
3878 """
3879 maxRepositories: Int = 25
3880 ): [CommitContributionsByRepository!]!
3881
3882 """
3883 A calendar of this user's contributions on GitHub.
3884 """
3885 contributionCalendar: ContributionCalendar!
3886
3887 """
3888 The years the user has been making contributions with the most recent year first.
3889 """
3890 contributionYears: [Int!]!
3891
3892 """
3893 Determine if this collection's time span ends in the current month.
3894 """
3895 doesEndInCurrentMonth: Boolean!
3896
3897 """
3898 The date of the first restricted contribution the user made in this time
3899 period. Can only be non-null when the user has enabled private contribution counts.
3900 """
3901 earliestRestrictedContributionDate: Date
3902
3903 """
3904 The ending date and time of this collection.
3905 """
3906 endedAt: DateTime!
3907
3908 """
3909 The first issue the user opened on GitHub. This will be null if that issue was
3910 opened outside the collection's time range and ignoreTimeRange is false. If
3911 the issue is not visible but the user has opted to show private contributions,
3912 a RestrictedContribution will be returned.
3913 """
3914 firstIssueContribution: CreatedIssueOrRestrictedContribution
3915
3916 """
3917 The first pull request the user opened on GitHub. This will be null if that
3918 pull request was opened outside the collection's time range and
3919 ignoreTimeRange is not true. If the pull request is not visible but the user
3920 has opted to show private contributions, a RestrictedContribution will be returned.
3921 """
3922 firstPullRequestContribution: CreatedPullRequestOrRestrictedContribution
3923
3924 """
3925 The first repository the user created on GitHub. This will be null if that
3926 first repository was created outside the collection's time range and
3927 ignoreTimeRange is false. If the repository is not visible, then a
3928 RestrictedContribution is returned.
3929 """
3930 firstRepositoryContribution: CreatedRepositoryOrRestrictedContribution
3931
3932 """
3933 Does the user have any more activity in the timeline that occurred prior to the collection's time range?
3934 """
3935 hasActivityInThePast: Boolean!
3936
3937 """
3938 Determine if there are any contributions in this collection.
3939 """
3940 hasAnyContributions: Boolean!
3941
3942 """
3943 Determine if the user made any contributions in this time frame whose details
3944 are not visible because they were made in a private repository. Can only be
3945 true if the user enabled private contribution counts.
3946 """
3947 hasAnyRestrictedContributions: Boolean!
3948
3949 """
3950 Whether or not the collector's time span is all within the same day.
3951 """
3952 isSingleDay: Boolean!
3953
3954 """
3955 A list of issues the user opened.
3956 """
3957 issueContributions(
3958 """
3959 Returns the elements in the list that come after the specified cursor.
3960 """
3961 after: String
3962
3963 """
3964 Returns the elements in the list that come before the specified cursor.
3965 """
3966 before: String
3967
3968 """
3969 Should the user's first issue ever be excluded from the result.
3970 """
3971 excludeFirst: Boolean = false
3972
3973 """
3974 Should the user's most commented issue be excluded from the result.
3975 """
3976 excludePopular: Boolean = false
3977
3978 """
3979 Returns the first _n_ elements from the list.
3980 """
3981 first: Int
3982
3983 """
3984 Returns the last _n_ elements from the list.
3985 """
3986 last: Int
3987
3988 """
3989 Ordering options for contributions returned from the connection.
3990 """
3991 orderBy: ContributionOrder = {direction: DESC}
3992 ): CreatedIssueContributionConnection!
3993
3994 """
3995 Issue contributions made by the user, grouped by repository.
3996 """
3997 issueContributionsByRepository(
3998 """
3999 Should the user's first issue ever be excluded from the result.
4000 """
4001 excludeFirst: Boolean = false
4002
4003 """
4004 Should the user's most commented issue be excluded from the result.
4005 """
4006 excludePopular: Boolean = false
4007
4008 """
4009 How many repositories should be included.
4010 """
4011 maxRepositories: Int = 25
4012 ): [IssueContributionsByRepository!]!
4013
4014 """
4015 When the user signed up for GitHub. This will be null if that sign up date
4016 falls outside the collection's time range and ignoreTimeRange is false.
4017 """
4018 joinedGitHubContribution: JoinedGitHubContribution
4019
4020 """
4021 The date of the most recent restricted contribution the user made in this time
4022 period. Can only be non-null when the user has enabled private contribution counts.
4023 """
4024 latestRestrictedContributionDate: Date
4025
4026 """
4027 When this collection's time range does not include any activity from the user, use this
4028 to get a different collection from an earlier time range that does have activity.
4029 """
4030 mostRecentCollectionWithActivity: ContributionsCollection
4031
4032 """
4033 Returns a different contributions collection from an earlier time range than this one
4034 that does not have any contributions.
4035 """
4036 mostRecentCollectionWithoutActivity: ContributionsCollection
4037
4038 """
4039 The issue the user opened on GitHub that received the most comments in the specified
4040 time frame.
4041 """
4042 popularIssueContribution: CreatedIssueContribution
4043
4044 """
4045 The pull request the user opened on GitHub that received the most comments in the
4046 specified time frame.
4047 """
4048 popularPullRequestContribution: CreatedPullRequestContribution
4049
4050 """
4051 Pull request contributions made by the user.
4052 """
4053 pullRequestContributions(
4054 """
4055 Returns the elements in the list that come after the specified cursor.
4056 """
4057 after: String
4058
4059 """
4060 Returns the elements in the list that come before the specified cursor.
4061 """
4062 before: String
4063
4064 """
4065 Should the user's first pull request ever be excluded from the result.
4066 """
4067 excludeFirst: Boolean = false
4068
4069 """
4070 Should the user's most commented pull request be excluded from the result.
4071 """
4072 excludePopular: Boolean = false
4073
4074 """
4075 Returns the first _n_ elements from the list.
4076 """
4077 first: Int
4078
4079 """
4080 Returns the last _n_ elements from the list.
4081 """
4082 last: Int
4083
4084 """
4085 Ordering options for contributions returned from the connection.
4086 """
4087 orderBy: ContributionOrder = {direction: DESC}
4088 ): CreatedPullRequestContributionConnection!
4089
4090 """
4091 Pull request contributions made by the user, grouped by repository.
4092 """
4093 pullRequestContributionsByRepository(
4094 """
4095 Should the user's first pull request ever be excluded from the result.
4096 """
4097 excludeFirst: Boolean = false
4098
4099 """
4100 Should the user's most commented pull request be excluded from the result.
4101 """
4102 excludePopular: Boolean = false
4103
4104 """
4105 How many repositories should be included.
4106 """
4107 maxRepositories: Int = 25
4108 ): [PullRequestContributionsByRepository!]!
4109
4110 """
4111 Pull request review contributions made by the user.
4112 """
4113 pullRequestReviewContributions(
4114 """
4115 Returns the elements in the list that come after the specified cursor.
4116 """
4117 after: String
4118
4119 """
4120 Returns the elements in the list that come before the specified cursor.
4121 """
4122 before: String
4123
4124 """
4125 Returns the first _n_ elements from the list.
4126 """
4127 first: Int
4128
4129 """
4130 Returns the last _n_ elements from the list.
4131 """
4132 last: Int
4133
4134 """
4135 Ordering options for contributions returned from the connection.
4136 """
4137 orderBy: ContributionOrder = {direction: DESC}
4138 ): CreatedPullRequestReviewContributionConnection!
4139
4140 """
4141 Pull request review contributions made by the user, grouped by repository.
4142 """
4143 pullRequestReviewContributionsByRepository(
4144 """
4145 How many repositories should be included.
4146 """
4147 maxRepositories: Int = 25
4148 ): [PullRequestReviewContributionsByRepository!]!
4149
4150 """
4151 A list of repositories owned by the user that the user created in this time range.
4152 """
4153 repositoryContributions(
4154 """
4155 Returns the elements in the list that come after the specified cursor.
4156 """
4157 after: String
4158
4159 """
4160 Returns the elements in the list that come before the specified cursor.
4161 """
4162 before: String
4163
4164 """
4165 Should the user's first repository ever be excluded from the result.
4166 """
4167 excludeFirst: Boolean = false
4168
4169 """
4170 Returns the first _n_ elements from the list.
4171 """
4172 first: Int
4173
4174 """
4175 Returns the last _n_ elements from the list.
4176 """
4177 last: Int
4178
4179 """
4180 Ordering options for contributions returned from the connection.
4181 """
4182 orderBy: ContributionOrder = {direction: DESC}
4183 ): CreatedRepositoryContributionConnection!
4184
4185 """
4186 A count of contributions made by the user that the viewer cannot access. Only
4187 non-zero when the user has chosen to share their private contribution counts.
4188 """
4189 restrictedContributionsCount: Int!
4190
4191 """
4192 The beginning date and time of this collection.
4193 """
4194 startedAt: DateTime!
4195
4196 """
4197 How many commits were made by the user in this time span.
4198 """
4199 totalCommitContributions: Int!
4200
4201 """
4202 How many issues the user opened.
4203 """
4204 totalIssueContributions(
4205 """
4206 Should the user's first issue ever be excluded from this count.
4207 """
4208 excludeFirst: Boolean = false
4209
4210 """
4211 Should the user's most commented issue be excluded from this count.
4212 """
4213 excludePopular: Boolean = false
4214 ): Int!
4215
4216 """
4217 How many pull requests the user opened.
4218 """
4219 totalPullRequestContributions(
4220 """
4221 Should the user's first pull request ever be excluded from this count.
4222 """
4223 excludeFirst: Boolean = false
4224
4225 """
4226 Should the user's most commented pull request be excluded from this count.
4227 """
4228 excludePopular: Boolean = false
4229 ): Int!
4230
4231 """
4232 How many pull request reviews the user left.
4233 """
4234 totalPullRequestReviewContributions: Int!
4235
4236 """
4237 How many different repositories the user committed to.
4238 """
4239 totalRepositoriesWithContributedCommits: Int!
4240
4241 """
4242 How many different repositories the user opened issues in.
4243 """
4244 totalRepositoriesWithContributedIssues(
4245 """
4246 Should the user's first issue ever be excluded from this count.
4247 """
4248 excludeFirst: Boolean = false
4249
4250 """
4251 Should the user's most commented issue be excluded from this count.
4252 """
4253 excludePopular: Boolean = false
4254 ): Int!
4255
4256 """
4257 How many different repositories the user left pull request reviews in.
4258 """
4259 totalRepositoriesWithContributedPullRequestReviews: Int!
4260
4261 """
4262 How many different repositories the user opened pull requests in.
4263 """
4264 totalRepositoriesWithContributedPullRequests(
4265 """
4266 Should the user's first pull request ever be excluded from this count.
4267 """
4268 excludeFirst: Boolean = false
4269
4270 """
4271 Should the user's most commented pull request be excluded from this count.
4272 """
4273 excludePopular: Boolean = false
4274 ): Int!
4275
4276 """
4277 How many repositories the user created.
4278 """
4279 totalRepositoryContributions(
4280 """
4281 Should the user's first repository ever be excluded from this count.
4282 """
4283 excludeFirst: Boolean = false
4284 ): Int!
4285
4286 """
4287 The user who made the contributions in this collection.
4288 """
4289 user: User!
4290}
4291
4292"""
4293Autogenerated input type of ConvertProjectCardNoteToIssue
4294"""
4295input ConvertProjectCardNoteToIssueInput {
4296 """
4297 The body of the newly created issue.
4298 """
4299 body: String
4300
4301 """
4302 A unique identifier for the client performing the mutation.
4303 """
4304 clientMutationId: String
4305
4306 """
4307 The ProjectCard ID to convert.
4308 """
4309 projectCardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
4310
4311 """
4312 The ID of the repository to create the issue in.
4313 """
4314 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4315
4316 """
4317 The title of the newly created issue. Defaults to the card's note text.
4318 """
4319 title: String
4320}
4321
4322"""
4323Autogenerated return type of ConvertProjectCardNoteToIssue
4324"""
4325type ConvertProjectCardNoteToIssuePayload {
4326 """
4327 A unique identifier for the client performing the mutation.
4328 """
4329 clientMutationId: String
4330
4331 """
4332 The updated ProjectCard.
4333 """
4334 projectCard: ProjectCard
4335}
4336
4337"""
4338Represents a 'convert_to_draft' event on a given pull request.
4339"""
4340type ConvertToDraftEvent implements Node & UniformResourceLocatable {
4341 """
4342 Identifies the actor who performed the event.
4343 """
4344 actor: Actor
4345
4346 """
4347 Identifies the date and time when the object was created.
4348 """
4349 createdAt: DateTime!
4350 id: ID!
4351
4352 """
4353 PullRequest referenced by event.
4354 """
4355 pullRequest: PullRequest!
4356
4357 """
4358 The HTTP path for this convert to draft event.
4359 """
4360 resourcePath: URI!
4361
4362 """
4363 The HTTP URL for this convert to draft event.
4364 """
4365 url: URI!
4366}
4367
4368"""
4369Represents a 'converted_note_to_issue' event on a given issue or pull request.
4370"""
4371type ConvertedNoteToIssueEvent implements Node {
4372 """
4373 Identifies the actor who performed the event.
4374 """
4375 actor: Actor
4376
4377 """
4378 Identifies the date and time when the object was created.
4379 """
4380 createdAt: DateTime!
4381
4382 """
4383 Identifies the primary key from the database.
4384 """
4385 databaseId: Int
4386 id: ID!
4387
4388 """
4389 Project referenced by event.
4390 """
4391 project: Project @preview(toggledBy: "starfox-preview")
4392
4393 """
4394 Project card referenced by this project event.
4395 """
4396 projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
4397
4398 """
4399 Column name referenced by this project event.
4400 """
4401 projectColumnName: String! @preview(toggledBy: "starfox-preview")
4402}
4403
4404"""
4405Autogenerated input type of CreateBranchProtectionRule
4406"""
4407input CreateBranchProtectionRuleInput {
4408 """
4409 A unique identifier for the client performing the mutation.
4410 """
4411 clientMutationId: String
4412
4413 """
4414 Will new commits pushed to matching branches dismiss pull request review approvals.
4415 """
4416 dismissesStaleReviews: Boolean
4417
4418 """
4419 Can admins overwrite branch protection.
4420 """
4421 isAdminEnforced: Boolean
4422
4423 """
4424 The glob-like pattern used to determine matching branches.
4425 """
4426 pattern: String!
4427
4428 """
4429 A list of User, Team or App IDs allowed to push to matching branches.
4430 """
4431 pushActorIds: [ID!]
4432
4433 """
4434 The global relay id of the repository in which a new branch protection rule should be created in.
4435 """
4436 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4437
4438 """
4439 Number of approving reviews required to update matching branches.
4440 """
4441 requiredApprovingReviewCount: Int
4442
4443 """
4444 List of required status check contexts that must pass for commits to be accepted to matching branches.
4445 """
4446 requiredStatusCheckContexts: [String!]
4447
4448 """
4449 Are approving reviews required to update matching branches.
4450 """
4451 requiresApprovingReviews: Boolean
4452
4453 """
4454 Are reviews from code owners required to update matching branches.
4455 """
4456 requiresCodeOwnerReviews: Boolean
4457
4458 """
4459 Are commits required to be signed.
4460 """
4461 requiresCommitSignatures: Boolean
4462
4463 """
4464 Are status checks required to update matching branches.
4465 """
4466 requiresStatusChecks: Boolean
4467
4468 """
4469 Are branches required to be up to date before merging.
4470 """
4471 requiresStrictStatusChecks: Boolean
4472
4473 """
4474 Is pushing to matching branches restricted.
4475 """
4476 restrictsPushes: Boolean
4477
4478 """
4479 Is dismissal of pull request reviews restricted.
4480 """
4481 restrictsReviewDismissals: Boolean
4482
4483 """
4484 A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
4485 """
4486 reviewDismissalActorIds: [ID!]
4487}
4488
4489"""
4490Autogenerated return type of CreateBranchProtectionRule
4491"""
4492type CreateBranchProtectionRulePayload {
4493 """
4494 The newly created BranchProtectionRule.
4495 """
4496 branchProtectionRule: BranchProtectionRule
4497
4498 """
4499 A unique identifier for the client performing the mutation.
4500 """
4501 clientMutationId: String
4502}
4503
4504"""
4505Autogenerated input type of CreateCheckRun
4506"""
4507input CreateCheckRunInput @preview(toggledBy: "antiope-preview") {
4508 """
4509 Possible further actions the integrator can perform, which a user may trigger.
4510 """
4511 actions: [CheckRunAction!]
4512
4513 """
4514 A unique identifier for the client performing the mutation.
4515 """
4516 clientMutationId: String
4517
4518 """
4519 The time that the check run finished.
4520 """
4521 completedAt: DateTime
4522
4523 """
4524 The final conclusion of the check.
4525 """
4526 conclusion: CheckConclusionState
4527
4528 """
4529 The URL of the integrator's site that has the full details of the check.
4530 """
4531 detailsUrl: URI
4532
4533 """
4534 A reference for the run on the integrator's system.
4535 """
4536 externalId: String
4537
4538 """
4539 The SHA of the head commit.
4540 """
4541 headSha: GitObjectID!
4542
4543 """
4544 The name of the check.
4545 """
4546 name: String!
4547
4548 """
4549 Descriptive details about the run.
4550 """
4551 output: CheckRunOutput
4552
4553 """
4554 The node ID of the repository.
4555 """
4556 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4557
4558 """
4559 The time that the check run began.
4560 """
4561 startedAt: DateTime
4562
4563 """
4564 The current status.
4565 """
4566 status: RequestableCheckStatusState
4567}
4568
4569"""
4570Autogenerated return type of CreateCheckRun
4571"""
4572type CreateCheckRunPayload @preview(toggledBy: "antiope-preview") {
4573 """
4574 The newly created check run.
4575 """
4576 checkRun: CheckRun
4577
4578 """
4579 A unique identifier for the client performing the mutation.
4580 """
4581 clientMutationId: String
4582}
4583
4584"""
4585Autogenerated input type of CreateCheckSuite
4586"""
4587input CreateCheckSuiteInput @preview(toggledBy: "antiope-preview") {
4588 """
4589 A unique identifier for the client performing the mutation.
4590 """
4591 clientMutationId: String
4592
4593 """
4594 The SHA of the head commit.
4595 """
4596 headSha: GitObjectID!
4597
4598 """
4599 The Node ID of the repository.
4600 """
4601 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4602}
4603
4604"""
4605Autogenerated return type of CreateCheckSuite
4606"""
4607type CreateCheckSuitePayload @preview(toggledBy: "antiope-preview") {
4608 """
4609 The newly created check suite.
4610 """
4611 checkSuite: CheckSuite
4612
4613 """
4614 A unique identifier for the client performing the mutation.
4615 """
4616 clientMutationId: String
4617}
4618
4619"""
4620Autogenerated input type of CreateContentAttachment
4621"""
4622input CreateContentAttachmentInput {
4623 """
4624 The body of the content attachment, which may contain markdown.
4625 """
4626 body: String!
4627
4628 """
4629 A unique identifier for the client performing the mutation.
4630 """
4631 clientMutationId: String
4632
4633 """
4634 The node ID of the content_reference.
4635 """
4636 contentReferenceId: ID! @possibleTypes(concreteTypes: ["ContentReference"])
4637
4638 """
4639 The title of the content attachment.
4640 """
4641 title: String!
4642}
4643
4644"""
4645Autogenerated return type of CreateContentAttachment
4646"""
4647type CreateContentAttachmentPayload {
4648 """
4649 A unique identifier for the client performing the mutation.
4650 """
4651 clientMutationId: String
4652
4653 """
4654 The newly created content attachment.
4655 """
4656 contentAttachment: ContentAttachment
4657}
4658
4659"""
4660Autogenerated input type of CreateDeployment
4661"""
4662input CreateDeploymentInput @preview(toggledBy: "flash-preview") {
4663 """
4664 Attempt to automatically merge the default branch into the requested ref, defaults to true.
4665 """
4666 autoMerge: Boolean = true
4667
4668 """
4669 A unique identifier for the client performing the mutation.
4670 """
4671 clientMutationId: String
4672
4673 """
4674 Short description of the deployment.
4675 """
4676 description: String = ""
4677
4678 """
4679 Name for the target deployment environment.
4680 """
4681 environment: String = "production"
4682
4683 """
4684 JSON payload with extra information about the deployment.
4685 """
4686 payload: String = "{}"
4687
4688 """
4689 The node ID of the ref to be deployed.
4690 """
4691 refId: ID! @possibleTypes(concreteTypes: ["Ref"])
4692
4693 """
4694 The node ID of the repository.
4695 """
4696 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4697
4698 """
4699 The status contexts to verify against commit status checks. To bypass required
4700 contexts, pass an empty array. Defaults to all unique contexts.
4701 """
4702 requiredContexts: [String!]
4703
4704 """
4705 Specifies a task to execute.
4706 """
4707 task: String = "deploy"
4708}
4709
4710"""
4711Autogenerated return type of CreateDeployment
4712"""
4713type CreateDeploymentPayload @preview(toggledBy: "flash-preview") {
4714 """
4715 True if the default branch has been auto-merged into the deployment ref.
4716 """
4717 autoMerged: Boolean
4718
4719 """
4720 A unique identifier for the client performing the mutation.
4721 """
4722 clientMutationId: String
4723
4724 """
4725 The new deployment.
4726 """
4727 deployment: Deployment
4728}
4729
4730"""
4731Autogenerated input type of CreateDeploymentStatus
4732"""
4733input CreateDeploymentStatusInput @preview(toggledBy: "flash-preview") {
4734 """
4735 Adds a new inactive status to all non-transient, non-production environment
4736 deployments with the same repository and environment name as the created
4737 status's deployment.
4738 """
4739 autoInactive: Boolean = true
4740
4741 """
4742 A unique identifier for the client performing the mutation.
4743 """
4744 clientMutationId: String
4745
4746 """
4747 The node ID of the deployment.
4748 """
4749 deploymentId: ID! @possibleTypes(concreteTypes: ["Deployment"])
4750
4751 """
4752 A short description of the status. Maximum length of 140 characters.
4753 """
4754 description: String = ""
4755
4756 """
4757 If provided, updates the environment of the deploy. Otherwise, does not modify the environment.
4758 """
4759 environment: String
4760
4761 """
4762 Sets the URL for accessing your environment.
4763 """
4764 environmentUrl: String = ""
4765
4766 """
4767 The log URL to associate with this status. This URL should contain
4768 output to keep the user updated while the task is running or serve as
4769 historical information for what happened in the deployment.
4770 """
4771 logUrl: String = ""
4772
4773 """
4774 The state of the deployment.
4775 """
4776 state: DeploymentStatusState!
4777}
4778
4779"""
4780Autogenerated return type of CreateDeploymentStatus
4781"""
4782type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") {
4783 """
4784 A unique identifier for the client performing the mutation.
4785 """
4786 clientMutationId: String
4787
4788 """
4789 The new deployment status.
4790 """
4791 deploymentStatus: DeploymentStatus
4792}
4793
4794"""
4795Autogenerated input type of CreateEnterpriseOrganization
4796"""
4797input CreateEnterpriseOrganizationInput {
4798 """
4799 The logins for the administrators of the new organization.
4800 """
4801 adminLogins: [String!]!
4802
4803 """
4804 The email used for sending billing receipts.
4805 """
4806 billingEmail: String!
4807
4808 """
4809 A unique identifier for the client performing the mutation.
4810 """
4811 clientMutationId: String
4812
4813 """
4814 The ID of the enterprise owning the new organization.
4815 """
4816 enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
4817
4818 """
4819 The login of the new organization.
4820 """
4821 login: String!
4822
4823 """
4824 The profile name of the new organization.
4825 """
4826 profileName: String!
4827}
4828
4829"""
4830Autogenerated return type of CreateEnterpriseOrganization
4831"""
4832type CreateEnterpriseOrganizationPayload {
4833 """
4834 A unique identifier for the client performing the mutation.
4835 """
4836 clientMutationId: String
4837
4838 """
4839 The enterprise that owns the created organization.
4840 """
4841 enterprise: Enterprise
4842
4843 """
4844 The organization that was created.
4845 """
4846 organization: Organization
4847}
4848
4849"""
4850Autogenerated input type of CreateIpAllowListEntry
4851"""
4852input CreateIpAllowListEntryInput {
4853 """
4854 An IP address or range of addresses in CIDR notation.
4855 """
4856 allowListValue: String!
4857
4858 """
4859 A unique identifier for the client performing the mutation.
4860 """
4861 clientMutationId: String
4862
4863 """
4864 Whether the IP allow list entry is active when an IP allow list is enabled.
4865 """
4866 isActive: Boolean!
4867
4868 """
4869 An optional name for the IP allow list entry.
4870 """
4871 name: String
4872
4873 """
4874 The ID of the owner for which to create the new IP allow list entry.
4875 """
4876 ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "IpAllowListOwner")
4877}
4878
4879"""
4880Autogenerated return type of CreateIpAllowListEntry
4881"""
4882type CreateIpAllowListEntryPayload {
4883 """
4884 A unique identifier for the client performing the mutation.
4885 """
4886 clientMutationId: String
4887
4888 """
4889 The IP allow list entry that was created.
4890 """
4891 ipAllowListEntry: IpAllowListEntry
4892}
4893
4894"""
4895Autogenerated input type of CreateIssue
4896"""
4897input CreateIssueInput {
4898 """
4899 The Node ID for the user assignee for this issue.
4900 """
4901 assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"])
4902
4903 """
4904 The body for the issue description.
4905 """
4906 body: String
4907
4908 """
4909 A unique identifier for the client performing the mutation.
4910 """
4911 clientMutationId: String
4912
4913 """
4914 An array of Node IDs of labels for this issue.
4915 """
4916 labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"])
4917
4918 """
4919 The Node ID of the milestone for this issue.
4920 """
4921 milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"])
4922
4923 """
4924 An array of Node IDs for projects associated with this issue.
4925 """
4926 projectIds: [ID!] @possibleTypes(concreteTypes: ["Project"])
4927
4928 """
4929 The Node ID of the repository.
4930 """
4931 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4932
4933 """
4934 The title for the issue.
4935 """
4936 title: String!
4937}
4938
4939"""
4940Autogenerated return type of CreateIssue
4941"""
4942type CreateIssuePayload {
4943 """
4944 A unique identifier for the client performing the mutation.
4945 """
4946 clientMutationId: String
4947
4948 """
4949 The new issue.
4950 """
4951 issue: Issue
4952}
4953
4954"""
4955Autogenerated input type of CreateLabel
4956"""
4957input CreateLabelInput @preview(toggledBy: "bane-preview") {
4958 """
4959 A unique identifier for the client performing the mutation.
4960 """
4961 clientMutationId: String
4962
4963 """
4964 A 6 character hex code, without the leading #, identifying the color of the label.
4965 """
4966 color: String!
4967
4968 """
4969 A brief description of the label, such as its purpose.
4970 """
4971 description: String
4972
4973 """
4974 The name of the label.
4975 """
4976 name: String!
4977
4978 """
4979 The Node ID of the repository.
4980 """
4981 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
4982}
4983
4984"""
4985Autogenerated return type of CreateLabel
4986"""
4987type CreateLabelPayload @preview(toggledBy: "bane-preview") {
4988 """
4989 A unique identifier for the client performing the mutation.
4990 """
4991 clientMutationId: String
4992
4993 """
4994 The new label.
4995 """
4996 label: Label
4997}
4998
4999"""
5000Autogenerated input type of CreateProject
5001"""
5002input CreateProjectInput {
5003 """
5004 The description of project.
5005 """
5006 body: String
5007
5008 """
5009 A unique identifier for the client performing the mutation.
5010 """
5011 clientMutationId: String
5012
5013 """
5014 The name of project.
5015 """
5016 name: String!
5017
5018 """
5019 The owner ID to create the project under.
5020 """
5021 ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
5022
5023 """
5024 A list of repository IDs to create as linked repositories for the project
5025 """
5026 repositoryIds: [ID!] @possibleTypes(concreteTypes: ["Repository"])
5027
5028 """
5029 The name of the GitHub-provided template.
5030 """
5031 template: ProjectTemplate
5032}
5033
5034"""
5035Autogenerated return type of CreateProject
5036"""
5037type CreateProjectPayload {
5038 """
5039 A unique identifier for the client performing the mutation.
5040 """
5041 clientMutationId: String
5042
5043 """
5044 The new project.
5045 """
5046 project: Project
5047}
5048
5049"""
5050Autogenerated input type of CreatePullRequest
5051"""
5052input CreatePullRequestInput {
5053 """
5054 The name of the branch you want your changes pulled into. This should be an existing branch
5055 on the current repository. You cannot update the base branch on a pull request to point
5056 to another repository.
5057 """
5058 baseRefName: String!
5059
5060 """
5061 The contents of the pull request.
5062 """
5063 body: String
5064
5065 """
5066 A unique identifier for the client performing the mutation.
5067 """
5068 clientMutationId: String
5069
5070 """
5071 Indicates whether this pull request should be a draft.
5072 """
5073 draft: Boolean = false
5074
5075 """
5076 The name of the branch where your changes are implemented. For cross-repository pull requests
5077 in the same network, namespace `head_ref_name` with a user like this: `username:branch`.
5078 """
5079 headRefName: String!
5080
5081 """
5082 Indicates whether maintainers can modify the pull request.
5083 """
5084 maintainerCanModify: Boolean = true
5085
5086 """
5087 The Node ID of the repository.
5088 """
5089 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
5090
5091 """
5092 The title of the pull request.
5093 """
5094 title: String!
5095}
5096
5097"""
5098Autogenerated return type of CreatePullRequest
5099"""
5100type CreatePullRequestPayload {
5101 """
5102 A unique identifier for the client performing the mutation.
5103 """
5104 clientMutationId: String
5105
5106 """
5107 The new pull request.
5108 """
5109 pullRequest: PullRequest
5110}
5111
5112"""
5113Autogenerated input type of CreateRef
5114"""
5115input CreateRefInput {
5116 """
5117 A unique identifier for the client performing the mutation.
5118 """
5119 clientMutationId: String
5120
5121 """
5122 The fully qualified name of the new Ref (ie: `refs/heads/my_new_branch`).
5123 """
5124 name: String!
5125
5126 """
5127 The GitObjectID that the new Ref shall target. Must point to a commit.
5128 """
5129 oid: GitObjectID!
5130
5131 """
5132 The Node ID of the Repository to create the Ref in.
5133 """
5134 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
5135}
5136
5137"""
5138Autogenerated return type of CreateRef
5139"""
5140type CreateRefPayload {
5141 """
5142 A unique identifier for the client performing the mutation.
5143 """
5144 clientMutationId: String
5145
5146 """
5147 The newly created ref.
5148 """
5149 ref: Ref
5150}
5151
5152"""
5153Autogenerated input type of CreateRepository
5154"""
5155input CreateRepositoryInput {
5156 """
5157 A unique identifier for the client performing the mutation.
5158 """
5159 clientMutationId: String
5160
5161 """
5162 A short description of the new repository.
5163 """
5164 description: String
5165
5166 """
5167 Indicates if the repository should have the issues feature enabled.
5168 """
5169 hasIssuesEnabled: Boolean = true
5170
5171 """
5172 Indicates if the repository should have the wiki feature enabled.
5173 """
5174 hasWikiEnabled: Boolean = false
5175
5176 """
5177 The URL for a web page about this repository.
5178 """
5179 homepageUrl: URI
5180
5181 """
5182 The name of the new repository.
5183 """
5184 name: String!
5185
5186 """
5187 The ID of the owner for the new repository.
5188 """
5189 ownerId: ID @possibleTypes(concreteTypes: ["Organization", "User"], abstractType: "RepositoryOwner")
5190
5191 """
5192 When an organization is specified as the owner, this ID identifies the team
5193 that should be granted access to the new repository.
5194 """
5195 teamId: ID @possibleTypes(concreteTypes: ["Team"])
5196
5197 """
5198 Whether this repository should be marked as a template such that anyone who
5199 can access it can create new repositories with the same files and directory structure.
5200 """
5201 template: Boolean = false
5202
5203 """
5204 Indicates the repository's visibility level.
5205 """
5206 visibility: RepositoryVisibility!
5207}
5208
5209"""
5210Autogenerated return type of CreateRepository
5211"""
5212type CreateRepositoryPayload {
5213 """
5214 A unique identifier for the client performing the mutation.
5215 """
5216 clientMutationId: String
5217
5218 """
5219 The new repository.
5220 """
5221 repository: Repository
5222}
5223
5224"""
5225Autogenerated input type of CreateTeamDiscussionComment
5226"""
5227input CreateTeamDiscussionCommentInput {
5228 """
5229 The content of the comment.
5230 """
5231 body: String!
5232
5233 """
5234 A unique identifier for the client performing the mutation.
5235 """
5236 clientMutationId: String
5237
5238 """
5239 The ID of the discussion to which the comment belongs.
5240 """
5241 discussionId: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
5242}
5243
5244"""
5245Autogenerated return type of CreateTeamDiscussionComment
5246"""
5247type CreateTeamDiscussionCommentPayload {
5248 """
5249 A unique identifier for the client performing the mutation.
5250 """
5251 clientMutationId: String
5252
5253 """
5254 The new comment.
5255 """
5256 teamDiscussionComment: TeamDiscussionComment
5257}
5258
5259"""
5260Autogenerated input type of CreateTeamDiscussion
5261"""
5262input CreateTeamDiscussionInput {
5263 """
5264 The content of the discussion.
5265 """
5266 body: String!
5267
5268 """
5269 A unique identifier for the client performing the mutation.
5270 """
5271 clientMutationId: String
5272
5273 """
5274 If true, restricts the visiblity of this discussion to team members and
5275 organization admins. If false or not specified, allows any organization member
5276 to view this discussion.
5277 """
5278 private: Boolean
5279
5280 """
5281 The ID of the team to which the discussion belongs.
5282 """
5283 teamId: ID! @possibleTypes(concreteTypes: ["Team"])
5284
5285 """
5286 The title of the discussion.
5287 """
5288 title: String!
5289}
5290
5291"""
5292Autogenerated return type of CreateTeamDiscussion
5293"""
5294type CreateTeamDiscussionPayload {
5295 """
5296 A unique identifier for the client performing the mutation.
5297 """
5298 clientMutationId: String
5299
5300 """
5301 The new discussion.
5302 """
5303 teamDiscussion: TeamDiscussion
5304}
5305
5306"""
5307Represents the contribution a user made by committing to a repository.
5308"""
5309type CreatedCommitContribution implements Contribution {
5310 """
5311 How many commits were made on this day to this repository by the user.
5312 """
5313 commitCount: Int!
5314
5315 """
5316 Whether this contribution is associated with a record you do not have access to. For
5317 example, your own 'first issue' contribution may have been made on a repository you can no
5318 longer access.
5319 """
5320 isRestricted: Boolean!
5321
5322 """
5323 When this contribution was made.
5324 """
5325 occurredAt: DateTime!
5326
5327 """
5328 The repository the user made a commit in.
5329 """
5330 repository: Repository!
5331
5332 """
5333 The HTTP path for this contribution.
5334 """
5335 resourcePath: URI!
5336
5337 """
5338 The HTTP URL for this contribution.
5339 """
5340 url: URI!
5341
5342 """
5343 The user who made this contribution.
5344 """
5345 user: User!
5346}
5347
5348"""
5349The connection type for CreatedCommitContribution.
5350"""
5351type CreatedCommitContributionConnection {
5352 """
5353 A list of edges.
5354 """
5355 edges: [CreatedCommitContributionEdge]
5356
5357 """
5358 A list of nodes.
5359 """
5360 nodes: [CreatedCommitContribution]
5361
5362 """
5363 Information to aid in pagination.
5364 """
5365 pageInfo: PageInfo!
5366
5367 """
5368 Identifies the total count of commits across days and repositories in the connection.
5369 """
5370 totalCount: Int!
5371}
5372
5373"""
5374An edge in a connection.
5375"""
5376type CreatedCommitContributionEdge {
5377 """
5378 A cursor for use in pagination.
5379 """
5380 cursor: String!
5381
5382 """
5383 The item at the end of the edge.
5384 """
5385 node: CreatedCommitContribution
5386}
5387
5388"""
5389Represents the contribution a user made on GitHub by opening an issue.
5390"""
5391type CreatedIssueContribution implements Contribution {
5392 """
5393 Whether this contribution is associated with a record you do not have access to. For
5394 example, your own 'first issue' contribution may have been made on a repository you can no
5395 longer access.
5396 """
5397 isRestricted: Boolean!
5398
5399 """
5400 The issue that was opened.
5401 """
5402 issue: Issue!
5403
5404 """
5405 When this contribution was made.
5406 """
5407 occurredAt: DateTime!
5408
5409 """
5410 The HTTP path for this contribution.
5411 """
5412 resourcePath: URI!
5413
5414 """
5415 The HTTP URL for this contribution.
5416 """
5417 url: URI!
5418
5419 """
5420 The user who made this contribution.
5421 """
5422 user: User!
5423}
5424
5425"""
5426The connection type for CreatedIssueContribution.
5427"""
5428type CreatedIssueContributionConnection {
5429 """
5430 A list of edges.
5431 """
5432 edges: [CreatedIssueContributionEdge]
5433
5434 """
5435 A list of nodes.
5436 """
5437 nodes: [CreatedIssueContribution]
5438
5439 """
5440 Information to aid in pagination.
5441 """
5442 pageInfo: PageInfo!
5443
5444 """
5445 Identifies the total count of items in the connection.
5446 """
5447 totalCount: Int!
5448}
5449
5450"""
5451An edge in a connection.
5452"""
5453type CreatedIssueContributionEdge {
5454 """
5455 A cursor for use in pagination.
5456 """
5457 cursor: String!
5458
5459 """
5460 The item at the end of the edge.
5461 """
5462 node: CreatedIssueContribution
5463}
5464
5465"""
5466Represents either a issue the viewer can access or a restricted contribution.
5467"""
5468union CreatedIssueOrRestrictedContribution = CreatedIssueContribution | RestrictedContribution
5469
5470"""
5471Represents the contribution a user made on GitHub by opening a pull request.
5472"""
5473type CreatedPullRequestContribution implements Contribution {
5474 """
5475 Whether this contribution is associated with a record you do not have access to. For
5476 example, your own 'first issue' contribution may have been made on a repository you can no
5477 longer access.
5478 """
5479 isRestricted: Boolean!
5480
5481 """
5482 When this contribution was made.
5483 """
5484 occurredAt: DateTime!
5485
5486 """
5487 The pull request that was opened.
5488 """
5489 pullRequest: PullRequest!
5490
5491 """
5492 The HTTP path for this contribution.
5493 """
5494 resourcePath: URI!
5495
5496 """
5497 The HTTP URL for this contribution.
5498 """
5499 url: URI!
5500
5501 """
5502 The user who made this contribution.
5503 """
5504 user: User!
5505}
5506
5507"""
5508The connection type for CreatedPullRequestContribution.
5509"""
5510type CreatedPullRequestContributionConnection {
5511 """
5512 A list of edges.
5513 """
5514 edges: [CreatedPullRequestContributionEdge]
5515
5516 """
5517 A list of nodes.
5518 """
5519 nodes: [CreatedPullRequestContribution]
5520
5521 """
5522 Information to aid in pagination.
5523 """
5524 pageInfo: PageInfo!
5525
5526 """
5527 Identifies the total count of items in the connection.
5528 """
5529 totalCount: Int!
5530}
5531
5532"""
5533An edge in a connection.
5534"""
5535type CreatedPullRequestContributionEdge {
5536 """
5537 A cursor for use in pagination.
5538 """
5539 cursor: String!
5540
5541 """
5542 The item at the end of the edge.
5543 """
5544 node: CreatedPullRequestContribution
5545}
5546
5547"""
5548Represents either a pull request the viewer can access or a restricted contribution.
5549"""
5550union CreatedPullRequestOrRestrictedContribution = CreatedPullRequestContribution | RestrictedContribution
5551
5552"""
5553Represents the contribution a user made by leaving a review on a pull request.
5554"""
5555type CreatedPullRequestReviewContribution implements Contribution {
5556 """
5557 Whether this contribution is associated with a record you do not have access to. For
5558 example, your own 'first issue' contribution may have been made on a repository you can no
5559 longer access.
5560 """
5561 isRestricted: Boolean!
5562
5563 """
5564 When this contribution was made.
5565 """
5566 occurredAt: DateTime!
5567
5568 """
5569 The pull request the user reviewed.
5570 """
5571 pullRequest: PullRequest!
5572
5573 """
5574 The review the user left on the pull request.
5575 """
5576 pullRequestReview: PullRequestReview!
5577
5578 """
5579 The repository containing the pull request that the user reviewed.
5580 """
5581 repository: Repository!
5582
5583 """
5584 The HTTP path for this contribution.
5585 """
5586 resourcePath: URI!
5587
5588 """
5589 The HTTP URL for this contribution.
5590 """
5591 url: URI!
5592
5593 """
5594 The user who made this contribution.
5595 """
5596 user: User!
5597}
5598
5599"""
5600The connection type for CreatedPullRequestReviewContribution.
5601"""
5602type CreatedPullRequestReviewContributionConnection {
5603 """
5604 A list of edges.
5605 """
5606 edges: [CreatedPullRequestReviewContributionEdge]
5607
5608 """
5609 A list of nodes.
5610 """
5611 nodes: [CreatedPullRequestReviewContribution]
5612
5613 """
5614 Information to aid in pagination.
5615 """
5616 pageInfo: PageInfo!
5617
5618 """
5619 Identifies the total count of items in the connection.
5620 """
5621 totalCount: Int!
5622}
5623
5624"""
5625An edge in a connection.
5626"""
5627type CreatedPullRequestReviewContributionEdge {
5628 """
5629 A cursor for use in pagination.
5630 """
5631 cursor: String!
5632
5633 """
5634 The item at the end of the edge.
5635 """
5636 node: CreatedPullRequestReviewContribution
5637}
5638
5639"""
5640Represents the contribution a user made on GitHub by creating a repository.
5641"""
5642type CreatedRepositoryContribution implements Contribution {
5643 """
5644 Whether this contribution is associated with a record you do not have access to. For
5645 example, your own 'first issue' contribution may have been made on a repository you can no
5646 longer access.
5647 """
5648 isRestricted: Boolean!
5649
5650 """
5651 When this contribution was made.
5652 """
5653 occurredAt: DateTime!
5654
5655 """
5656 The repository that was created.
5657 """
5658 repository: Repository!
5659
5660 """
5661 The HTTP path for this contribution.
5662 """
5663 resourcePath: URI!
5664
5665 """
5666 The HTTP URL for this contribution.
5667 """
5668 url: URI!
5669
5670 """
5671 The user who made this contribution.
5672 """
5673 user: User!
5674}
5675
5676"""
5677The connection type for CreatedRepositoryContribution.
5678"""
5679type CreatedRepositoryContributionConnection {
5680 """
5681 A list of edges.
5682 """
5683 edges: [CreatedRepositoryContributionEdge]
5684
5685 """
5686 A list of nodes.
5687 """
5688 nodes: [CreatedRepositoryContribution]
5689
5690 """
5691 Information to aid in pagination.
5692 """
5693 pageInfo: PageInfo!
5694
5695 """
5696 Identifies the total count of items in the connection.
5697 """
5698 totalCount: Int!
5699}
5700
5701"""
5702An edge in a connection.
5703"""
5704type CreatedRepositoryContributionEdge {
5705 """
5706 A cursor for use in pagination.
5707 """
5708 cursor: String!
5709
5710 """
5711 The item at the end of the edge.
5712 """
5713 node: CreatedRepositoryContribution
5714}
5715
5716"""
5717Represents either a repository the viewer can access or a restricted contribution.
5718"""
5719union CreatedRepositoryOrRestrictedContribution = CreatedRepositoryContribution | RestrictedContribution
5720
5721"""
5722Represents a mention made by one issue or pull request to another.
5723"""
5724type CrossReferencedEvent implements Node & UniformResourceLocatable {
5725 """
5726 Identifies the actor who performed the event.
5727 """
5728 actor: Actor
5729
5730 """
5731 Identifies the date and time when the object was created.
5732 """
5733 createdAt: DateTime!
5734 id: ID!
5735
5736 """
5737 Reference originated in a different repository.
5738 """
5739 isCrossRepository: Boolean!
5740
5741 """
5742 Identifies when the reference was made.
5743 """
5744 referencedAt: DateTime!
5745
5746 """
5747 The HTTP path for this pull request.
5748 """
5749 resourcePath: URI!
5750
5751 """
5752 Issue or pull request that made the reference.
5753 """
5754 source: ReferencedSubject!
5755
5756 """
5757 Issue or pull request to which the reference was made.
5758 """
5759 target: ReferencedSubject!
5760
5761 """
5762 The HTTP URL for this pull request.
5763 """
5764 url: URI!
5765
5766 """
5767 Checks if the target will be closed when the source is merged.
5768 """
5769 willCloseTarget: Boolean!
5770}
5771
5772"""
5773An ISO-8601 encoded date string.
5774"""
5775scalar Date
5776
5777"""
5778An ISO-8601 encoded UTC date string.
5779"""
5780scalar DateTime
5781
5782"""
5783Autogenerated input type of DeclineTopicSuggestion
5784"""
5785input DeclineTopicSuggestionInput {
5786 """
5787 A unique identifier for the client performing the mutation.
5788 """
5789 clientMutationId: String
5790
5791 """
5792 The name of the suggested topic.
5793 """
5794 name: String!
5795
5796 """
5797 The reason why the suggested topic is declined.
5798 """
5799 reason: TopicSuggestionDeclineReason!
5800
5801 """
5802 The Node ID of the repository.
5803 """
5804 repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
5805}
5806
5807"""
5808Autogenerated return type of DeclineTopicSuggestion
5809"""
5810type DeclineTopicSuggestionPayload {
5811 """
5812 A unique identifier for the client performing the mutation.
5813 """
5814 clientMutationId: String
5815
5816 """
5817 The declined topic.
5818 """
5819 topic: Topic
5820}
5821
5822"""
5823The possible default permissions for repositories.
5824"""
5825enum DefaultRepositoryPermissionField {
5826 """
5827 Can read, write, and administrate repos by default
5828 """
5829 ADMIN
5830
5831 """
5832 No access
5833 """
5834 NONE
5835
5836 """
5837 Can read repos by default
5838 """
5839 READ
5840
5841 """
5842 Can read and write repos by default
5843 """
5844 WRITE
5845}
5846
5847"""
5848Entities that can be deleted.
5849"""
5850interface Deletable {
5851 """
5852 Check if the current viewer can delete this object.
5853 """
5854 viewerCanDelete: Boolean!
5855}
5856
5857"""
5858Autogenerated input type of DeleteBranchProtectionRule
5859"""
5860input DeleteBranchProtectionRuleInput {
5861 """
5862 The global relay id of the branch protection rule to be deleted.
5863 """
5864 branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"])
5865
5866 """
5867 A unique identifier for the client performing the mutation.
5868 """
5869 clientMutationId: String
5870}
5871
5872"""
5873Autogenerated return type of DeleteBranchProtectionRule
5874"""
5875type DeleteBranchProtectionRulePayload {
5876 """
5877 A unique identifier for the client performing the mutation.
5878 """
5879 clientMutationId: String
5880}
5881
5882"""
5883Autogenerated input type of DeleteDeployment
5884"""
5885input DeleteDeploymentInput {
5886 """
5887 A unique identifier for the client performing the mutation.
5888 """
5889 clientMutationId: String
5890
5891 """
5892 The Node ID of the deployment to be deleted.
5893 """
5894 id: ID! @possibleTypes(concreteTypes: ["Deployment"])
5895}
5896
5897"""
5898Autogenerated return type of DeleteDeployment
5899"""
5900type DeleteDeploymentPayload {
5901 """
5902 A unique identifier for the client performing the mutation.
5903 """
5904 clientMutationId: String
5905}
5906
5907"""
5908Autogenerated input type of DeleteIpAllowListEntry
5909"""
5910input DeleteIpAllowListEntryInput {
5911 """
5912 A unique identifier for the client performing the mutation.
5913 """
5914 clientMutationId: String
5915
5916 """
5917 The ID of the IP allow list entry to delete.
5918 """
5919 ipAllowListEntryId: ID! @possibleTypes(concreteTypes: ["IpAllowListEntry"])
5920}
5921
5922"""
5923Autogenerated return type of DeleteIpAllowListEntry
5924"""
5925type DeleteIpAllowListEntryPayload {
5926 """
5927 A unique identifier for the client performing the mutation.
5928 """
5929 clientMutationId: String
5930
5931 """
5932 The IP allow list entry that was deleted.
5933 """
5934 ipAllowListEntry: IpAllowListEntry
5935}
5936
5937"""
5938Autogenerated input type of DeleteIssueComment
5939"""
5940input DeleteIssueCommentInput {
5941 """
5942 A unique identifier for the client performing the mutation.
5943 """
5944 clientMutationId: String
5945
5946 """
5947 The ID of the comment to delete.
5948 """
5949 id: ID! @possibleTypes(concreteTypes: ["IssueComment"])
5950}
5951
5952"""
5953Autogenerated return type of DeleteIssueComment
5954"""
5955type DeleteIssueCommentPayload {
5956 """
5957 A unique identifier for the client performing the mutation.
5958 """
5959 clientMutationId: String
5960}
5961
5962"""
5963Autogenerated input type of DeleteIssue
5964"""
5965input DeleteIssueInput {
5966 """
5967 A unique identifier for the client performing the mutation.
5968 """
5969 clientMutationId: String
5970
5971 """
5972 The ID of the issue to delete.
5973 """
5974 issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
5975}
5976
5977"""
5978Autogenerated return type of DeleteIssue
5979"""
5980type DeleteIssuePayload {
5981 """
5982 A unique identifier for the client performing the mutation.
5983 """
5984 clientMutationId: String
5985
5986 """
5987 The repository the issue belonged to
5988 """
5989 repository: Repository
5990}
5991
5992"""
5993Autogenerated input type of DeleteLabel
5994"""
5995input DeleteLabelInput @preview(toggledBy: "bane-preview") {
5996 """
5997 A unique identifier for the client performing the mutation.
5998 """
5999 clientMutationId: String
6000
6001 """
6002 The Node ID of the label to be deleted.
6003 """
6004 id: ID! @possibleTypes(concreteTypes: ["Label"])
6005}
6006
6007"""
6008Autogenerated return type of DeleteLabel
6009"""
6010type DeleteLabelPayload @preview(toggledBy: "bane-preview") {
6011 """
6012 A unique identifier for the client performing the mutation.
6013 """
6014 clientMutationId: String
6015}
6016
6017"""
6018Autogenerated input type of DeletePackageVersion
6019"""
6020input DeletePackageVersionInput {
6021 """
6022 A unique identifier for the client performing the mutation.
6023 """
6024 clientMutationId: String
6025
6026 """
6027 The ID of the package version to be deleted.
6028 """
6029 packageVersionId: ID! @possibleTypes(concreteTypes: ["PackageVersion"])
6030}
6031
6032"""
6033Autogenerated return type of DeletePackageVersion
6034"""
6035type DeletePackageVersionPayload {
6036 """
6037 A unique identifier for the client performing the mutation.
6038 """
6039 clientMutationId: String
6040
6041 """
6042 Whether or not the operation succeeded.
6043 """
6044 success: Boolean
6045}
6046
6047"""
6048Autogenerated input type of DeleteProjectCard
6049"""
6050input DeleteProjectCardInput {
6051 """
6052 The id of the card to delete.
6053 """
6054 cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
6055
6056 """
6057 A unique identifier for the client performing the mutation.
6058 """
6059 clientMutationId: String
6060}
6061
6062"""
6063Autogenerated return type of DeleteProjectCard
6064"""
6065type DeleteProjectCardPayload {
6066 """
6067 A unique identifier for the client performing the mutation.
6068 """
6069 clientMutationId: String
6070
6071 """
6072 The column the deleted card was in.
6073 """
6074 column: ProjectColumn
6075
6076 """
6077 The deleted card ID.
6078 """
6079 deletedCardId: ID
6080}
6081
6082"""
6083Autogenerated input type of DeleteProjectColumn
6084"""
6085input DeleteProjectColumnInput {
6086 """
6087 A unique identifier for the client performing the mutation.
6088 """
6089 clientMutationId: String
6090
6091 """
6092 The id of the column to delete.
6093 """
6094 columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
6095}
6096
6097"""
6098Autogenerated return type of DeleteProjectColumn
6099"""
6100type DeleteProjectColumnPayload {
6101 """
6102 A unique identifier for the client performing the mutation.
6103 """
6104 clientMutationId: String
6105
6106 """
6107 The deleted column ID.
6108 """
6109 deletedColumnId: ID
6110
6111 """
6112 The project the deleted column was in.
6113 """
6114 project: Project
6115}
6116
6117"""
6118Autogenerated input type of DeleteProject
6119"""
6120input DeleteProjectInput {
6121 """
6122 A unique identifier for the client performing the mutation.
6123 """
6124 clientMutationId: String
6125
6126 """
6127 The Project ID to update.
6128 """
6129 projectId: ID! @possibleTypes(concreteTypes: ["Project"])
6130}
6131
6132"""
6133Autogenerated return type of DeleteProject
6134"""
6135type DeleteProjectPayload {
6136 """
6137 A unique identifier for the client performing the mutation.
6138 """
6139 clientMutationId: String
6140
6141 """
6142 The repository or organization the project was removed from.
6143 """
6144 owner: ProjectOwner
6145}
6146
6147"""
6148Autogenerated input type of DeletePullRequestReviewComment
6149"""
6150input DeletePullRequestReviewCommentInput {
6151 """
6152 A unique identifier for the client performing the mutation.
6153 """
6154 clientMutationId: String
6155
6156 """
6157 The ID of the comment to delete.
6158 """
6159 id: ID! @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
6160}
6161
6162"""
6163Autogenerated return type of DeletePullRequestReviewComment
6164"""
6165type DeletePullRequestReviewCommentPayload {
6166 """
6167 A unique identifier for the client performing the mutation.
6168 """
6169 clientMutationId: String
6170
6171 """
6172 The pull request review the deleted comment belonged to.
6173 """
6174 pullRequestReview: PullRequestReview
6175}
6176
6177"""
6178Autogenerated input type of DeletePullRequestReview
6179"""
6180input DeletePullRequestReviewInput {
6181 """
6182 A unique identifier for the client performing the mutation.
6183 """
6184 clientMutationId: String
6185
6186 """
6187 The Node ID of the pull request review to delete.
6188 """
6189 pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
6190}
6191
6192"""
6193Autogenerated return type of DeletePullRequestReview
6194"""
6195type DeletePullRequestReviewPayload {
6196 """
6197 A unique identifier for the client performing the mutation.
6198 """
6199 clientMutationId: String
6200
6201 """
6202 The deleted pull request review.
6203 """
6204 pullRequestReview: PullRequestReview
6205}
6206
6207"""
6208Autogenerated input type of DeleteRef
6209"""
6210input DeleteRefInput {
6211 """
6212 A unique identifier for the client performing the mutation.
6213 """
6214 clientMutationId: String
6215
6216 """
6217 The Node ID of the Ref to be deleted.
6218 """
6219 refId: ID! @possibleTypes(concreteTypes: ["Ref"])
6220}
6221
6222"""
6223Autogenerated return type of DeleteRef
6224"""
6225type DeleteRefPayload {
6226 """
6227 A unique identifier for the client performing the mutation.
6228 """
6229 clientMutationId: String
6230}
6231
6232"""
6233Autogenerated input type of DeleteTeamDiscussionComment
6234"""
6235input DeleteTeamDiscussionCommentInput {
6236 """
6237 A unique identifier for the client performing the mutation.
6238 """
6239 clientMutationId: String
6240
6241 """
6242 The ID of the comment to delete.
6243 """
6244 id: ID! @possibleTypes(concreteTypes: ["TeamDiscussionComment"])
6245}
6246
6247"""
6248Autogenerated return type of DeleteTeamDiscussionComment
6249"""
6250type DeleteTeamDiscussionCommentPayload {
6251 """
6252 A unique identifier for the client performing the mutation.
6253 """
6254 clientMutationId: String
6255}
6256
6257"""
6258Autogenerated input type of DeleteTeamDiscussion
6259"""
6260input DeleteTeamDiscussionInput {
6261 """
6262 A unique identifier for the client performing the mutation.
6263 """
6264 clientMutationId: String
6265
6266 """
6267 The discussion ID to delete.
6268 """
6269 id: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
6270}
6271
6272"""
6273Autogenerated return type of DeleteTeamDiscussion
6274"""
6275type DeleteTeamDiscussionPayload {
6276 """
6277 A unique identifier for the client performing the mutation.
6278 """
6279 clientMutationId: String
6280}
6281
6282"""
6283Represents a 'demilestoned' event on a given issue or pull request.
6284"""
6285type DemilestonedEvent implements Node {
6286 """
6287 Identifies the actor who performed the event.
6288 """
6289 actor: Actor
6290
6291 """
6292 Identifies the date and time when the object was created.
6293 """
6294 createdAt: DateTime!
6295 id: ID!
6296
6297 """
6298 Identifies the milestone title associated with the 'demilestoned' event.
6299 """
6300 milestoneTitle: String!
6301
6302 """
6303 Object referenced by event.
6304 """
6305 subject: MilestoneItem!
6306}
6307
6308"""
6309A dependency manifest entry
6310"""
6311type DependencyGraphDependency @preview(toggledBy: "hawkgirl-preview") {
6312 """
6313 Does the dependency itself have dependencies?
6314 """
6315 hasDependencies: Boolean!
6316
6317 """
6318 The dependency package manager
6319 """
6320 packageManager: String
6321
6322 """
6323 The required package name
6324 """
6325 packageName: String!
6326
6327 """
6328 The repository containing the package
6329 """
6330 repository: Repository
6331
6332 """
6333 The dependency version requirements
6334 """
6335 requirements: String!
6336}
6337
6338"""
6339The connection type for DependencyGraphDependency.
6340"""
6341type DependencyGraphDependencyConnection @preview(toggledBy: "hawkgirl-preview") {
6342 """
6343 A list of edges.
6344 """
6345 edges: [DependencyGraphDependencyEdge]
6346
6347 """
6348 A list of nodes.
6349 """
6350 nodes: [DependencyGraphDependency]
6351
6352 """
6353 Information to aid in pagination.
6354 """
6355 pageInfo: PageInfo!
6356
6357 """
6358 Identifies the total count of items in the connection.
6359 """
6360 totalCount: Int!
6361}
6362
6363"""
6364An edge in a connection.
6365"""
6366type DependencyGraphDependencyEdge @preview(toggledBy: "hawkgirl-preview") {
6367 """
6368 A cursor for use in pagination.
6369 """
6370 cursor: String!
6371
6372 """
6373 The item at the end of the edge.
6374 """
6375 node: DependencyGraphDependency
6376}
6377
6378"""
6379Dependency manifest for a repository
6380"""
6381type DependencyGraphManifest implements Node @preview(toggledBy: "hawkgirl-preview") {
6382 """
6383 Path to view the manifest file blob
6384 """
6385 blobPath: String!
6386
6387 """
6388 A list of manifest dependencies
6389 """
6390 dependencies(
6391 """
6392 Returns the elements in the list that come after the specified cursor.
6393 """
6394 after: String
6395
6396 """
6397 Returns the elements in the list that come before the specified cursor.
6398 """
6399 before: String
6400
6401 """
6402 Returns the first _n_ elements from the list.
6403 """
6404 first: Int
6405
6406 """
6407 Returns the last _n_ elements from the list.
6408 """
6409 last: Int
6410 ): DependencyGraphDependencyConnection
6411
6412 """
6413 The number of dependencies listed in the manifest
6414 """
6415 dependenciesCount: Int
6416
6417 """
6418 Is the manifest too big to parse?
6419 """
6420 exceedsMaxSize: Boolean!
6421
6422 """
6423 Fully qualified manifest filename
6424 """
6425 filename: String!
6426 id: ID!
6427
6428 """
6429 Were we able to parse the manifest?
6430 """
6431 parseable: Boolean!
6432
6433 """
6434 The repository containing the manifest
6435 """
6436 repository: Repository!
6437}
6438
6439"""
6440The connection type for DependencyGraphManifest.
6441"""
6442type DependencyGraphManifestConnection @preview(toggledBy: "hawkgirl-preview") {
6443 """
6444 A list of edges.
6445 """
6446 edges: [DependencyGraphManifestEdge]
6447
6448 """
6449 A list of nodes.
6450 """
6451 nodes: [DependencyGraphManifest]
6452
6453 """
6454 Information to aid in pagination.
6455 """
6456 pageInfo: PageInfo!
6457
6458 """
6459 Identifies the total count of items in the connection.
6460 """
6461 totalCount: Int!
6462}
6463
6464"""
6465An edge in a connection.
6466"""
6467type DependencyGraphManifestEdge @preview(toggledBy: "hawkgirl-preview") {
6468 """
6469 A cursor for use in pagination.
6470 """
6471 cursor: String!
6472
6473 """
6474 The item at the end of the edge.
6475 """
6476 node: DependencyGraphManifest
6477}
6478
6479"""
6480A repository deploy key.
6481"""
6482type DeployKey implements Node {
6483 """
6484 Identifies the date and time when the object was created.
6485 """
6486 createdAt: DateTime!
6487 id: ID!
6488
6489 """
6490 The deploy key.
6491 """
6492 key: String!
6493
6494 """
6495 Whether or not the deploy key is read only.
6496 """
6497 readOnly: Boolean!
6498
6499 """
6500 The deploy key title.
6501 """
6502 title: String!
6503
6504 """
6505 Whether or not the deploy key has been verified.
6506 """
6507 verified: Boolean!
6508}
6509
6510"""
6511The connection type for DeployKey.
6512"""
6513type DeployKeyConnection {
6514 """
6515 A list of edges.
6516 """
6517 edges: [DeployKeyEdge]
6518
6519 """
6520 A list of nodes.
6521 """
6522 nodes: [DeployKey]
6523
6524 """
6525 Information to aid in pagination.
6526 """
6527 pageInfo: PageInfo!
6528
6529 """
6530 Identifies the total count of items in the connection.
6531 """
6532 totalCount: Int!
6533}
6534
6535"""
6536An edge in a connection.
6537"""
6538type DeployKeyEdge {
6539 """
6540 A cursor for use in pagination.
6541 """
6542 cursor: String!
6543
6544 """
6545 The item at the end of the edge.
6546 """
6547 node: DeployKey
6548}
6549
6550"""
6551Represents a 'deployed' event on a given pull request.
6552"""
6553type DeployedEvent implements Node {
6554 """
6555 Identifies the actor who performed the event.
6556 """
6557 actor: Actor
6558
6559 """
6560 Identifies the date and time when the object was created.
6561 """
6562 createdAt: DateTime!
6563
6564 """
6565 Identifies the primary key from the database.
6566 """
6567 databaseId: Int
6568
6569 """
6570 The deployment associated with the 'deployed' event.
6571 """
6572 deployment: Deployment!
6573 id: ID!
6574
6575 """
6576 PullRequest referenced by event.
6577 """
6578 pullRequest: PullRequest!
6579
6580 """
6581 The ref associated with the 'deployed' event.
6582 """
6583 ref: Ref
6584}
6585
6586"""
6587Represents triggered deployment instance.
6588"""
6589type Deployment implements Node {
6590 """
6591 Identifies the commit sha of the deployment.
6592 """
6593 commit: Commit
6594
6595 """
6596 Identifies the oid of the deployment commit, even if the commit has been deleted.
6597 """
6598 commitOid: String!
6599
6600 """
6601 Identifies the date and time when the object was created.
6602 """
6603 createdAt: DateTime!
6604
6605 """
6606 Identifies the actor who triggered the deployment.
6607 """
6608 creator: Actor!
6609
6610 """
6611 Identifies the primary key from the database.
6612 """
6613 databaseId: Int
6614
6615 """
6616 The deployment description.
6617 """
6618 description: String
6619
6620 """
6621 The latest environment to which this deployment was made.
6622 """
6623 environment: String
6624 id: ID!
6625
6626 """
6627 The latest environment to which this deployment was made.
6628 """
6629 latestEnvironment: String
6630
6631 """
6632 The latest status of this deployment.
6633 """
6634 latestStatus: DeploymentStatus
6635
6636 """
6637 The original environment to which this deployment was made.
6638 """
6639 originalEnvironment: String
6640
6641 """
6642 Extra information that a deployment system might need.
6643 """
6644 payload: String
6645
6646 """
6647 Identifies the Ref of the deployment, if the deployment was created by ref.
6648 """
6649 ref: Ref
6650
6651 """
6652 Identifies the repository associated with the deployment.
6653 """
6654 repository: Repository!
6655
6656 """
6657 The current state of the deployment.
6658 """
6659 state: DeploymentState
6660
6661 """
6662 A list of statuses associated with the deployment.
6663 """
6664 statuses(
6665 """
6666 Returns the elements in the list that come after the specified cursor.
6667 """
6668 after: String
6669
6670 """
6671 Returns the elements in the list that come before the specified cursor.
6672 """
6673 before: String
6674
6675 """
6676 Returns the first _n_ elements from the list.
6677 """
6678 first: Int
6679
6680 """
6681 Returns the last _n_ elements from the list.
6682 """
6683 last: Int
6684 ): DeploymentStatusConnection
6685
6686 """
6687 The deployment task.
6688 """
6689 task: String
6690
6691 """
6692 Identifies the date and time when the object was last updated.
6693 """
6694 updatedAt: DateTime!
6695}
6696
6697"""
6698The connection type for Deployment.
6699"""
6700type DeploymentConnection {
6701 """
6702 A list of edges.
6703 """
6704 edges: [DeploymentEdge]
6705
6706 """
6707 A list of nodes.
6708 """
6709 nodes: [Deployment]
6710
6711 """
6712 Information to aid in pagination.
6713 """
6714 pageInfo: PageInfo!
6715
6716 """
6717 Identifies the total count of items in the connection.
6718 """
6719 totalCount: Int!
6720}
6721
6722"""
6723An edge in a connection.
6724"""
6725type DeploymentEdge {
6726 """
6727 A cursor for use in pagination.
6728 """
6729 cursor: String!
6730
6731 """
6732 The item at the end of the edge.
6733 """
6734 node: Deployment
6735}
6736
6737"""
6738Represents a 'deployment_environment_changed' event on a given pull request.
6739"""
6740type DeploymentEnvironmentChangedEvent implements Node {
6741 """
6742 Identifies the actor who performed the event.
6743 """
6744 actor: Actor
6745
6746 """
6747 Identifies the date and time when the object was created.
6748 """
6749 createdAt: DateTime!
6750
6751 """
6752 The deployment status that updated the deployment environment.
6753 """
6754 deploymentStatus: DeploymentStatus!
6755 id: ID!
6756
6757 """
6758 PullRequest referenced by event.
6759 """
6760 pullRequest: PullRequest!
6761}
6762
6763"""
6764Ordering options for deployment connections
6765"""
6766input DeploymentOrder {
6767 """
6768 The ordering direction.
6769 """
6770 direction: OrderDirection!
6771
6772 """
6773 The field to order deployments by.
6774 """
6775 field: DeploymentOrderField!
6776}
6777
6778"""
6779Properties by which deployment connections can be ordered.
6780"""
6781enum DeploymentOrderField {
6782 """
6783 Order collection by creation time
6784 """
6785 CREATED_AT
6786}
6787
6788"""
6789The possible states in which a deployment can be.
6790"""
6791enum DeploymentState {
6792 """
6793 The pending deployment was not updated after 30 minutes.
6794 """
6795 ABANDONED
6796
6797 """
6798 The deployment is currently active.
6799 """
6800 ACTIVE
6801
6802 """
6803 An inactive transient deployment.
6804 """
6805 DESTROYED
6806
6807 """
6808 The deployment experienced an error.
6809 """
6810 ERROR
6811
6812 """
6813 The deployment has failed.
6814 """
6815 FAILURE
6816
6817 """
6818 The deployment is inactive.
6819 """
6820 INACTIVE
6821
6822 """
6823 The deployment is in progress.
6824 """
6825 IN_PROGRESS
6826
6827 """
6828 The deployment is pending.
6829 """
6830 PENDING
6831
6832 """
6833 The deployment has queued
6834 """
6835 QUEUED
6836}
6837
6838"""
6839Describes the status of a given deployment attempt.
6840"""
6841type DeploymentStatus implements Node {
6842 """
6843 Identifies the date and time when the object was created.
6844 """
6845 createdAt: DateTime!
6846
6847 """
6848 Identifies the actor who triggered the deployment.
6849 """
6850 creator: Actor!
6851
6852 """
6853 Identifies the deployment associated with status.
6854 """
6855 deployment: Deployment!
6856
6857 """
6858 Identifies the description of the deployment.
6859 """
6860 description: String
6861
6862 """
6863 Identifies the environment of the deployment at the time of this deployment status
6864 """
6865 environment: String @preview(toggledBy: "flash-preview")
6866
6867 """
6868 Identifies the environment URL of the deployment.
6869 """
6870 environmentUrl: URI
6871 id: ID!
6872
6873 """
6874 Identifies the log URL of the deployment.
6875 """
6876 logUrl: URI
6877
6878 """
6879 Identifies the current state of the deployment.
6880 """
6881 state: DeploymentStatusState!
6882
6883 """
6884 Identifies the date and time when the object was last updated.
6885 """
6886 updatedAt: DateTime!
6887}
6888
6889"""
6890The connection type for DeploymentStatus.
6891"""
6892type DeploymentStatusConnection {
6893 """
6894 A list of edges.
6895 """
6896 edges: [DeploymentStatusEdge]
6897
6898 """
6899 A list of nodes.
6900 """
6901 nodes: [DeploymentStatus]
6902
6903 """
6904 Information to aid in pagination.
6905 """
6906 pageInfo: PageInfo!
6907
6908 """
6909 Identifies the total count of items in the connection.
6910 """
6911 totalCount: Int!
6912}
6913
6914"""
6915An edge in a connection.
6916"""
6917type DeploymentStatusEdge {
6918 """
6919 A cursor for use in pagination.
6920 """
6921 cursor: String!
6922
6923 """
6924 The item at the end of the edge.
6925 """
6926 node: DeploymentStatus
6927}
6928
6929"""
6930The possible states for a deployment status.
6931"""
6932enum DeploymentStatusState {
6933 """
6934 The deployment experienced an error.
6935 """
6936 ERROR
6937
6938 """
6939 The deployment has failed.
6940 """
6941 FAILURE
6942
6943 """
6944 The deployment is inactive.
6945 """
6946 INACTIVE
6947
6948 """
6949 The deployment is in progress.
6950 """
6951 IN_PROGRESS
6952
6953 """
6954 The deployment is pending.
6955 """
6956 PENDING
6957
6958 """
6959 The deployment is queued
6960 """
6961 QUEUED
6962
6963 """
6964 The deployment was successful.
6965 """
6966 SUCCESS
6967}
6968
6969"""
6970The possible sides of a diff.
6971"""
6972enum DiffSide {
6973 """
6974 The left side of the diff.
6975 """
6976 LEFT
6977
6978 """
6979 The right side of the diff.
6980 """
6981 RIGHT
6982}
6983
6984"""
6985Represents a 'disconnected' event on a given issue or pull request.
6986"""
6987type DisconnectedEvent implements Node {
6988 """
6989 Identifies the actor who performed the event.
6990 """
6991 actor: Actor
6992
6993 """
6994 Identifies the date and time when the object was created.
6995 """
6996 createdAt: DateTime!
6997 id: ID!
6998
6999 """
7000 Reference originated in a different repository.
7001 """
7002 isCrossRepository: Boolean!
7003
7004 """
7005 Issue or pull request from which the issue was disconnected.
7006 """
7007 source: ReferencedSubject!
7008
7009 """
7010 Issue or pull request which was disconnected.
7011 """
7012 subject: ReferencedSubject!
7013}
7014
7015"""
7016Autogenerated input type of DismissPullRequestReview
7017"""
7018input DismissPullRequestReviewInput {
7019 """
7020 A unique identifier for the client performing the mutation.
7021 """
7022 clientMutationId: String
7023
7024 """
7025 The contents of the pull request review dismissal message.
7026 """
7027 message: String!
7028
7029 """
7030 The Node ID of the pull request review to modify.
7031 """
7032 pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
7033}
7034
7035"""
7036Autogenerated return type of DismissPullRequestReview
7037"""
7038type DismissPullRequestReviewPayload {
7039 """
7040 A unique identifier for the client performing the mutation.
7041 """
7042 clientMutationId: String
7043
7044 """
7045 The dismissed pull request review.
7046 """
7047 pullRequestReview: PullRequestReview
7048}
7049
7050"""
7051Specifies a review comment to be left with a Pull Request Review.
7052"""
7053input DraftPullRequestReviewComment {
7054 """
7055 Body of the comment to leave.
7056 """
7057 body: String!
7058
7059 """
7060 Path to the file being commented on.
7061 """
7062 path: String!
7063
7064 """
7065 Position in the file to leave a comment on.
7066 """
7067 position: Int!
7068}
7069
7070"""
7071Specifies a review comment thread to be left with a Pull Request Review.
7072"""
7073input DraftPullRequestReviewThread {
7074 """
7075 Body of the comment to leave.
7076 """
7077 body: String!
7078
7079 """
7080 The line of the blob to which the thread refers. The end of the line range for multi-line comments.
7081 """
7082 line: Int!
7083
7084 """
7085 Path to the file being commented on.
7086 """
7087 path: String!
7088
7089 """
7090 The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
7091 """
7092 side: DiffSide = RIGHT
7093
7094 """
7095 The first line of the range to which the comment refers.
7096 """
7097 startLine: Int
7098
7099 """
7100 The side of the diff on which the start line resides.
7101 """
7102 startSide: DiffSide = RIGHT
7103}
7104
7105"""
7106An account to manage multiple organizations with consolidated policy and billing.
7107"""
7108type Enterprise implements Node {
7109 """
7110 A URL pointing to the enterprise's public avatar.
7111 """
7112 avatarUrl(
7113 """
7114 The size of the resulting square image.
7115 """
7116 size: Int
7117 ): URI!
7118
7119 """
7120 Enterprise billing information visible to enterprise billing managers.
7121 """
7122 billingInfo: EnterpriseBillingInfo
7123
7124 """
7125 Identifies the date and time when the object was created.
7126 """
7127 createdAt: DateTime!
7128
7129 """
7130 Identifies the primary key from the database.
7131 """
7132 databaseId: Int
7133
7134 """
7135 The description of the enterprise.
7136 """
7137 description: String
7138
7139 """
7140 The description of the enterprise as HTML.
7141 """
7142 descriptionHTML: HTML!
7143 id: ID!
7144
7145 """
7146 The location of the enterprise.
7147 """
7148 location: String
7149
7150 """
7151 A list of users who are members of this enterprise.
7152 """
7153 members(
7154 """
7155 Returns the elements in the list that come after the specified cursor.
7156 """
7157 after: String
7158
7159 """
7160 Returns the elements in the list that come before the specified cursor.
7161 """
7162 before: String
7163
7164 """
7165 Only return members within the selected GitHub Enterprise deployment
7166 """
7167 deployment: EnterpriseUserDeployment
7168
7169 """
7170 Returns the first _n_ elements from the list.
7171 """
7172 first: Int
7173
7174 """
7175 Returns the last _n_ elements from the list.
7176 """
7177 last: Int
7178
7179 """
7180 Ordering options for members returned from the connection.
7181 """
7182 orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
7183
7184 """
7185 Only return members within the organizations with these logins
7186 """
7187 organizationLogins: [String!]
7188
7189 """
7190 The search string to look for.
7191 """
7192 query: String
7193
7194 """
7195 The role of the user in the enterprise organization or server.
7196 """
7197 role: EnterpriseUserAccountMembershipRole
7198 ): EnterpriseMemberConnection!
7199
7200 """
7201 The name of the enterprise.
7202 """
7203 name: String!
7204
7205 """
7206 A list of organizations that belong to this enterprise.
7207 """
7208 organizations(
7209 """
7210 Returns the elements in the list that come after the specified cursor.
7211 """
7212 after: String
7213
7214 """
7215 Returns the elements in the list that come before the specified cursor.
7216 """
7217 before: String
7218
7219 """
7220 Returns the first _n_ elements from the list.
7221 """
7222 first: Int
7223
7224 """
7225 Returns the last _n_ elements from the list.
7226 """
7227 last: Int
7228
7229 """
7230 Ordering options for organizations returned from the connection.
7231 """
7232 orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
7233
7234 """
7235 The search string to look for.
7236 """
7237 query: String
7238 ): OrganizationConnection!
7239
7240 """
7241 Enterprise information only visible to enterprise owners.
7242 """
7243 ownerInfo: EnterpriseOwnerInfo
7244
7245 """
7246 The HTTP path for this enterprise.
7247 """
7248 resourcePath: URI!
7249
7250 """
7251 The URL-friendly identifier for the enterprise.
7252 """
7253 slug: String!
7254
7255 """
7256 The HTTP URL for this enterprise.
7257 """
7258 url: URI!
7259
7260 """
7261 A list of user accounts on this enterprise.
7262 """
7263 userAccounts(
7264 """
7265 Returns the elements in the list that come after the specified cursor.
7266 """
7267 after: String
7268
7269 """
7270 Returns the elements in the list that come before the specified cursor.
7271 """
7272 before: String
7273
7274 """
7275 Returns the first _n_ elements from the list.
7276 """
7277 first: Int
7278
7279 """
7280 Returns the last _n_ elements from the list.
7281 """
7282 last: Int
7283 ): EnterpriseUserAccountConnection!
7284
7285 """
7286 Is the current viewer an admin of this enterprise?
7287 """
7288 viewerIsAdmin: Boolean!
7289
7290 """
7291 The URL of the enterprise website.
7292 """
7293 websiteUrl: URI
7294}
7295
7296"""
7297The connection type for User.
7298"""
7299type EnterpriseAdministratorConnection {
7300 """
7301 A list of edges.
7302 """
7303 edges: [EnterpriseAdministratorEdge]
7304
7305 """
7306 A list of nodes.
7307 """
7308 nodes: [User]
7309
7310 """
7311 Information to aid in pagination.
7312 """
7313 pageInfo: PageInfo!
7314
7315 """
7316 Identifies the total count of items in the connection.
7317 """
7318 totalCount: Int!
7319}
7320
7321"""
7322A User who is an administrator of an enterprise.
7323"""
7324type EnterpriseAdministratorEdge {
7325 """
7326 A cursor for use in pagination.
7327 """
7328 cursor: String!
7329
7330 """
7331 The item at the end of the edge.
7332 """
7333 node: User
7334
7335 """
7336 The role of the administrator.
7337 """
7338 role: EnterpriseAdministratorRole!
7339}
7340
7341"""
7342An invitation for a user to become an owner or billing manager of an enterprise.
7343"""
7344type EnterpriseAdministratorInvitation implements Node {
7345 """
7346 Identifies the date and time when the object was created.
7347 """
7348 createdAt: DateTime!
7349
7350 """
7351 The email of the person who was invited to the enterprise.
7352 """
7353 email: String
7354
7355 """
7356 The enterprise the invitation is for.
7357 """
7358 enterprise: Enterprise!
7359 id: ID!
7360
7361 """
7362 The user who was invited to the enterprise.
7363 """
7364 invitee: User
7365
7366 """
7367 The user who created the invitation.
7368 """
7369 inviter: User
7370
7371 """
7372 The invitee's pending role in the enterprise (owner or billing_manager).
7373 """
7374 role: EnterpriseAdministratorRole!
7375}
7376
7377"""
7378The connection type for EnterpriseAdministratorInvitation.
7379"""
7380type EnterpriseAdministratorInvitationConnection {
7381 """
7382 A list of edges.
7383 """
7384 edges: [EnterpriseAdministratorInvitationEdge]
7385
7386 """
7387 A list of nodes.
7388 """
7389 nodes: [EnterpriseAdministratorInvitation]
7390
7391 """
7392 Information to aid in pagination.
7393 """
7394 pageInfo: PageInfo!
7395
7396 """
7397 Identifies the total count of items in the connection.
7398 """
7399 totalCount: Int!
7400}
7401
7402"""
7403An edge in a connection.
7404"""
7405type EnterpriseAdministratorInvitationEdge {
7406 """
7407 A cursor for use in pagination.
7408 """
7409 cursor: String!
7410
7411 """
7412 The item at the end of the edge.
7413 """
7414 node: EnterpriseAdministratorInvitation
7415}
7416
7417"""
7418Ordering options for enterprise administrator invitation connections
7419"""
7420input EnterpriseAdministratorInvitationOrder {
7421 """
7422 The ordering direction.
7423 """
7424 direction: OrderDirection!
7425
7426 """
7427 The field to order enterprise administrator invitations by.
7428 """
7429 field: EnterpriseAdministratorInvitationOrderField!
7430}
7431
7432"""
7433Properties by which enterprise administrator invitation connections can be ordered.
7434"""
7435enum EnterpriseAdministratorInvitationOrderField {
7436 """
7437 Order enterprise administrator member invitations by creation time
7438 """
7439 CREATED_AT
7440}
7441
7442"""
7443The possible administrator roles in an enterprise account.
7444"""
7445enum EnterpriseAdministratorRole {
7446 """
7447 Represents a billing manager of the enterprise account.
7448 """
7449 BILLING_MANAGER
7450
7451 """
7452 Represents an owner of the enterprise account.
7453 """
7454 OWNER
7455}
7456
7457"""
7458Metadata for an audit entry containing enterprise account information.
7459"""
7460interface EnterpriseAuditEntryData {
7461 """
7462 The HTTP path for this enterprise.
7463 """
7464 enterpriseResourcePath: URI
7465
7466 """
7467 The slug of the enterprise.
7468 """
7469 enterpriseSlug: String
7470
7471 """
7472 The HTTP URL for this enterprise.
7473 """
7474 enterpriseUrl: URI
7475}
7476
7477"""
7478Enterprise billing information visible to enterprise billing managers and owners.