diff --git a/test/graphql-docs/fixtures/gh-schema.graphql b/test/graphql-docs/fixtures/gh-schema.graphql index 2d47bf1..0da8f0b 100644 --- a/test/graphql-docs/fixtures/gh-schema.graphql +++ b/test/graphql-docs/fixtures/gh-schema.graphql @@ -1,8643 +1,14196 @@ -# Marks an element of a GraphQL schema as only available via a preview header +""" +Marks an element of a GraphQL schema as only available via a preview header +""" directive @preview( - # The identifier of the API preview that toggles this field. + """ + The identifier of the API preview that toggles this field. + """ toggledBy: String -) on SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION +) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION -# Autogenerated input type of AcceptTopicSuggestion +""" +Autogenerated input type of AcceptTopicSuggestion +""" input AcceptTopicSuggestionInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of the suggested topic. + """ + The name of the suggested topic. + """ name: String! - # The Node ID of the repository. + """ + The Node ID of the repository. + """ repositoryId: ID! } -# Autogenerated return type of AcceptTopicSuggestion +""" +Autogenerated return type of AcceptTopicSuggestion +""" type AcceptTopicSuggestionPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The accepted topic. + """ + The accepted topic. + """ topic: Topic! } -# Represents an object which can take actions on GitHub. Typically a User or Bot. +""" +Represents an object which can take actions on GitHub. Typically a User or Bot. +""" interface Actor { - # A URL pointing to the actor's public avatar. + """ + A URL pointing to the actor's public avatar. + """ avatarUrl( - # The size of the resulting square image. + """ + The size of the resulting square image. + """ size: Int ): URI! - # The username of the actor. + """ + The username of the actor. + """ login: String! - # The HTTP path for this actor. + """ + The HTTP path for this actor. + """ resourcePath: URI! - # The HTTP URL for this actor. + """ + The HTTP URL for this actor. + """ url: URI! } -# Autogenerated input type of AddComment +""" +Autogenerated input type of AddComment +""" input AddCommentInput { - # The contents of the comment. + """ + The contents of the comment. + """ body: String! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the subject to modify. + """ + The Node ID of the subject to modify. + """ subjectId: ID! } -# Autogenerated return type of AddComment +""" +Autogenerated return type of AddComment +""" type AddCommentPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The edge from the subject's comment connection. + """ + The edge from the subject's comment connection. + """ commentEdge: IssueCommentEdge! - # The subject + """ + The subject + """ subject: Node! - # The edge from the subject's timeline connection. + """ + The edge from the subject's timeline connection. + """ timelineEdge: IssueTimelineItemEdge! } -# Autogenerated input type of AddProjectCard +""" +Autogenerated input type of AddProjectCard +""" input AddProjectCardInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The content of the card. Must be a member of the ProjectCardItem union + """ + The content of the card. Must be a member of the ProjectCardItem union + """ contentId: ID - # The note on the card. + """ + The note on the card. + """ note: String - # The Node ID of the ProjectColumn. + """ + The Node ID of the ProjectColumn. + """ projectColumnId: ID! } -# Autogenerated return type of AddProjectCard +""" +Autogenerated return type of AddProjectCard +""" type AddProjectCardPayload { - # The edge from the ProjectColumn's card connection. + """ + The edge from the ProjectColumn's card connection. + """ cardEdge: ProjectCardEdge! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The ProjectColumn + """ + The ProjectColumn + """ projectColumn: Project! } -# Autogenerated input type of AddProjectColumn +""" +Autogenerated input type of AddProjectColumn +""" input AddProjectColumnInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of the column. + """ + The name of the column. + """ name: String! - # The Node ID of the project. + """ + The Node ID of the project. + """ projectId: ID! } -# Autogenerated return type of AddProjectColumn +""" +Autogenerated return type of AddProjectColumn +""" type AddProjectColumnPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The edge from the project's column connection. + """ + The edge from the project's column connection. + """ columnEdge: ProjectColumnEdge! - # The project + """ + The project + """ project: Project! } -# Autogenerated input type of AddPullRequestReviewComment +""" +Autogenerated input type of AddPullRequestReviewComment +""" input AddPullRequestReviewCommentInput { - # The text of the comment. + """ + The text of the comment. + """ body: String! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The SHA of the commit to comment on. + """ + The SHA of the commit to comment on. + """ commitOID: GitObjectID - # The comment id to reply to. + """ + The comment id to reply to. + """ inReplyTo: ID - # The relative path of the file to comment on. + """ + The relative path of the file to comment on. + """ path: String - # The line index in the diff to comment on. + """ + The line index in the diff to comment on. + """ position: Int - # The Node ID of the review to modify. + """ + The Node ID of the review to modify. + """ pullRequestReviewId: ID! } -# Autogenerated return type of AddPullRequestReviewComment +""" +Autogenerated return type of AddPullRequestReviewComment +""" type AddPullRequestReviewCommentPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The newly created comment. + """ + The newly created comment. + """ comment: PullRequestReviewComment! - # The edge from the review's comment connection. + """ + The edge from the review's comment connection. + """ commentEdge: PullRequestReviewCommentEdge! } -# Autogenerated input type of AddPullRequestReview +""" +Autogenerated input type of AddPullRequestReview +""" input AddPullRequestReviewInput { - # The contents of the review body comment. + """ + The contents of the review body comment. + """ body: String - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The review line comments. + """ + The review line comments. + """ comments: [DraftPullRequestReviewComment] - # The commit OID the review pertains to. + """ + The commit OID the review pertains to. + """ commitOID: GitObjectID - # The event to perform on the pull request review. + """ + The event to perform on the pull request review. + """ event: PullRequestReviewEvent - # The Node ID of the pull request to modify. + """ + The Node ID of the pull request to modify. + """ pullRequestId: ID! } -# Autogenerated return type of AddPullRequestReview +""" +Autogenerated return type of AddPullRequestReview +""" type AddPullRequestReviewPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The newly created pull request review. + """ + The newly created pull request review. + """ pullRequestReview: PullRequestReview! - # The edge from the pull request's review connection. + """ + The edge from the pull request's review connection. + """ reviewEdge: PullRequestReviewEdge! } -# Autogenerated input type of AddReaction +""" +Autogenerated input type of AddReaction +""" input AddReactionInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of the emoji to react with. + """ + The name of the emoji to react with. + """ content: ReactionContent! - # The Node ID of the subject to modify. + """ + The Node ID of the subject to modify. + """ subjectId: ID! } -# Autogenerated return type of AddReaction +""" +Autogenerated return type of AddReaction +""" type AddReactionPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The reaction object. + """ + The reaction object. + """ reaction: Reaction! - # The reactable subject. + """ + The reactable subject. + """ subject: Reactable! } -# Autogenerated input type of AddStar +""" +Autogenerated input type of AddStar +""" input AddStarInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Starrable ID to star. + """ + The Starrable ID to star. + """ starrableId: ID! } -# Autogenerated return type of AddStar +""" +Autogenerated return type of AddStar +""" type AddStarPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The starrable. + """ + The starrable. + """ starrable: Starrable! } -# Represents a 'added_to_project' event on a given issue or pull request. +""" +Represents a 'added_to_project' event on a given issue or pull request. +""" type AddedToProjectEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# An object that can have users assigned to it. +""" +An object that can have users assigned to it. +""" interface Assignable { - # A list of Users assigned to this object. + """ + A list of Users assigned to this object. + """ assignees( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! } -# Represents an 'assigned' event on any assignable object. +""" +Represents an 'assigned' event on any assignable object. +""" type AssignedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the assignable associated with the event. + """ + Identifies the assignable associated with the event. + """ assignable: Assignable! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the user who was assigned. + """ + Identifies the user who was assigned. + """ user: User } -# Represents a 'base_ref_changed' event on a given issue or pull request. +""" +Represents a 'base_ref_changed' event on a given issue or pull request. +""" type BaseRefChangedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# Represents a 'base_ref_force_pushed' event on a given pull request. +""" +Represents a 'base_ref_force_pushed' event on a given pull request. +""" type BaseRefForcePushedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the after commit SHA for the 'base_ref_force_pushed' event. + """ + Identifies the after commit SHA for the 'base_ref_force_pushed' event. + """ afterCommit: Commit - # Identifies the before commit SHA for the 'base_ref_force_pushed' event. + """ + Identifies the before commit SHA for the 'base_ref_force_pushed' event. + """ beforeCommit: Commit - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # Identifies the fully qualified ref name for the 'base_ref_force_pushed' event. + """ + Identifies the fully qualified ref name for the 'base_ref_force_pushed' event. + """ ref: Ref } -# Represents a Git blame. +""" +Represents a Git blame. +""" type Blame { - # The list of ranges from a Git blame. + """ + The list of ranges from a Git blame. + """ ranges: [BlameRange!]! } -# Represents a range of information from a Git blame. +""" +Represents a range of information from a Git blame. +""" type BlameRange { - # Identifies the recency of the change, from 1 (new) to 10 (old). This is - # calculated as a 2-quantile and determines the length of distance between the - # median age of all the changes in the file and the recency of the current - # range's change. + """ + Identifies the recency of the change, from 1 (new) to 10 (old). This is + calculated as a 2-quantile and determines the length of distance between the + median age of all the changes in the file and the recency of the current + range's change. + """ age: Int! - # Identifies the line author + """ + Identifies the line author + """ commit: Commit! - # The ending line for the range + """ + The ending line for the range + """ endingLine: Int! - # The starting line for the range + """ + The starting line for the range + """ startingLine: Int! } -# Represents a Git blob. -type Blob implements GitObject, Node { - # An abbreviated version of the Git object ID +""" +Represents a Git blob. +""" +type Blob implements GitObject & Node { + """ + An abbreviated version of the Git object ID + """ abbreviatedOid: String! - # Byte size of Blob object + """ + Byte size of Blob object + """ byteSize: Int! - # The HTTP path for this Git object + """ + The HTTP path for this Git object + """ commitResourcePath: URI! - # The HTTP URL for this Git object + """ + The HTTP URL for this Git object + """ commitUrl: URI! id: ID! - # Indicates whether the Blob is binary or text + """ + Indicates whether the Blob is binary or text + """ isBinary: Boolean! - # Indicates whether the contents is truncated + """ + Indicates whether the contents is truncated + """ isTruncated: Boolean! - # The Git object ID + """ + The Git object ID + """ oid: GitObjectID! - # The Repository the Git object belongs to + """ + The Repository the Git object belongs to + """ repository: Repository! - # UTF8 text data or null if the Blob is binary + """ + UTF8 text data or null if the Blob is binary + """ text: String } -# A special type of user which takes actions on behalf of GitHub Apps. -type Bot implements Actor, Node, UniformResourceLocatable { - # A URL pointing to the GitHub App's public avatar. +""" +A special type of user which takes actions on behalf of GitHub Apps. +""" +type Bot implements Actor & Node & UniformResourceLocatable { + """ + A URL pointing to the GitHub App's public avatar. + """ avatarUrl( - # The size of the resulting square image. + """ + The size of the resulting square image. + """ size: Int ): URI! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # The username of the actor. + """ + The username of the actor. + """ login: String! - # The HTTP path for this bot + """ + The HTTP path for this bot + """ resourcePath: URI! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this bot + """ + The HTTP URL for this bot + """ url: URI! } -# An object that can be closed +""" +An object that can be closed +""" interface Closable { - # `true` if the object is closed (definition of closed may depend on type) + """ + `true` if the object is closed (definition of closed may depend on type) + """ closed: Boolean! - # Identifies the date and time when the object was closed. + """ + Identifies the date and time when the object was closed. + """ closedAt: DateTime } -# Represents a 'closed' event on any `Closable`. +""" +Represents a 'closed' event on any `Closable`. +""" type ClosedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Object that was closed. + """ + Object that was closed. + """ closable: Closable! - # Object which triggered the creation of this event. + """ + Object which triggered the creation of this event. + """ closer: Closer - # Identifies the commit associated with the 'closed' event. + """ + Identifies the commit associated with the 'closed' event. + """ commit: Commit @deprecated(reason: "`ClosedEvent` may be associated with other objects than a commit. Use ClosedEvent.closer instead. Removal on 2018-07-01 UTC.") - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! } -# The object which triggered a `ClosedEvent`. +""" +The object which triggered a `ClosedEvent`. +""" union Closer = Commit | PullRequest -# The Code of Conduct for a repository +""" +The Code of Conduct for a repository +""" type CodeOfConduct { - # The body of the CoC + """ + The body of the CoC + """ body: String - # The key for the CoC + """ + The key for the CoC + """ key: String! - # The formal name of the CoC + """ + The formal name of the CoC + """ name: String! - # The path to the CoC + """ + The path to the CoC + """ url: URI } -# Collaborators affiliation level with a repository. +""" +Collaborators affiliation level with a repository. +""" enum CollaboratorAffiliation { - # All collaborators the authenticated user can see. + """ + All collaborators the authenticated user can see. + """ ALL - # All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + """ + All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + """ DIRECT - # All outside collaborators of an organization-owned repository. + """ + All outside collaborators of an organization-owned repository. + """ OUTSIDE } -# Represents a comment. +""" +Represents a comment. +""" interface Comment { - # The actor who authored the comment. + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # The comment body as Markdown. + """ + The comment body as Markdown. + """ body: String! - # The comment body rendered to HTML. + """ + The comment body rendered to HTML. + """ bodyHTML: HTML! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# A comment author association with repository. +""" +A comment author association with repository. +""" enum CommentAuthorAssociation { - # Author has been invited to collaborate on the repository. + """ + Author has been invited to collaborate on the repository. + """ COLLABORATOR - # Author has previously committed to the repository. + """ + Author has previously committed to the repository. + """ CONTRIBUTOR - # Author has not previously committed to GitHub. + """ + Author has not previously committed to GitHub. + """ FIRST_TIMER - # Author has not previously committed to the repository. + """ + Author has not previously committed to the repository. + """ FIRST_TIME_CONTRIBUTOR - # Author is a member of the organization that owns the repository. + """ + Author is a member of the organization that owns the repository. + """ MEMBER - # Author has no association with the repository. + """ + Author has no association with the repository. + """ NONE - # Author is the owner of the repository. + """ + Author is the owner of the repository. + """ OWNER } -# The possible errors that will prevent a user from updating a comment. +""" +The possible errors that will prevent a user from updating a comment. +""" enum CommentCannotUpdateReason { - # You must be the author or have write access to this repository to update this comment. + """ + You must be the author or have write access to this repository to update this comment. + """ INSUFFICIENT_ACCESS - # Unable to create comment because issue is locked. + """ + Unable to create comment because issue is locked. + """ LOCKED - # You must be logged in to update this comment. + """ + You must be logged in to update this comment. + """ LOGIN_REQUIRED - # Repository is under maintenance. + """ + Repository is under maintenance. + """ MAINTENANCE - # At least one email address must be verified to update this comment. + """ + At least one email address must be verified to update this comment. + """ VERIFIED_EMAIL_REQUIRED } -# Represents a 'comment_deleted' event on a given issue or pull request. +""" +Represents a 'comment_deleted' event on a given issue or pull request. +""" type CommentDeletedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# Represents a Git commit. -type Commit implements GitObject, Node, Subscribable { - # An abbreviated version of the Git object ID +""" +Represents a Git commit. +""" +type Commit implements GitObject & Node & Subscribable { + """ + An abbreviated version of the Git object ID + """ abbreviatedOid: String! - # The number of additions in this commit. + """ + The number of additions in this commit. + """ additions: Int! - # Authorship details of the commit. + """ + Authorship details of the commit. + """ author: GitActor - # Check if the committer and the author match. + """ + Check if the committer and the author match. + """ authoredByCommitter: Boolean! - # The datetime when this commit was authored. + """ + The datetime when this commit was authored. + """ authoredDate: DateTime! - # Fetches `git blame` information. + """ + Fetches `git blame` information. + """ blame( - # The file whose Git blame information you want. + """ + The file whose Git blame information you want. + """ path: String! ): Blame! - # The number of changed files in this commit. + """ + The number of changed files in this commit. + """ changedFiles: Int! - # Comments made on the commit. + """ + Comments made on the commit. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): CommitCommentConnection! - # The HTTP path for this Git object + """ + The HTTP path for this Git object + """ commitResourcePath: URI! - # The HTTP URL for this Git object + """ + The HTTP URL for this Git object + """ commitUrl: URI! - # The datetime when this commit was committed. + """ + The datetime when this commit was committed. + """ committedDate: DateTime! - # Check if commited via GitHub web UI. + """ + Check if commited via GitHub web UI. + """ committedViaWeb: Boolean! - # Committership details of the commit. + """ + Committership details of the commit. + """ committer: GitActor - # The number of deletions in this commit. + """ + The number of deletions in this commit. + """ deletions: Int! - # The linear commit history starting from (and including) this commit, in the same order as `git log`. + """ + The linear commit history starting from (and including) this commit, in the same order as `git log`. + """ history( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # If non-null, filters history to only show commits with matching authorship. + """ + If non-null, filters history to only show commits with matching authorship. + """ author: CommitAuthor - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # If non-null, filters history to only show commits touching files under this path. + """ + If non-null, filters history to only show commits touching files under this path. + """ path: String - # Allows specifying a beginning time or date for fetching commits. + """ + Allows specifying a beginning time or date for fetching commits. + """ since: GitTimestamp - # Allows specifying an ending time or date for fetching commits. + """ + Allows specifying an ending time or date for fetching commits. + """ until: GitTimestamp ): CommitHistoryConnection! id: ID! - # The Git commit message + """ + The Git commit message + """ message: String! - # The Git commit message body + """ + The Git commit message body + """ messageBody: String! - # The commit message body rendered to HTML. + """ + The commit message body rendered to HTML. + """ messageBodyHTML: HTML! - # The Git commit message headline + """ + The Git commit message headline + """ messageHeadline: String! - # The commit message headline rendered to HTML. + """ + The commit message headline rendered to HTML. + """ messageHeadlineHTML: HTML! - # The Git object ID + """ + The Git object ID + """ oid: GitObjectID! - # The parents of a commit. + """ + The parents of a commit. + """ parents( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): CommitConnection! - # The datetime when this commit was pushed. + """ + The datetime when this commit was pushed. + """ pushedDate: DateTime - # The Repository this commit belongs to + """ + The Repository this commit belongs to + """ repository: Repository! - # The HTTP path for this commit + """ + The HTTP path for this commit + """ resourcePath: URI! - # Commit signing information, if present. + """ + Commit signing information, if present. + """ signature: GitSignature - # Status information for this commit + """ + Status information for this commit + """ status: Status - # Returns a URL to download a tarball archive for a repository. - # Note: For private repositories, these links are temporary and expire after five minutes. + """ + Returns a URL to download a tarball archive for a repository. + Note: For private repositories, these links are temporary and expire after five minutes. + """ tarballUrl: URI! - # Commit's root Tree + """ + Commit's root Tree + """ tree: Tree! - # The HTTP path for the tree of this commit + """ + The HTTP path for the tree of this commit + """ treeResourcePath: URI! - # The HTTP URL for the tree of this commit + """ + The HTTP URL for the tree of this commit + """ treeUrl: URI! - # The HTTP URL for this commit + """ + The HTTP URL for this commit + """ url: URI! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! - # Returns a URL to download a zipball archive for a repository. - # Note: For private repositories, these links are temporary and expire after five minutes. + """ + Returns a URL to download a zipball archive for a repository. + Note: For private repositories, these links are temporary and expire after five minutes. + """ zipballUrl: URI! } -# Specifies an author for filtering Git commits. +""" +Specifies an author for filtering Git commits. +""" input CommitAuthor { - # Email addresses to filter by. Commits authored by any of the specified email addresses will be returned. + """ + Email addresses to filter by. Commits authored by any of the specified email addresses will be returned. + """ emails: [String!] - # ID of a User to filter by. If non-null, only commits authored by this user - # will be returned. This field takes precedence over emails. + """ + ID of a User to filter by. If non-null, only commits authored by this user + will be returned. This field takes precedence over emails. + """ id: ID } -# Represents a comment on a given Commit. -type CommitComment implements Comment, Deletable, Node, Reactable, RepositoryNode, Updatable, UpdatableComment { - # The actor who authored the comment. +""" +Represents a comment on a given Commit. +""" +type CommitComment implements Comment & Deletable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # Identifies the comment body. + """ + Identifies the comment body. + """ body: String! - # Identifies the comment body rendered to HTML. + """ + Identifies the comment body rendered to HTML. + """ bodyHTML: HTML! - # Identifies the commit associated with the comment, if the commit exists. + """ + Identifies the commit associated with the comment, if the commit exists. + """ commit: Commit - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies the file path associated with the comment. + """ + Identifies the file path associated with the comment. + """ path: String - # Identifies the line position associated with the comment. + """ + Identifies the line position associated with the comment. + """ position: Int - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! - # The HTTP path permalink for this commit comment. + """ + The HTTP path permalink for this commit comment. + """ resourcePath: URI! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL permalink for this commit comment. + """ + The HTTP URL permalink for this commit comment. + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# The connection type for CommitComment. +""" +The connection type for CommitComment. +""" type CommitCommentConnection { - # A list of edges. + """ + A list of edges. + """ edges: [CommitCommentEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [CommitComment] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type CommitCommentEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: CommitComment } -# A thread of comments on a commit. -type CommitCommentThread implements Node, RepositoryNode { - # The comments that exist in this thread. +""" +A thread of comments on a commit. +""" +type CommitCommentThread implements Node & RepositoryNode { + """ + The comments that exist in this thread. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): CommitCommentConnection! - # The commit the comments were made on. + """ + The commit the comments were made on. + """ commit: Commit! id: ID! - # The file the comments were made on. + """ + The file the comments were made on. + """ path: String - # The position in the diff for the commit that the comment was made on. + """ + The position in the diff for the commit that the comment was made on. + """ position: Int - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! } -# The connection type for Commit. +""" +The connection type for Commit. +""" type CommitConnection { - # A list of edges. + """ + A list of edges. + """ edges: [CommitEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Commit] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type CommitEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Commit } -# The connection type for Commit. +""" +The connection type for Commit. +""" type CommitHistoryConnection { edges: [CommitEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Commit] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a 'converted_note_to_issue' event on a given issue or pull request. +""" +Represents a 'converted_note_to_issue' event on a given issue or pull request. +""" type ConvertedNoteToIssueEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# Autogenerated input type of CreateProject +""" +Autogenerated input type of CreateProject +""" input CreateProjectInput { - # The description of project. + """ + The description of project. + """ body: String - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of project. + """ + The name of project. + """ name: String! - # The owner ID to create the project under. + """ + The owner ID to create the project under. + """ ownerId: ID! } -# Autogenerated return type of CreateProject +""" +Autogenerated return type of CreateProject +""" type CreateProjectPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The new project. + """ + The new project. + """ project: Project! } -# Autogenerated input type of CreateTeamDiscussionComment +""" +Autogenerated input type of CreateTeamDiscussionComment +""" input CreateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") { - # The content of the comment. + """ + The content of the comment. + """ body: String! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The ID of the discussion to which the comment belongs. + """ + The ID of the discussion to which the comment belongs. + """ discussionId: ID! } -# Autogenerated return type of CreateTeamDiscussionComment +""" +Autogenerated return type of CreateTeamDiscussionComment +""" type CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The new comment. + """ + The new comment. + """ teamDiscussionComment: TeamDiscussionComment } -# Autogenerated input type of CreateTeamDiscussion +""" +Autogenerated input type of CreateTeamDiscussion +""" input CreateTeamDiscussionInput @preview(toggledBy: "echo-preview") { - # The content of the discussion. + """ + The content of the discussion. + """ body: String! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # If true, restricts the visiblity of this discussion to team members and - # organization admins. If false or not specified, allows any organization member - # to view this discussion. + """ + If true, restricts the visiblity of this discussion to team members and + organization admins. If false or not specified, allows any organization member + to view this discussion. + """ private: Boolean - # The ID of the team to which the discussion belongs. + """ + The ID of the team to which the discussion belongs. + """ teamId: ID! - # The title of the discussion. + """ + The title of the discussion. + """ title: String! } -# Autogenerated return type of CreateTeamDiscussion +""" +Autogenerated return type of CreateTeamDiscussion +""" type CreateTeamDiscussionPayload @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The new discussion. + """ + The new discussion. + """ teamDiscussion: TeamDiscussion } -# Represents a mention made by one issue or pull request to another. -type CrossReferencedEvent implements Node, UniformResourceLocatable { - # Identifies the actor who performed the event. +""" +Represents a mention made by one issue or pull request to another. +""" +type CrossReferencedEvent implements Node & UniformResourceLocatable { + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Reference originated in a different repository. + """ + Reference originated in a different repository. + """ isCrossRepository: Boolean! - # Identifies when the reference was made. + """ + Identifies when the reference was made. + """ referencedAt: DateTime! - # The HTTP path for this pull request. + """ + The HTTP path for this pull request. + """ resourcePath: URI! - # Issue or pull request that made the reference. + """ + Issue or pull request that made the reference. + """ source: ReferencedSubject! - # Issue or pull request to which the reference was made. + """ + Issue or pull request to which the reference was made. + """ target: ReferencedSubject! - # The HTTP URL for this pull request. + """ + The HTTP URL for this pull request. + """ url: URI! - # Checks if the target will be closed when the source is merged. + """ + Checks if the target will be closed when the source is merged. + """ willCloseTarget: Boolean! } -# An ISO-8601 encoded date string. -scalar Date - -# An ISO-8601 encoded UTC date string. +""" +An ISO-8601 encoded UTC date string. +""" scalar DateTime -# Autogenerated input type of DeclineTopicSuggestion +""" +Autogenerated input type of DeclineTopicSuggestion +""" input DeclineTopicSuggestionInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of the suggested topic. + """ + The name of the suggested topic. + """ name: String! - # The reason why the suggested topic is declined. + """ + The reason why the suggested topic is declined. + """ reason: TopicSuggestionDeclineReason! - # The Node ID of the repository. + """ + The Node ID of the repository. + """ repositoryId: ID! } -# Autogenerated return type of DeclineTopicSuggestion +""" +Autogenerated return type of DeclineTopicSuggestion +""" type DeclineTopicSuggestionPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The declined topic. + """ + The declined topic. + """ topic: Topic! } -# The possible default permissions for organization-owned repositories. -enum DefaultRepositoryPermissionField { - # Members have read, write, and admin access to org repos by default - ADMIN - - # Members have read access to org repos by default - READ - - # Members have read and write access to org repos by default - WRITE -} - -# Entities that can be deleted. +""" +Entities that can be deleted. +""" interface Deletable { - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! } -# Autogenerated input type of DeleteProjectCard +""" +Autogenerated input type of DeleteProjectCard +""" input DeleteProjectCardInput { - # The id of the card to delete. + """ + The id of the card to delete. + """ cardId: ID! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String } -# Autogenerated return type of DeleteProjectCard +""" +Autogenerated return type of DeleteProjectCard +""" type DeleteProjectCardPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The column the deleted card was in. + """ + The column the deleted card was in. + """ column: ProjectColumn! - # The deleted card ID. + """ + The deleted card ID. + """ deletedCardId: ID! } -# Autogenerated input type of DeleteProjectColumn +""" +Autogenerated input type of DeleteProjectColumn +""" input DeleteProjectColumnInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The id of the column to delete. + """ + The id of the column to delete. + """ columnId: ID! } -# Autogenerated return type of DeleteProjectColumn +""" +Autogenerated return type of DeleteProjectColumn +""" type DeleteProjectColumnPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The deleted column ID. + """ + The deleted column ID. + """ deletedColumnId: ID! - # The project the deleted column was in. + """ + The project the deleted column was in. + """ project: Project! } -# Autogenerated input type of DeleteProject +""" +Autogenerated input type of DeleteProject +""" input DeleteProjectInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Project ID to update. + """ + The Project ID to update. + """ projectId: ID! } -# Autogenerated return type of DeleteProject +""" +Autogenerated return type of DeleteProject +""" type DeleteProjectPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The repository or organization the project was removed from. + """ + The repository or organization the project was removed from. + """ owner: ProjectOwner! } -# Autogenerated input type of DeletePullRequestReview +""" +Autogenerated input type of DeletePullRequestReview +""" input DeletePullRequestReviewInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the pull request review to delete. + """ + The Node ID of the pull request review to delete. + """ pullRequestReviewId: ID! } -# Autogenerated return type of DeletePullRequestReview +""" +Autogenerated return type of DeletePullRequestReview +""" type DeletePullRequestReviewPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The deleted pull request review. + """ + The deleted pull request review. + """ pullRequestReview: PullRequestReview! } -# Autogenerated input type of DeleteTeamDiscussionComment +""" +Autogenerated input type of DeleteTeamDiscussionComment +""" input DeleteTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The ID of the comment to delete. + """ + The ID of the comment to delete. + """ id: ID! } -# Autogenerated return type of DeleteTeamDiscussionComment +""" +Autogenerated return type of DeleteTeamDiscussionComment +""" type DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String } -# Autogenerated input type of DeleteTeamDiscussion +""" +Autogenerated input type of DeleteTeamDiscussion +""" input DeleteTeamDiscussionInput @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The discussion ID to delete. + """ + The discussion ID to delete. + """ id: ID! } -# Autogenerated return type of DeleteTeamDiscussion +""" +Autogenerated return type of DeleteTeamDiscussion +""" type DeleteTeamDiscussionPayload @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String } -# Represents a 'demilestoned' event on a given issue or pull request. +""" +Represents a 'demilestoned' event on a given issue or pull request. +""" type DemilestonedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the milestone title associated with the 'demilestoned' event. + """ + Identifies the milestone title associated with the 'demilestoned' event. + """ milestoneTitle: String! - # Object referenced by event. + """ + Object referenced by event. + """ subject: MilestoneItem! } -# A repository deploy key. +""" +A repository deploy key. +""" type DeployKey implements Node { - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # The deploy key. + """ + The deploy key. + """ key: String! - # Whether or not the deploy key is read only. + """ + Whether or not the deploy key is read only. + """ readOnly: Boolean! - # The deploy key title. + """ + The deploy key title. + """ title: String! - # Whether or not the deploy key has been verified. + """ + Whether or not the deploy key has been verified. + """ verified: Boolean! } -# The connection type for DeployKey. +""" +The connection type for DeployKey. +""" type DeployKeyConnection { - # A list of edges. + """ + A list of edges. + """ edges: [DeployKeyEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [DeployKey] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type DeployKeyEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: DeployKey } -# Represents a 'deployed' event on a given pull request. +""" +Represents a 'deployed' event on a given pull request. +""" type DeployedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The deployment associated with the 'deployed' event. + """ + The deployment associated with the 'deployed' event. + """ deployment: Deployment! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # The ref associated with the 'deployed' event. + """ + The ref associated with the 'deployed' event. + """ ref: Ref } -# Represents triggered deployment instance. +""" +Represents triggered deployment instance. +""" type Deployment implements Node { - # Identifies the commit sha of the deployment. + """ + Identifies the commit sha of the deployment. + """ commit: Commit - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the actor who triggered the deployment. + """ + Identifies the actor who triggered the deployment. + """ creator: Actor - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The environment to which this deployment was made. + """ + The environment to which this deployment was made. + """ environment: String id: ID! - # The latest status of this deployment. + """ + The latest status of this deployment. + """ latestStatus: DeploymentStatus - # Extra information that a deployment system might need. + """ + Extra information that a deployment system might need. + """ payload: String - # Identifies the repository associated with the deployment. + """ + Identifies the repository associated with the deployment. + """ repository: Repository! - # The current state of the deployment. + """ + The current state of the deployment. + """ state: DeploymentState - # A list of statuses associated with the deployment. + """ + A list of statuses associated with the deployment. + """ statuses( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): DeploymentStatusConnection } -# The connection type for Deployment. +""" +The connection type for Deployment. +""" type DeploymentConnection { - # A list of edges. + """ + A list of edges. + """ edges: [DeploymentEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Deployment] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type DeploymentEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Deployment } -# The possible states in which a deployment can be. +""" +The possible states in which a deployment can be. +""" enum DeploymentState { - # The pending deployment was not updated after 30 minutes. + """ + The pending deployment was not updated after 30 minutes. + """ ABANDONED - # The deployment is currently active. + """ + The deployment is currently active. + """ ACTIVE - # An inactive transient deployment. + """ + An inactive transient deployment. + """ DESTROYED - # The deployment experienced an error. + """ + The deployment experienced an error. + """ ERROR - # The deployment has failed. + """ + The deployment has failed. + """ FAILURE - # The deployment is inactive. + """ + The deployment is inactive. + """ INACTIVE - # The deployment is pending. + """ + The deployment is pending. + """ PENDING } -# Describes the status of a given deployment attempt. +""" +Describes the status of a given deployment attempt. +""" type DeploymentStatus implements Node { - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the actor who triggered the deployment. + """ + Identifies the actor who triggered the deployment. + """ creator: Actor - # Identifies the deployment associated with status. + """ + Identifies the deployment associated with status. + """ deployment: Deployment! - # Identifies the description of the deployment. + """ + Identifies the description of the deployment. + """ description: String - # Identifies the environment URL of the deployment. + """ + Identifies the environment URL of the deployment. + """ environmentUrl: URI id: ID! - # Identifies the log URL of the deployment. + """ + Identifies the log URL of the deployment. + """ logUrl: URI - # Identifies the current state of the deployment. + """ + Identifies the current state of the deployment. + """ state: DeploymentStatusState! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") } -# The connection type for DeploymentStatus. +""" +The connection type for DeploymentStatus. +""" type DeploymentStatusConnection { - # A list of edges. + """ + A list of edges. + """ edges: [DeploymentStatusEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [DeploymentStatus] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type DeploymentStatusEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: DeploymentStatus } -# The possible states for a deployment status. +""" +The possible states for a deployment status. +""" enum DeploymentStatusState { - # The deployment experienced an error. + """ + The deployment experienced an error. + """ ERROR - # The deployment has failed. + """ + The deployment has failed. + """ FAILURE - # The deployment is inactive. + """ + The deployment is inactive. + """ INACTIVE - # The deployment is pending. + """ + The deployment is pending. + """ PENDING - # The deployment was successful. + """ + The deployment was successful. + """ SUCCESS } -# Autogenerated input type of DismissPullRequestReview +""" +Autogenerated input type of DismissPullRequestReview +""" input DismissPullRequestReviewInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The contents of the pull request review dismissal message. + """ + The contents of the pull request review dismissal message. + """ message: String! - # The Node ID of the pull request review to modify. + """ + The Node ID of the pull request review to modify. + """ pullRequestReviewId: ID! } -# Autogenerated return type of DismissPullRequestReview +""" +Autogenerated return type of DismissPullRequestReview +""" type DismissPullRequestReviewPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The dismissed pull request review. + """ + The dismissed pull request review. + """ pullRequestReview: PullRequestReview! } -# Specifies a review comment to be left with a Pull Request Review. +""" +Specifies a review comment to be left with a Pull Request Review. +""" input DraftPullRequestReviewComment { - # Body of the comment to leave. + """ + Body of the comment to leave. + """ body: String! - # Path to the file being commented on. + """ + Path to the file being commented on. + """ path: String! - # Position in the file to leave a comment on. + """ + Position in the file to leave a comment on. + """ position: Int! } -# An external identity provisioned by SAML SSO or SCIM. +""" +An external identity provisioned by SAML SSO or SCIM. +""" type ExternalIdentity implements Node { - # The GUID for this identity + """ + The GUID for this identity + """ guid: String! id: ID! - # Organization invitation for this SCIM-provisioned external identity + """ + Organization invitation for this SCIM-provisioned external identity + """ organizationInvitation: OrganizationInvitation - # SAML Identity attributes + """ + SAML Identity attributes + """ samlIdentity: ExternalIdentitySamlAttributes - # SCIM Identity attributes + """ + SCIM Identity attributes + """ scimIdentity: ExternalIdentityScimAttributes - # User linked to this external identity + """ + User linked to this external identity + """ user: User } -# The connection type for ExternalIdentity. +""" +The connection type for ExternalIdentity. +""" type ExternalIdentityConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ExternalIdentityEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ExternalIdentity] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ExternalIdentityEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ExternalIdentity } -# SAML attributes for the External Identity +""" +SAML attributes for the External Identity +""" type ExternalIdentitySamlAttributes { - # The NameID of the SAML identity + """ + The NameID of the SAML identity + """ nameId: String } -# SCIM attributes for the External Identity +""" +SCIM attributes for the External Identity +""" type ExternalIdentityScimAttributes { - # The userName of the SCIM identity + """ + The userName of the SCIM identity + """ username: String } -# The connection type for User. +""" +The connection type for User. +""" type FollowerConnection { - # A list of edges. + """ + A list of edges. + """ edges: [UserEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# The connection type for User. +""" +The connection type for User. +""" type FollowingConnection { - # A list of edges. + """ + A list of edges. + """ edges: [UserEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# A Gist. -type Gist implements Node, Starrable { - # A list of comments associated with the gist +""" +A Gist. +""" +type Gist implements Node & Starrable { + """ + A list of comments associated with the gist + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): GistCommentConnection! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The gist description. + """ + The gist description. + """ description: String id: ID! - # Whether the gist is public or not. + """ + Whether the gist is public or not. + """ isPublic: Boolean! - # The gist name. + """ + The gist name. + """ name: String! - # The gist owner. + """ + The gist owner. + """ owner: RepositoryOwner - # Identifies when the gist was last pushed to. + """ + Identifies when the gist was last pushed to. + """ pushedAt: DateTime - # A list of users who have starred this starrable. + """ + A list of users who have starred this starrable. + """ stargazers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: StarOrder ): StargazerConnection! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # Returns a boolean indicating whether the viewing user has starred this starrable. + """ + Returns a boolean indicating whether the viewing user has starred this starrable. + """ viewerHasStarred: Boolean! } -# Represents a comment on an Gist. -type GistComment implements Comment, Deletable, Node, Updatable, UpdatableComment { - # The actor who authored the comment. +""" +Represents a comment on an Gist. +""" +type GistComment implements Comment & Deletable & Node & Updatable & UpdatableComment { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the gist. + """ + Author's association with the gist. + """ authorAssociation: CommentAuthorAssociation! - # Identifies the comment body. + """ + Identifies the comment body. + """ body: String! - # The comment body rendered to HTML. + """ + The comment body rendered to HTML. + """ bodyHTML: HTML! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor - # The associated gist. + """ + The associated gist. + """ gist: Gist! id: ID! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# The connection type for GistComment. +""" +The connection type for GistComment. +""" type GistCommentConnection { - # A list of edges. + """ + A list of edges. + """ edges: [GistCommentEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [GistComment] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type GistCommentEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: GistComment } -# The connection type for Gist. +""" +The connection type for Gist. +""" type GistConnection { - # A list of edges. + """ + A list of edges. + """ edges: [GistEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Gist] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type GistEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Gist } -# Ordering options for gist connections +""" +Ordering options for gist connections +""" input GistOrder { - # The ordering direction. + """ + The ordering direction. + """ direction: OrderDirection! - # The field to order repositories by. + """ + The field to order repositories by. + """ field: GistOrderField! } -# Properties by which gist connections can be ordered. +""" +Properties by which gist connections can be ordered. +""" enum GistOrderField { - # Order gists by creation time + """ + Order gists by creation time + """ CREATED_AT - # Order gists by push time + """ + Order gists by push time + """ PUSHED_AT - # Order gists by update time + """ + Order gists by update time + """ UPDATED_AT } -# The privacy of a Gist +""" +The privacy of a Gist +""" enum GistPrivacy { - # Gists that are public and secret + """ + Gists that are public and secret + """ ALL - # Public + """ + Public + """ PUBLIC - # Secret + """ + Secret + """ SECRET } -# Represents an actor in a Git commit (ie. an author or committer). +""" +Represents an actor in a Git commit (ie. an author or committer). +""" type GitActor { - # A URL pointing to the author's public avatar. + """ + A URL pointing to the author's public avatar. + """ avatarUrl( - # The size of the resulting square image. + """ + The size of the resulting square image. + """ size: Int ): URI! - # The timestamp of the Git action (authoring or committing). + """ + The timestamp of the Git action (authoring or committing). + """ date: GitTimestamp - # The email in the Git commit. + """ + The email in the Git commit. + """ email: String - # The name in the Git commit. + """ + The name in the Git commit. + """ name: String - # The GitHub user corresponding to the email field. Null if no such user exists. + """ + The GitHub user corresponding to the email field. Null if no such user exists. + """ user: User } -# Represents information about the GitHub instance. +""" +Represents information about the GitHub instance. +""" type GitHubMetadata { - # Returns a String that's a SHA of `github-services` + """ + Returns a String that's a SHA of `github-services` + """ gitHubServicesSha: String! - # Whether or not users are verified + """ + Whether or not users are verified + """ isPasswordAuthenticationVerifiable: Boolean! } -# Represents a Git object. +""" +Represents a Git object. +""" interface GitObject { - # An abbreviated version of the Git object ID + """ + An abbreviated version of the Git object ID + """ abbreviatedOid: String! - # The HTTP path for this Git object + """ + The HTTP path for this Git object + """ commitResourcePath: URI! - # The HTTP URL for this Git object + """ + The HTTP URL for this Git object + """ commitUrl: URI! id: ID! - # The Git object ID + """ + The Git object ID + """ oid: GitObjectID! - # The Repository the Git object belongs to + """ + The Repository the Git object belongs to + """ repository: Repository! } -# A Git object ID. +""" +A Git object ID. +""" scalar GitObjectID -# Git SSH string +""" +Git SSH string +""" scalar GitSSHRemote -# Information about a signature (GPG or S/MIME) on a Commit or Tag. +""" +Information about a signature (GPG or S/MIME) on a Commit or Tag. +""" interface GitSignature { - # Email used to sign this object. + """ + Email used to sign this object. + """ email: String! - # True if the signature is valid and verified by GitHub. + """ + True if the signature is valid and verified by GitHub. + """ isValid: Boolean! - # Payload for GPG signing object. Raw ODB object without the signature header. + """ + Payload for GPG signing object. Raw ODB object without the signature header. + """ payload: String! - # ASCII-armored signature header from object. + """ + ASCII-armored signature header from object. + """ signature: String! - # GitHub user corresponding to the email signing this commit. + """ + GitHub user corresponding to the email signing this commit. + """ signer: User - # The state of this signature. `VALID` if signature is valid and verified by - # GitHub, otherwise represents reason why signature is considered invalid. + """ + The state of this signature. `VALID` if signature is valid and verified by + GitHub, otherwise represents reason why signature is considered invalid. + """ state: GitSignatureState! } -# The state of a Git signature. +""" +The state of a Git signature. +""" enum GitSignatureState { - # Invalid email used for signing. + """ + Invalid email used for signing. + """ BAD_EMAIL - # Signing key expired. + """ + Signing key expired. + """ EXPIRED_KEY - # Internal error - the GPG verification service misbehaved. + """ + Internal error - the GPG verification service misbehaved. + """ GPGVERIFY_ERROR - # Internal error - the GPG verification service is unavailable at the moment. + """ + Internal error - the GPG verification service is unavailable at the moment. + """ GPGVERIFY_UNAVAILABLE - # Invalid signature. + """ + Invalid signature. + """ INVALID - # Malformed signature. + """ + Malformed signature. + """ MALFORMED_SIG - # The usage flags for the key that signed this don't allow signing. + """ + The usage flags for the key that signed this don't allow signing. + """ NOT_SIGNING_KEY - # Email used for signing not known to GitHub. + """ + Email used for signing not known to GitHub. + """ NO_USER - # Key used for signing not known to GitHub. + """ + Key used for signing not known to GitHub. + """ UNKNOWN_KEY - # Unknown signature type. + """ + Unknown signature type. + """ UNKNOWN_SIG_TYPE - # Unsigned. + """ + Unsigned. + """ UNSIGNED - # Email used for signing unverified on GitHub. + """ + Email used for signing unverified on GitHub. + """ UNVERIFIED_EMAIL - # Valid signature and verified by GitHub. + """ + Valid signature and verified by GitHub. + """ VALID } -# An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC. +""" +An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC. +""" scalar GitTimestamp -# Represents a GPG signature on a Commit or Tag. +""" +Represents a GPG signature on a Commit or Tag. +""" type GpgSignature implements GitSignature { - # Email used to sign this object. + """ + Email used to sign this object. + """ email: String! - # True if the signature is valid and verified by GitHub. + """ + True if the signature is valid and verified by GitHub. + """ isValid: Boolean! - # Hex-encoded ID of the key that signed this object. + """ + Hex-encoded ID of the key that signed this object. + """ keyId: String - # Payload for GPG signing object. Raw ODB object without the signature header. + """ + Payload for GPG signing object. Raw ODB object without the signature header. + """ payload: String! - # ASCII-armored signature header from object. + """ + ASCII-armored signature header from object. + """ signature: String! - # GitHub user corresponding to the email signing this commit. + """ + GitHub user corresponding to the email signing this commit. + """ signer: User - # The state of this signature. `VALID` if signature is valid and verified by - # GitHub, otherwise represents reason why signature is considered invalid. + """ + The state of this signature. `VALID` if signature is valid and verified by + GitHub, otherwise represents reason why signature is considered invalid. + """ state: GitSignatureState! } -# A string containing HTML code. +""" +A string containing HTML code. +""" scalar HTML -# Represents a 'head_ref_deleted' event on a given pull request. +""" +Represents a 'head_ref_deleted' event on a given pull request. +""" type HeadRefDeletedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the Ref associated with the `head_ref_deleted` event. + """ + Identifies the Ref associated with the `head_ref_deleted` event. + """ headRef: Ref - # Identifies the name of the Ref associated with the `head_ref_deleted` event. + """ + Identifies the name of the Ref associated with the `head_ref_deleted` event. + """ headRefName: String! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! } -# Represents a 'head_ref_force_pushed' event on a given pull request. +""" +Represents a 'head_ref_force_pushed' event on a given pull request. +""" type HeadRefForcePushedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the after commit SHA for the 'head_ref_force_pushed' event. + """ + Identifies the after commit SHA for the 'head_ref_force_pushed' event. + """ afterCommit: Commit - # Identifies the before commit SHA for the 'head_ref_force_pushed' event. + """ + Identifies the before commit SHA for the 'head_ref_force_pushed' event. + """ beforeCommit: Commit - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # Identifies the fully qualified ref name for the 'head_ref_force_pushed' event. + """ + Identifies the fully qualified ref name for the 'head_ref_force_pushed' event. + """ ref: Ref } -# Represents a 'head_ref_restored' event on a given pull request. +""" +Represents a 'head_ref_restored' event on a given pull request. +""" type HeadRefRestoredEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! } -# An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. -type Issue implements Assignable, Closable, Comment, Labelable, Lockable, Node, Reactable, RepositoryNode, Subscribable, UniformResourceLocatable, Updatable, UpdatableComment { - # Reason that the conversation was locked. +""" +An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. +""" +type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment { + """ + Reason that the conversation was locked. + """ activeLockReason: LockReason - # A list of Users assigned to this object. + """ + A list of Users assigned to this object. + """ assignees( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # The actor who authored the comment. + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # Identifies the body of the issue. + """ + Identifies the body of the issue. + """ body: String! - # Identifies the body of the issue rendered to HTML. + """ + Identifies the body of the issue rendered to HTML. + """ bodyHTML: HTML! - # Identifies the body of the issue rendered to text. + """ + Identifies the body of the issue rendered to text. + """ bodyText: String! - # `true` if the object is closed (definition of closed may depend on type) + """ + `true` if the object is closed (definition of closed may depend on type) + """ closed: Boolean! - # Identifies the date and time when the object was closed. + """ + Identifies the date and time when the object was closed. + """ closedAt: DateTime - # A list of comments associated with the Issue. + """ + A list of comments associated with the Issue. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): IssueCommentConnection! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # A list of labels associated with the object. + """ + A list of labels associated with the object. + """ labels( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): LabelConnection - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # `true` if the object is locked + """ + `true` if the object is locked + """ locked: Boolean! - # Identifies the milestone associated with the issue. + """ + Identifies the milestone associated with the issue. + """ milestone: Milestone - # Identifies the issue number. + """ + Identifies the issue number. + """ number: Int! - # A list of Users that are participating in the Issue conversation. + """ + A list of Users that are participating in the Issue conversation. + """ participants( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # List of project cards associated with this issue. + """ + List of project cards associated with this issue. + """ projectCards( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ProjectCardConnection! - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! - # The HTTP path for this issue + """ + The HTTP path for this issue + """ resourcePath: URI! - # Identifies the state of the issue. + """ + Identifies the state of the issue. + """ state: IssueState! - # A list of events, comments, commits, etc. associated with the issue. + """ + A list of events, comments, commits, etc. associated with the issue. + """ timeline( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows filtering timeline events by a `since` timestamp. + """ + Allows filtering timeline events by a `since` timestamp. + """ since: DateTime ): IssueTimelineConnection! - # Identifies the issue title. + """ + Identifies the issue title. + """ title: String! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this issue + """ + The HTTP URL for this issue + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! } -# Represents a comment on an Issue. -type IssueComment implements Comment, Deletable, Node, Reactable, RepositoryNode, Updatable, UpdatableComment { - # The actor who authored the comment. +""" +Represents a comment on an Issue. +""" +type IssueComment implements Comment & Deletable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # Identifies the comment body. + """ + Identifies the comment body. + """ body: String! - # The comment body rendered to HTML. + """ + The comment body rendered to HTML. + """ bodyHTML: HTML! - # Identifies the body of the issue rendered to text. + """ + Identifies the body of the issue rendered to text. + """ bodyText: String! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # Identifies the issue associated with the comment. + """ + Identifies the issue associated with the comment. + """ issue: Issue! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # Returns the pull request associated with the comment, if this comment was made on a - # pull request. + """ + Returns the pull request associated with the comment, if this comment was made on a + pull request. + """ pullRequest: PullRequest - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! - # The HTTP path for this issue comment + """ + The HTTP path for this issue comment + """ resourcePath: URI! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this issue comment + """ + The HTTP URL for this issue comment + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# The connection type for IssueComment. +""" +The connection type for IssueComment. +""" type IssueCommentConnection { - # A list of edges. + """ + A list of edges. + """ edges: [IssueCommentEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [IssueComment] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type IssueCommentEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: IssueComment } -# The connection type for Issue. +""" +The connection type for Issue. +""" type IssueConnection { - # A list of edges. + """ + A list of edges. + """ edges: [IssueEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Issue] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type IssueEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Issue } -# Used for return value of Repository.issueOrPullRequest. +""" +Used for return value of Repository.issueOrPullRequest. +""" union IssueOrPullRequest = Issue | PullRequest -# Ways in which lists of issues can be ordered upon return. +""" +Ways in which lists of issues can be ordered upon return. +""" input IssueOrder { - # The direction in which to order issues by the specified field. + """ + The direction in which to order issues by the specified field. + """ direction: OrderDirection! - # The field in which to order issues by. + """ + The field in which to order issues by. + """ field: IssueOrderField! } -# Properties by which issue connections can be ordered. +""" +Properties by which issue connections can be ordered. +""" enum IssueOrderField { - # Order issues by comment count + """ + Order issues by comment count + """ COMMENTS - # Order issues by creation time + """ + Order issues by creation time + """ CREATED_AT - # Order issues by update time + """ + Order issues by update time + """ UPDATED_AT } -# The possible PubSub channels for an issue. -enum IssuePubSubTopic { - # The channel ID for marking an issue as read. - MARKASREAD - - # The channel ID for observing issue updates. - UPDATED -} - -# The possible states of an issue. +""" +The possible states of an issue. +""" enum IssueState { - # An issue that has been closed + """ + An issue that has been closed + """ CLOSED - # An issue that is still open + """ + An issue that is still open + """ OPEN } -# The connection type for IssueTimelineItem. +""" +The connection type for IssueTimelineItem. +""" type IssueTimelineConnection { - # A list of edges. + """ + A list of edges. + """ edges: [IssueTimelineItemEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [IssueTimelineItem] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An item in an issue timeline +""" +An item in an issue timeline +""" union IssueTimelineItem = AssignedEvent | ClosedEvent | Commit | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MilestonedEvent | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent -# An edge in a connection. +""" +An edge in a connection. +""" type IssueTimelineItemEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: IssueTimelineItem } -# A label for categorizing Issues or Milestones with a given Repository. +""" +A label for categorizing Issues or Milestones with a given Repository. +""" type Label implements Node { - # Identifies the label color. + """ + Identifies the label color. + """ color: String! id: ID! - # A list of issues associated with this label. + """ + A list of issues associated with this label. + """ issues( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for issues returned from the connection. + """ + Ordering options for issues returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the issues by. + """ + A list of states to filter the issues by. + """ states: [IssueState!] ): IssueConnection! - # Identifies the label name. + """ + Identifies the label name. + """ name: String! - # A list of pull requests associated with this label. + """ + A list of pull requests associated with this label. + """ pullRequests( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # The base ref name to filter the pull requests by. + """ + The base ref name to filter the pull requests by. + """ baseRefName: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # The head ref name to filter the pull requests by. + """ + The head ref name to filter the pull requests by. + """ headRefName: String - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for pull requests returned from the connection. + """ + Ordering options for pull requests returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the pull requests by. + """ + A list of states to filter the pull requests by. + """ states: [PullRequestState!] ): PullRequestConnection! - # The repository associated with this label. + """ + The repository associated with this label. + """ repository: Repository! } -# The connection type for Label. +""" +The connection type for Label. +""" type LabelConnection { - # A list of edges. + """ + A list of edges. + """ edges: [LabelEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Label] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type LabelEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Label } -# An object that can have labels assigned to it. +""" +An object that can have labels assigned to it. +""" interface Labelable { - # A list of labels associated with the object. + """ + A list of labels associated with the object. + """ labels( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): LabelConnection } -# Represents a 'labeled' event on a given issue or pull request. +""" +Represents a 'labeled' event on a given issue or pull request. +""" type LabeledEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the label associated with the 'labeled' event. + """ + Identifies the label associated with the 'labeled' event. + """ label: Label! - # Identifies the `Labelable` associated with the event. + """ + Identifies the `Labelable` associated with the event. + """ labelable: Labelable! } -# Represents a given language found in repositories. +""" +Represents a given language found in repositories. +""" type Language implements Node { - # The color defined for the current language. + """ + The color defined for the current language. + """ color: String id: ID! - # The name of the current language. + """ + The name of the current language. + """ name: String! } -# A list of languages associated with the parent. +""" +A list of languages associated with the parent. +""" type LanguageConnection { - # A list of edges. + """ + A list of edges. + """ edges: [LanguageEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Language] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! - # The total size in bytes of files written in that language. + """ + The total size in bytes of files written in that language. + """ totalSize: Int! } -# Represents the language of a repository. +""" +Represents the language of a repository. +""" type LanguageEdge { cursor: String! node: Language! - # The number of bytes of code written in the language. + """ + The number of bytes of code written in the language. + """ size: Int! } -# Ordering options for language connections. +""" +Ordering options for language connections. +""" input LanguageOrder { - # The ordering direction. + """ + The ordering direction. + """ direction: OrderDirection! - # The field to order languages by. + """ + The field to order languages by. + """ field: LanguageOrderField! } -# Properties by which language connections can be ordered. +""" +Properties by which language connections can be ordered. +""" enum LanguageOrderField { - # Order languages by the size of all files containing the language + """ + Order languages by the size of all files containing the language + """ SIZE } -# A respository's open source license +""" +A respository's open source license +""" type License { - # The full text of the license + """ + The full text of the license + """ body: String! - # The conditions set by the license + """ + The conditions set by the license + """ conditions: [LicenseRule]! - # A human-readable description of the license + """ + A human-readable description of the license + """ description: String - # Whether the license should be featured + """ + Whether the license should be featured + """ featured: Boolean! - # Whether the license should be displayed in license pickers + """ + Whether the license should be displayed in license pickers + """ hidden: Boolean! id: ID! - # Instructions on how to implement the license + """ + Instructions on how to implement the license + """ implementation: String - # The lowercased SPDX ID of the license + """ + The lowercased SPDX ID of the license + """ key: String! - # The limitations set by the license + """ + The limitations set by the license + """ limitations: [LicenseRule]! - # The license full name specified by + """ + The license full name specified by + """ name: String! - # Customary short name if applicable (e.g, GPLv3) + """ + Customary short name if applicable (e.g, GPLv3) + """ nickname: String - # The permissions set by the license + """ + The permissions set by the license + """ permissions: [LicenseRule]! - # Short identifier specified by + """ + Short identifier specified by + """ spdxId: String - # URL to the license on + """ + URL to the license on + """ url: URI } -# Describes a License's conditions, permissions, and limitations +""" +Describes a License's conditions, permissions, and limitations +""" type LicenseRule { - # A description of the rule + """ + A description of the rule + """ description: String! - # The machine-readable rule key + """ + The machine-readable rule key + """ key: String! - # The human-readable rule label + """ + The human-readable rule label + """ label: String! } -# Autogenerated input type of LockLockable +""" +Autogenerated input type of LockLockable +""" input LockLockableInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # A reason for why the issue or pull request will be locked. + """ + A reason for why the issue or pull request will be locked. + """ lockReason: LockReason - # ID of the issue or pull request to be locked. + """ + ID of the issue or pull request to be locked. + """ lockableId: ID! } -# Autogenerated return type of LockLockable +""" +Autogenerated return type of LockLockable +""" type LockLockablePayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The item that was locked. + """ + The item that was locked. + """ lockedRecord: Lockable } -# The possible reasons that an issue or pull request was locked. +""" +The possible reasons that an issue or pull request was locked. +""" enum LockReason { - # The issue or pull request was locked because the conversation was off-topic. + """ + The issue or pull request was locked because the conversation was off-topic. + """ OFF_TOPIC - # The issue or pull request was locked because the conversation was resolved. + """ + The issue or pull request was locked because the conversation was resolved. + """ RESOLVED - # The issue or pull request was locked because the conversation was spam. + """ + The issue or pull request was locked because the conversation was spam. + """ SPAM - # The issue or pull request was locked because the conversation was too heated. + """ + The issue or pull request was locked because the conversation was too heated. + """ TOO_HEATED } -# An object that can be locked. +""" +An object that can be locked. +""" interface Lockable { - # Reason that the conversation was locked. + """ + Reason that the conversation was locked. + """ activeLockReason: LockReason - # `true` if the object is locked + """ + `true` if the object is locked + """ locked: Boolean! } -# Represents a 'locked' event on a given issue or pull request. +""" +Represents a 'locked' event on a given issue or pull request. +""" type LockedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Object that was locked. + """ + Object that was locked. + """ lockable: Lockable! } -# Represents a 'mentioned' event on a given issue or pull request. +""" +Represents a 'mentioned' event on a given issue or pull request. +""" type MentionedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# Whether or not a PullRequest can be merged. +""" +Whether or not a PullRequest can be merged. +""" enum MergeableState { - # The pull request cannot be merged due to merge conflicts. + """ + The pull request cannot be merged due to merge conflicts. + """ CONFLICTING - # The pull request can be merged. + """ + The pull request can be merged. + """ MERGEABLE - # The mergeability of the pull request is still being calculated. + """ + The mergeability of the pull request is still being calculated. + """ UNKNOWN } -# Represents a 'merged' event on a given pull request. -type MergedEvent implements Node, UniformResourceLocatable { - # Identifies the actor who performed the event. +""" +Represents a 'merged' event on a given pull request. +""" +type MergedEvent implements Node & UniformResourceLocatable { + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the commit associated with the `merge` event. + """ + Identifies the commit associated with the `merge` event. + """ commit: Commit - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the Ref associated with the `merge` event. + """ + Identifies the Ref associated with the `merge` event. + """ mergeRef: Ref - # Identifies the name of the Ref associated with the `merge` event. + """ + Identifies the name of the Ref associated with the `merge` event. + """ mergeRefName: String! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # The HTTP path for this merged event. + """ + The HTTP path for this merged event. + """ resourcePath: URI! - # The HTTP URL for this merged event. + """ + The HTTP URL for this merged event. + """ url: URI! } -# Represents a Milestone object on a given repository. -type Milestone implements Closable, Node, UniformResourceLocatable { - # `true` if the object is closed (definition of closed may depend on type) +""" +Represents a Milestone object on a given repository. +""" +type Milestone implements Closable & Node & UniformResourceLocatable { + """ + `true` if the object is closed (definition of closed may depend on type) + """ closed: Boolean! - # Identifies the date and time when the object was closed. + """ + Identifies the date and time when the object was closed. + """ closedAt: DateTime - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the actor who created the milestone. + """ + Identifies the actor who created the milestone. + """ creator: Actor - # Identifies the description of the milestone. + """ + Identifies the description of the milestone. + """ description: String - # Identifies the due date of the milestone. + """ + Identifies the due date of the milestone. + """ dueOn: DateTime id: ID! - # A list of issues associated with the milestone. + """ + A list of issues associated with the milestone. + """ issues( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for issues returned from the connection. + """ + Ordering options for issues returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the issues by. + """ + A list of states to filter the issues by. + """ states: [IssueState!] ): IssueConnection! - # Identifies the number of the milestone. + """ + Identifies the number of the milestone. + """ number: Int! - # A list of pull requests associated with the milestone. + """ + A list of pull requests associated with the milestone. + """ pullRequests( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # The base ref name to filter the pull requests by. + """ + The base ref name to filter the pull requests by. + """ baseRefName: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # The head ref name to filter the pull requests by. + """ + The head ref name to filter the pull requests by. + """ headRefName: String - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for pull requests returned from the connection. + """ + Ordering options for pull requests returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the pull requests by. + """ + A list of states to filter the pull requests by. + """ states: [PullRequestState!] ): PullRequestConnection! - # The repository associated with this milestone. + """ + The repository associated with this milestone. + """ repository: Repository! - # The HTTP path for this milestone + """ + The HTTP path for this milestone + """ resourcePath: URI! - # Identifies the state of the milestone. + """ + Identifies the state of the milestone. + """ state: MilestoneState! - # Identifies the title of the milestone. + """ + Identifies the title of the milestone. + """ title: String! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this milestone + """ + The HTTP URL for this milestone + """ url: URI! } -# The connection type for Milestone. +""" +The connection type for Milestone. +""" type MilestoneConnection { - # A list of edges. + """ + A list of edges. + """ edges: [MilestoneEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Milestone] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type MilestoneEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Milestone } -# Types that can be inside a Milestone. +""" +Types that can be inside a Milestone. +""" union MilestoneItem = Issue | PullRequest -# Ordering options for milestone connections. +""" +Ordering options for milestone connections. +""" input MilestoneOrder { - # The ordering direction. + """ + The ordering direction. + """ direction: OrderDirection! - # The field to order milestones by. + """ + The field to order milestones by. + """ field: MilestoneOrderField! } -# Properties by which milestone connections can be ordered. +""" +Properties by which milestone connections can be ordered. +""" enum MilestoneOrderField { - # Order milestones by when they were created. + """ + Order milestones by when they were created. + """ CREATED_AT - # Order milestones by when they are due. + """ + Order milestones by when they are due. + """ DUE_DATE - # Order milestones by their number. + """ + Order milestones by their number. + """ NUMBER - # Order milestones by when they were last updated. + """ + Order milestones by when they were last updated. + """ UPDATED_AT } -# The possible states of a milestone. +""" +The possible states of a milestone. +""" enum MilestoneState { - # A milestone that has been closed. + """ + A milestone that has been closed. + """ CLOSED - # A milestone that is still open. + """ + A milestone that is still open. + """ OPEN } -# Represents a 'milestoned' event on a given issue or pull request. +""" +Represents a 'milestoned' event on a given issue or pull request. +""" type MilestonedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the milestone title associated with the 'milestoned' event. + """ + Identifies the milestone title associated with the 'milestoned' event. + """ milestoneTitle: String! - # Object referenced by event. + """ + Object referenced by event. + """ subject: MilestoneItem! } -# Autogenerated input type of MoveProjectCard +""" +Autogenerated input type of MoveProjectCard +""" input MoveProjectCardInput { - # Place the new card after the card with this id. Pass null to place it at the top. + """ + Place the new card after the card with this id. Pass null to place it at the top. + """ afterCardId: ID - # The id of the card to move. + """ + The id of the card to move. + """ cardId: ID! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The id of the column to move it into. + """ + The id of the column to move it into. + """ columnId: ID! } -# Autogenerated return type of MoveProjectCard +""" +Autogenerated return type of MoveProjectCard +""" type MoveProjectCardPayload { - # The new edge of the moved card. + """ + The new edge of the moved card. + """ cardEdge: ProjectCardEdge! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String } -# Autogenerated input type of MoveProjectColumn +""" +Autogenerated input type of MoveProjectColumn +""" input MoveProjectColumnInput { - # Place the new column after the column with this id. Pass null to place it at the front. + """ + Place the new column after the column with this id. Pass null to place it at the front. + """ afterColumnId: ID - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The id of the column to move. + """ + The id of the column to move. + """ columnId: ID! } -# Autogenerated return type of MoveProjectColumn +""" +Autogenerated return type of MoveProjectColumn +""" type MoveProjectColumnPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The new edge of the moved column. + """ + The new edge of the moved column. + """ columnEdge: ProjectColumnEdge! } -# Represents a 'moved_columns_in_project' event on a given issue or pull request. +""" +Represents a 'moved_columns_in_project' event on a given issue or pull request. +""" type MovedColumnsInProjectEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# The root query for implementing GraphQL mutations. +""" +The root query for implementing GraphQL mutations. +""" type Mutation { - # Applies a suggested topic to the repository. + """ + Applies a suggested topic to the repository. + """ acceptTopicSuggestion(input: AcceptTopicSuggestionInput!): AcceptTopicSuggestionPayload - # Adds a comment to an Issue or Pull Request. + """ + Adds a comment to an Issue or Pull Request. + """ addComment(input: AddCommentInput!): AddCommentPayload - # Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. + """ + Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. + """ addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload - # Adds a column to a Project. + """ + Adds a column to a Project. + """ addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload - # Adds a review to a Pull Request. + """ + Adds a review to a Pull Request. + """ addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload - # Adds a comment to a review. + """ + Adds a comment to a review. + """ addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload - # Adds a reaction to a subject. + """ + Adds a reaction to a subject. + """ addReaction(input: AddReactionInput!): AddReactionPayload - # Adds a star to a Starrable. + """ + Adds a star to a Starrable. + """ addStar(input: AddStarInput!): AddStarPayload - # Creates a new project. + """ + Creates a new project. + """ createProject(input: CreateProjectInput!): CreateProjectPayload - # Creates a new team discussion. + """ + Creates a new team discussion. + """ createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload @preview(toggledBy: "echo-preview") - # Creates a new team discussion comment. + """ + Creates a new team discussion comment. + """ createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") - # Rejects a suggested topic for the repository. + """ + Rejects a suggested topic for the repository. + """ declineTopicSuggestion(input: DeclineTopicSuggestionInput!): DeclineTopicSuggestionPayload - # Deletes a project. + """ + Deletes a project. + """ deleteProject(input: DeleteProjectInput!): DeleteProjectPayload - # Deletes a project card. + """ + Deletes a project card. + """ deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload - # Deletes a project column. + """ + Deletes a project column. + """ deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload - # Deletes a pull request review. + """ + Deletes a pull request review. + """ deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload - # Deletes a team discussion. + """ + Deletes a team discussion. + """ deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload @preview(toggledBy: "echo-preview") - # Deletes a team discussion comment. + """ + Deletes a team discussion comment. + """ deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") - # Dismisses an approved or rejected pull request review. + """ + Dismisses an approved or rejected pull request review. + """ dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload - # Lock a lockable object + """ + Lock a lockable object + """ lockLockable(input: LockLockableInput!): LockLockablePayload - # Moves a project card to another place. + """ + Moves a project card to another place. + """ moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload - # Moves a project column to another place. + """ + Moves a project column to another place. + """ moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload - # Removes outside collaborator from all repositories in an organization. + """ + Removes outside collaborator from all repositories in an organization. + """ removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload - # Removes a reaction from a subject. + """ + Removes a reaction from a subject. + """ removeReaction(input: RemoveReactionInput!): RemoveReactionPayload - # Removes a star from a Starrable. + """ + Removes a star from a Starrable. + """ removeStar(input: RemoveStarInput!): RemoveStarPayload - # Set review requests on a pull request. + """ + Set review requests on a pull request. + """ requestReviews(input: RequestReviewsInput!): RequestReviewsPayload - # Submits a pending pull request review. + """ + Submits a pending pull request review. + """ submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload - # Updates an existing project. + """ + Updates an existing project. + """ updateProject(input: UpdateProjectInput!): UpdateProjectPayload - # Updates an existing project card. + """ + Updates an existing project card. + """ updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload - # Updates an existing project column. + """ + Updates an existing project column. + """ updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload - # Updates the body of a pull request review. + """ + Updates the body of a pull request review. + """ updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload - # Updates a pull request review comment. + """ + Updates a pull request review comment. + """ updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload - # Updates viewers repository subscription state. + """ + Updates viewers repository subscription state. + """ updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload - # Updates a team discussion. + """ + Updates a team discussion. + """ updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview") - # Updates a discussion comment. + """ + Updates a discussion comment. + """ updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") - # Replaces the repository's topics with the given topics. + """ + Replaces the repository's topics with the given topics. + """ updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload } -# An object with an ID. +""" +An object with an ID. +""" interface Node { - # ID of the object. + """ + ID of the object. + """ id: ID! } -# Possible directions in which to order a list of items when provided an `orderBy` argument. +""" +Possible directions in which to order a list of items when provided an `orderBy` argument. +""" enum OrderDirection { - # Specifies an ascending order for a given `orderBy` argument. + """ + Specifies an ascending order for a given `orderBy` argument. + """ ASC - # Specifies a descending order for a given `orderBy` argument. + """ + Specifies a descending order for a given `orderBy` argument. + """ DESC } -# An account on GitHub, with one or more owners, that has repositories, members and teams. -type Organization implements Actor, Node, ProjectOwner, RepositoryOwner, UniformResourceLocatable { - # A URL pointing to the organization's public avatar. +""" +An account on GitHub, with one or more owners, that has repositories, members and teams. +""" +type Organization implements Actor & Node & ProjectOwner & RepositoryOwner & UniformResourceLocatable { + """ + A URL pointing to the organization's public avatar. + """ avatarUrl( - # The size of the resulting square image. + """ + The size of the resulting square image. + """ size: Int ): URI! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The organization's public profile description. + """ + The organization's public profile description. + """ description: String - # The organization's public email. + """ + The organization's public email. + """ email: String id: ID! - # The organization's public profile location. + """ + The organization's public profile location. + """ location: String - # The organization's login name. + """ + The organization's login name. + """ login: String! - # A list of users who are members of this organization. + """ + A list of users who are members of this organization. + """ members( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # The organization's public profile name. + """ + The organization's public profile name. + """ name: String - # The HTTP path creating a new team + """ + The HTTP path creating a new team + """ newTeamResourcePath: URI! - # The HTTP URL creating a new team + """ + The HTTP URL creating a new team + """ newTeamUrl: URI! - # The billing email for the organization. + """ + The billing email for the organization. + """ organizationBillingEmail: String - # A list of repositories this user has pinned to their profile + """ + A list of repositories this user has pinned to their profile + """ pinnedRepositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # Find project by number. + """ + Find project by number. + """ project( - # The project number to find. + """ + The project number to find. + """ number: Int! ): Project - # A list of projects under the owner. + """ + A list of projects under the owner. + """ projects( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for projects returned from the connection + """ + Ordering options for projects returned from the connection + """ orderBy: ProjectOrder - # Query to search projects by, currently only searching by name. + """ + Query to search projects by, currently only searching by name. + """ search: String - # A list of states to filter the projects by. + """ + A list of states to filter the projects by. + """ states: [ProjectState!] ): ProjectConnection! - # The HTTP path listing organization's projects + """ + The HTTP path listing organization's projects + """ projectsResourcePath: URI! - # The HTTP URL listing organization's projects + """ + The HTTP URL listing organization's projects + """ projectsUrl: URI! - # A list of repositories that the user owns. + """ + A list of repositories that the user owns. + """ repositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they are forks of another repository + """ + If non-null, filters repositories according to whether they are forks of another repository + """ isFork: Boolean - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # Find Repository. + """ + Find Repository. + """ repository( - # Name of Repository to find. + """ + Name of Repository to find. + """ name: String! ): Repository - # The HTTP path for this user + """ + The HTTP path for this user + """ resourcePath: URI! - # The Organization's SAML Identity Providers + """ + The Organization's SAML Identity Providers + """ samlIdentityProvider: OrganizationIdentityProvider - # Find an organization's team by its slug. + """ + Find an organization's team by its slug. + """ team( - # The name or slug of the team to find. + """ + The name or slug of the team to find. + """ slug: String! ): Team - # A list of teams in this organization. + """ + A list of teams in this organization. + """ teams( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # If true, filters teams that are mapped to an LDAP Group (Enterprise only) + """ + If true, filters teams that are mapped to an LDAP Group (Enterprise only) + """ ldapMapped: Boolean - # Ordering options for teams returned from the connection + """ + Ordering options for teams returned from the connection + """ orderBy: TeamOrder - # If non-null, filters teams according to privacy + """ + If non-null, filters teams according to privacy + """ privacy: TeamPrivacy - # If non-null, filters teams with query on team name and team slug + """ + If non-null, filters teams with query on team name and team slug + """ query: String - # If non-null, filters teams according to whether the viewer is an admin or member on team + """ + If non-null, filters teams according to whether the viewer is an admin or member on team + """ role: TeamRole - # If true, restrict to only root teams + """ + If true, restrict to only root teams + """ rootTeamsOnly: Boolean = false - # User logins to filter by + """ + User logins to filter by + """ userLogins: [String!] ): TeamConnection! - # The HTTP path listing organization's teams + """ + The HTTP path listing organization's teams + """ teamsResourcePath: URI! - # The HTTP URL listing organization's teams + """ + The HTTP URL listing organization's teams + """ teamsUrl: URI! - # The HTTP URL for this user + """ + The HTTP URL for this user + """ url: URI! - # Organization is adminable by the viewer. + """ + Organization is adminable by the viewer. + """ viewerCanAdminister: Boolean! - # Can the current viewer create new projects on this owner. + """ + Can the current viewer create new projects on this owner. + """ viewerCanCreateProjects: Boolean! - # Viewer can create repositories on this organization + """ + Viewer can create repositories on this organization + """ viewerCanCreateRepositories: Boolean! - # Viewer can create teams on this organization. + """ + Viewer can create teams on this organization. + """ viewerCanCreateTeams: Boolean! - # Viewer is an active member of this organization. + """ + Viewer is an active member of this organization. + """ viewerIsAMember: Boolean! - # The organization's public profile URL. + """ + The organization's public profile URL. + """ websiteUrl: URI } -# The connection type for Organization. +""" +The connection type for Organization. +""" type OrganizationConnection { - # A list of edges. + """ + A list of edges. + """ edges: [OrganizationEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Organization] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type OrganizationEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Organization } -# An Identity Provider configured to provision SAML and SCIM identities for Organizations +""" +An Identity Provider configured to provision SAML and SCIM identities for Organizations +""" type OrganizationIdentityProvider implements Node { - # The digest algorithm used to sign SAML requests for the Identity Provider. + """ + The digest algorithm used to sign SAML requests for the Identity Provider. + """ digestMethod: URI - # External Identities provisioned by this Identity Provider + """ + External Identities provisioned by this Identity Provider + """ externalIdentities( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ExternalIdentityConnection! id: ID! - # The x509 certificate used by the Identity Provder to sign assertions and responses. + """ + The x509 certificate used by the Identity Provder to sign assertions and responses. + """ idpCertificate: X509Certificate - # The Issuer Entity ID for the SAML Identity Provider + """ + The Issuer Entity ID for the SAML Identity Provider + """ issuer: String - # Organization this Identity Provider belongs to + """ + Organization this Identity Provider belongs to + """ organization: Organization - # The signature algorithm used to sign SAML requests for the Identity Provider. + """ + The signature algorithm used to sign SAML requests for the Identity Provider. + """ signatureMethod: URI - # The URL endpoint for the Identity Provider's SAML SSO. + """ + The URL endpoint for the Identity Provider's SAML SSO. + """ ssoUrl: URI } -# An Invitation for a user to an organization. +""" +An Invitation for a user to an organization. +""" type OrganizationInvitation implements Node { - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The email address of the user invited to the organization. + """ + The email address of the user invited to the organization. + """ email: String id: ID! - # The type of invitation that was sent (e.g. email, user). + """ + The type of invitation that was sent (e.g. email, user). + """ invitationType: OrganizationInvitationType! - # The user who was invited to the organization. + """ + The user who was invited to the organization. + """ invitee: User - # The user who created the invitation. + """ + The user who created the invitation. + """ inviter: User! - # The organization the invite is for + """ + The organization the invite is for + """ organization: Organization! - # The user's pending role in the organization (e.g. member, owner). + """ + The user's pending role in the organization (e.g. member, owner). + """ role: OrganizationInvitationRole! } -# The connection type for OrganizationInvitation. +""" +The connection type for OrganizationInvitation. +""" type OrganizationInvitationConnection { - # A list of edges. + """ + A list of edges. + """ edges: [OrganizationInvitationEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [OrganizationInvitation] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type OrganizationInvitationEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: OrganizationInvitation } -# The possible organization invitation roles. +""" +The possible organization invitation roles. +""" enum OrganizationInvitationRole { - # The user is invited to be an admin of the organization. + """ + The user is invited to be an admin of the organization. + """ ADMIN - # The user is invited to be a billing manager of the organization. + """ + The user is invited to be a billing manager of the organization. + """ BILLING_MANAGER - # The user is invited to be a direct member of the organization. + """ + The user is invited to be a direct member of the organization. + """ DIRECT_MEMBER - # The user's previous role will be reinstated. + """ + The user's previous role will be reinstated. + """ REINSTATE } -# The possible organization invitation types. +""" +The possible organization invitation types. +""" enum OrganizationInvitationType { - # The invitation was to an email address. + """ + The invitation was to an email address. + """ EMAIL - # The invitation was to an existing user. + """ + The invitation was to an existing user. + """ USER } -# Information about pagination in a connection. +""" +Information about pagination in a connection. +""" type PageInfo { - # When paginating forwards, the cursor to continue. + """ + When paginating forwards, the cursor to continue. + """ endCursor: String - # When paginating forwards, are there more items? + """ + When paginating forwards, are there more items? + """ hasNextPage: Boolean! - # When paginating backwards, are there more items? + """ + When paginating backwards, are there more items? + """ hasPreviousPage: Boolean! - # When paginating backwards, the cursor to continue. + """ + When paginating backwards, the cursor to continue. + """ startCursor: String } -# Projects manage issues, pull requests and notes within a project owner. -type Project implements Closable, Node, Updatable { - # The project's description body. +""" +Projects manage issues, pull requests and notes within a project owner. +""" +type Project implements Closable & Node & Updatable { + """ + The project's description body. + """ body: String - # The projects description body rendered to HTML. + """ + The projects description body rendered to HTML. + """ bodyHTML: HTML! - # `true` if the object is closed (definition of closed may depend on type) + """ + `true` if the object is closed (definition of closed may depend on type) + """ closed: Boolean! - # Identifies the date and time when the object was closed. + """ + Identifies the date and time when the object was closed. + """ closedAt: DateTime - # List of columns in the project + """ + List of columns in the project + """ columns( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ProjectColumnConnection! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The actor who originally created the project. + """ + The actor who originally created the project. + """ creator: Actor - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # The project's name. + """ + The project's name. + """ name: String! - # The project's number. + """ + The project's number. + """ number: Int! - # The project's owner. Currently limited to repositories and organizations. + """ + The project's owner. Currently limited to repositories and organizations. + """ owner: ProjectOwner! - # List of pending cards in this project + """ + List of pending cards in this project + """ pendingCards( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ProjectCardConnection! - # The HTTP path for this project + """ + The HTTP path for this project + """ resourcePath: URI! - # Whether the project is open or closed. + """ + Whether the project is open or closed. + """ state: ProjectState! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this project + """ + The HTTP URL for this project + """ url: URI! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! } -# A card in a project. +""" +A card in a project. +""" type ProjectCard implements Node { - # The project column this card is associated under. A card may only belong to one - # project column at a time. The column field will be null if the card is created - # in a pending state and has yet to be associated with a column. Once cards are - # associated with a column, they will not become pending in the future. + """ + The project column this card is associated under. A card may only belong to one + project column at a time. The column field will be null if the card is created + in a pending state and has yet to be associated with a column. Once cards are + associated with a column, they will not become pending in the future. + """ column: ProjectColumn - # The card content item + """ + The card content item + """ content: ProjectCardItem - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The actor who created this card + """ + The actor who created this card + """ creator: Actor - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # The card note + """ + The card note + """ note: String - # The project that contains this card. + """ + The project that contains this card. + """ project: Project! - # The column that contains this card. + """ + The column that contains this card. + """ projectColumn: ProjectColumn! @deprecated(reason: "The associated column may be null if the card is in a pending state. Use `ProjectCard.column` instead. Removal on 2017-07-01 UTC.") - # The HTTP path for this card + """ + The HTTP path for this card + """ resourcePath: URI! - # The state of ProjectCard + """ + The state of ProjectCard + """ state: ProjectCardState - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this card + """ + The HTTP URL for this card + """ url: URI! } -# The connection type for ProjectCard. +""" +The connection type for ProjectCard. +""" type ProjectCardConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ProjectCardEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ProjectCard] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ProjectCardEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ProjectCard } -# Types that can be inside Project Cards. +""" +Types that can be inside Project Cards. +""" union ProjectCardItem = Issue | PullRequest -# Various content states of a ProjectCard +""" +Various content states of a ProjectCard +""" enum ProjectCardState { - # The card has content only. + """ + The card has content only. + """ CONTENT_ONLY - # The card has a note only. + """ + The card has a note only. + """ NOTE_ONLY - # The card is redacted. + """ + The card is redacted. + """ REDACTED } -# A column inside a project. +""" +A column inside a project. +""" type ProjectColumn implements Node { - # List of cards in the column + """ + List of cards in the column + """ cards( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ProjectCardConnection! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # The project column's name. + """ + The project column's name. + """ name: String! - # The project that contains this column. + """ + The project that contains this column. + """ project: Project! - # The HTTP path for this project column + """ + The HTTP path for this project column + """ resourcePath: URI! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this project column + """ + The HTTP URL for this project column + """ url: URI! } -# The connection type for ProjectColumn. +""" +The connection type for ProjectColumn. +""" type ProjectColumnConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ProjectColumnEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ProjectColumn] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ProjectColumnEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ProjectColumn } -# A list of projects associated with the owner. +""" +A list of projects associated with the owner. +""" type ProjectConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ProjectEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Project] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ProjectEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Project } -# Ways in which lists of projects can be ordered upon return. +""" +Ways in which lists of projects can be ordered upon return. +""" input ProjectOrder { - # The direction in which to order projects by the specified field. + """ + The direction in which to order projects by the specified field. + """ direction: OrderDirection! - # The field in which to order projects by. + """ + The field in which to order projects by. + """ field: ProjectOrderField! } -# Properties by which project connections can be ordered. +""" +Properties by which project connections can be ordered. +""" enum ProjectOrderField { - # Order projects by creation time + """ + Order projects by creation time + """ CREATED_AT - # Order projects by name + """ + Order projects by name + """ NAME - # Order projects by update time + """ + Order projects by update time + """ UPDATED_AT } -# Represents an owner of a Project. +""" +Represents an owner of a Project. +""" interface ProjectOwner { id: ID! - # Find project by number. + """ + Find project by number. + """ project( - # The project number to find. + """ + The project number to find. + """ number: Int! ): Project - # A list of projects under the owner. + """ + A list of projects under the owner. + """ projects( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for projects returned from the connection + """ + Ordering options for projects returned from the connection + """ orderBy: ProjectOrder - # Query to search projects by, currently only searching by name. + """ + Query to search projects by, currently only searching by name. + """ search: String - # A list of states to filter the projects by. + """ + A list of states to filter the projects by. + """ states: [ProjectState!] ): ProjectConnection! - # The HTTP path listing owners projects + """ + The HTTP path listing owners projects + """ projectsResourcePath: URI! - # The HTTP URL listing owners projects + """ + The HTTP URL listing owners projects + """ projectsUrl: URI! - # Can the current viewer create new projects on this owner. + """ + Can the current viewer create new projects on this owner. + """ viewerCanCreateProjects: Boolean! } -# State of the project; either 'open' or 'closed' +""" +State of the project; either 'open' or 'closed' +""" enum ProjectState { - # The project is closed. + """ + The project is closed. + """ CLOSED - # The project is open. + """ + The project is open. + """ OPEN } -# A repository protected branch. +""" +A repository protected branch. +""" type ProtectedBranch implements Node { - # The actor who created this protected branch. + """ + The actor who created this protected branch. + """ creator: Actor - # Will new commits pushed to this branch dismiss pull request review approvals. + """ + Will new commits pushed to this branch dismiss pull request review approvals. + """ hasDismissableStaleReviews: Boolean! - # Are reviews required to update this branch. + """ + Are reviews required to update this branch. + """ hasRequiredReviews: Boolean! - # Are status checks required to update this branch. + """ + Are status checks required to update this branch. + """ hasRequiredStatusChecks: Boolean! - # Is pushing to this branch restricted. + """ + Is pushing to this branch restricted. + """ hasRestrictedPushes: Boolean! - # Is dismissal of pull request reviews restricted. + """ + Is dismissal of pull request reviews restricted. + """ hasRestrictedReviewDismissals: Boolean! - # Are branches required to be up to date before merging. + """ + Are branches required to be up to date before merging. + """ hasStrictRequiredStatusChecks: Boolean! id: ID! - # Can admins overwrite branch protection. + """ + Can admins overwrite branch protection. + """ isAdminEnforced: Boolean! - # Identifies the name of the protected branch. + """ + Identifies the name of the protected branch. + """ name: String! - # A list push allowances for this protected branch. + """ + A list push allowances for this protected branch. + """ pushAllowances( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): PushAllowanceConnection! - # The repository associated with this protected branch. + """ + The repository associated with this protected branch. + """ repository: Repository! - # List of required status check contexts that must pass for commits to be accepted to this branch. + """ + List of required status check contexts that must pass for commits to be accepted to this branch. + """ requiredStatusCheckContexts: [String] - # A list review dismissal allowances for this protected branch. + """ + A list review dismissal allowances for this protected branch. + """ reviewDismissalAllowances( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ReviewDismissalAllowanceConnection! } -# The connection type for ProtectedBranch. +""" +The connection type for ProtectedBranch. +""" type ProtectedBranchConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ProtectedBranchEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ProtectedBranch] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ProtectedBranchEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ProtectedBranch } -# A user's public key. +""" +A user's public key. +""" type PublicKey implements Node { id: ID! - # The public key string + """ + The public key string + """ key: String! } -# The connection type for PublicKey. +""" +The connection type for PublicKey. +""" type PublicKeyConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PublicKeyEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PublicKey] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type PublicKeyEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PublicKey } -# A repository pull request. -type PullRequest implements Assignable, Closable, Comment, Labelable, Lockable, Node, Reactable, RepositoryNode, Subscribable, UniformResourceLocatable, Updatable, UpdatableComment { - # Reason that the conversation was locked. +""" +A repository pull request. +""" +type PullRequest implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment { + """ + Reason that the conversation was locked. + """ activeLockReason: LockReason - # The number of additions in this pull request. + """ + The number of additions in this pull request. + """ additions: Int! - # A list of Users assigned to this object. + """ + A list of Users assigned to this object. + """ assignees( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # The actor who authored the comment. + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # Identifies the base Ref associated with the pull request. + """ + Identifies the base Ref associated with the pull request. + """ baseRef: Ref - # Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. + """ + Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted. + """ baseRefName: String! - # Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted. + """ + Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted. + """ baseRefOid: GitObjectID! - # Identifies the body of the pull request. + """ + Identifies the body of the pull request. + """ body: String! - # Identifies the body of the pull request rendered to HTML. + """ + Identifies the body of the pull request rendered to HTML. + """ bodyHTML: HTML! - # Identifies the body of the pull request rendered to text. + """ + Identifies the body of the pull request rendered to text. + """ bodyText: String! - # The number of changed files in this pull request. + """ + The number of changed files in this pull request. + """ changedFiles: Int! - # `true` if the pull request is closed + """ + `true` if the pull request is closed + """ closed: Boolean! - # Identifies the date and time when the object was closed. + """ + Identifies the date and time when the object was closed. + """ closedAt: DateTime - # A list of comments associated with the pull request. + """ + A list of comments associated with the pull request. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): IssueCommentConnection! - # A list of commits present in this pull request's head branch not present in the base branch. + """ + A list of commits present in this pull request's head branch not present in the base branch. + """ commits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): PullRequestCommitConnection! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The number of deletions in this pull request. + """ + The number of deletions in this pull request. + """ deletions: Int! - # The actor who edited this pull request's body. + """ + The actor who edited this pull request's body. + """ editor: Actor - # Identifies the head Ref associated with the pull request. + """ + Identifies the head Ref associated with the pull request. + """ headRef: Ref - # Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. + """ + Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted. + """ headRefName: String! - # Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted. + """ + Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted. + """ headRefOid: GitObjectID! - # The repository associated with this pull request's head Ref. + """ + The repository associated with this pull request's head Ref. + """ headRepository: Repository - # The owner of the repository associated with this pull request's head Ref. + """ + The owner of the repository associated with this pull request's head Ref. + """ headRepositoryOwner: RepositoryOwner id: ID! - # The head and base repositories are different. + """ + The head and base repositories are different. + """ isCrossRepository: Boolean! - # A list of labels associated with the object. + """ + A list of labels associated with the object. + """ labels( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): LabelConnection - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # `true` if the pull request is locked + """ + `true` if the pull request is locked + """ locked: Boolean! - # The commit that was created when this pull request was merged. + """ + The commit that was created when this pull request was merged. + """ mergeCommit: Commit - # Whether or not the pull request can be merged based on the existence of merge conflicts. + """ + Whether or not the pull request can be merged based on the existence of merge conflicts. + """ mergeable: MergeableState! - # Whether or not the pull request was merged. + """ + Whether or not the pull request was merged. + """ merged: Boolean! - # The date and time that the pull request was merged. + """ + The date and time that the pull request was merged. + """ mergedAt: DateTime - # Identifies the milestone associated with the pull request. + """ + Identifies the milestone associated with the pull request. + """ milestone: Milestone - # Identifies the pull request number. + """ + Identifies the pull request number. + """ number: Int! - # A list of Users that are participating in the Pull Request conversation. + """ + A list of Users that are participating in the Pull Request conversation. + """ participants( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # The commit that GitHub automatically generated to test if this pull request - # could be merged. This field will not return a value if the pull request is - # merged, or if the test merge commit is still being generated. See the - # `mergeable` field for more details on the mergeability of the pull request. + """ + The commit that GitHub automatically generated to test if this pull request + could be merged. This field will not return a value if the pull request is + merged, or if the test merge commit is still being generated. See the + `mergeable` field for more details on the mergeability of the pull request. + """ potentialMergeCommit: Commit - # List of project cards associated with this pull request. + """ + List of project cards associated with this pull request. + """ projectCards( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ProjectCardConnection! - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! - # The HTTP path for this pull request. + """ + The HTTP path for this pull request. + """ resourcePath: URI! - # The HTTP path for reverting this pull request. + """ + The HTTP path for reverting this pull request. + """ revertResourcePath: URI! - # The HTTP URL for reverting this pull request. + """ + The HTTP URL for reverting this pull request. + """ revertUrl: URI! - # A list of review requests associated with the pull request. + """ + A list of review requests associated with the pull request. + """ reviewRequests( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ReviewRequestConnection - # A list of reviews associated with the pull request. + """ + A list of reviews associated with the pull request. + """ reviews( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Filter by author of the review. + """ + Filter by author of the review. + """ author: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # A list of states to filter the reviews. + """ + A list of states to filter the reviews. + """ states: [PullRequestReviewState!] ): PullRequestReviewConnection - # Identifies the state of the pull request. + """ + Identifies the state of the pull request. + """ state: PullRequestState! - # A list of reviewer suggestions based on commit history and past review comments. + """ + A list of reviewer suggestions based on commit history and past review comments. + """ suggestedReviewers: [SuggestedReviewer]! - # A list of events, comments, commits, etc. associated with the pull request. + """ + A list of events, comments, commits, etc. associated with the pull request. + """ timeline( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows filtering timeline events by a `since` timestamp. + """ + Allows filtering timeline events by a `since` timestamp. + """ since: DateTime ): PullRequestTimelineConnection! - # Identifies the pull request title. + """ + Identifies the pull request title. + """ title: String! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this pull request. + """ + The HTTP URL for this pull request. + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! } -# Represents a Git commit part of a pull request. -type PullRequestCommit implements Node, UniformResourceLocatable { - # The Git commit object +""" +Represents a Git commit part of a pull request. +""" +type PullRequestCommit implements Node & UniformResourceLocatable { + """ + The Git commit object + """ commit: Commit! id: ID! - # The pull request this commit belongs to + """ + The pull request this commit belongs to + """ pullRequest: PullRequest! - # The HTTP path for this pull request commit + """ + The HTTP path for this pull request commit + """ resourcePath: URI! - # The HTTP URL for this pull request commit + """ + The HTTP URL for this pull request commit + """ url: URI! } -# The connection type for PullRequestCommit. +""" +The connection type for PullRequestCommit. +""" type PullRequestCommitConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PullRequestCommitEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PullRequestCommit] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type PullRequestCommitEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PullRequestCommit } -# The connection type for PullRequest. +""" +The connection type for PullRequest. +""" type PullRequestConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PullRequestEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PullRequest] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type PullRequestEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PullRequest } -# The possible PubSub channels for a pull request. -enum PullRequestPubSubTopic { - # The channel ID for observing head ref updates. - HEAD_REF - - # The channel ID for marking an pull request as read. - MARKASREAD - - # The channel ID for observing pull request updates. - UPDATED -} - -# A review object for a given pull request. -type PullRequestReview implements Comment, Deletable, Node, RepositoryNode, Updatable, UpdatableComment { - # The actor who authored the comment. +""" +A review object for a given pull request. +""" +type PullRequestReview implements Comment & Deletable & Node & RepositoryNode & Updatable & UpdatableComment { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # Identifies the pull request review body. + """ + Identifies the pull request review body. + """ body: String! - # The body of this review rendered to HTML. + """ + The body of this review rendered to HTML. + """ bodyHTML: HTML! - # The body of this review rendered as plain text. + """ + The body of this review rendered as plain text. + """ bodyText: String! - # A list of review comments for the current pull request review. + """ + A list of review comments for the current pull request review. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): PullRequestReviewCommentConnection! - # Identifies the commit associated with this pull request review. + """ + Identifies the commit associated with this pull request review. + """ commit: Commit - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # Identifies the pull request associated with this pull request review. + """ + Identifies the pull request associated with this pull request review. + """ pullRequest: PullRequest! - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! - # The HTTP path permalink for this PullRequestReview. + """ + The HTTP path permalink for this PullRequestReview. + """ resourcePath: URI! - # Identifies the current state of the pull request review. + """ + Identifies the current state of the pull request review. + """ state: PullRequestReviewState! - # Identifies when the Pull Request Review was submitted + """ + Identifies when the Pull Request Review was submitted + """ submittedAt: DateTime - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL permalink for this PullRequestReview. + """ + The HTTP URL permalink for this PullRequestReview. + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# A review comment associated with a given repository pull request. -type PullRequestReviewComment implements Comment, Deletable, Node, Reactable, RepositoryNode, Updatable, UpdatableComment { - # The actor who authored the comment. +""" +A review comment associated with a given repository pull request. +""" +type PullRequestReviewComment implements Comment & Deletable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the subject of the comment. + """ + Author's association with the subject of the comment. + """ authorAssociation: CommentAuthorAssociation! - # The comment body of this review comment. + """ + The comment body of this review comment. + """ body: String! - # The comment body of this review comment rendered to HTML. + """ + The comment body of this review comment rendered to HTML. + """ bodyHTML: HTML! - # The comment body of this review comment rendered as plain text. + """ + The comment body of this review comment rendered as plain text. + """ bodyText: String! - # Identifies the commit associated with the comment. + """ + Identifies the commit associated with the comment. + """ commit: Commit! - # Identifies when the comment was created. + """ + Identifies when the comment was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The diff hunk to which the comment applies. + """ + The diff hunk to which the comment applies. + """ diffHunk: String! - # Identifies when the comment was created in a draft state. + """ + Identifies when the comment was created in a draft state. + """ draftedAt: DateTime! - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies the original commit associated with the comment. + """ + Identifies the original commit associated with the comment. + """ originalCommit: Commit - # The original line index in the diff to which the comment applies. + """ + The original line index in the diff to which the comment applies. + """ originalPosition: Int! - # The path to which the comment applies. + """ + The path to which the comment applies. + """ path: String! - # The line index in the diff to which the comment applies. + """ + The line index in the diff to which the comment applies. + """ position: Int - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # The pull request associated with this review comment. + """ + The pull request associated with this review comment. + """ pullRequest: PullRequest! - # The pull request review associated with this review comment. + """ + The pull request review associated with this review comment. + """ pullRequestReview: PullRequestReview - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The comment this is a reply to. + """ + The comment this is a reply to. + """ replyTo: PullRequestReviewComment - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! - # The HTTP path permalink for this review comment. + """ + The HTTP path permalink for this review comment. + """ resourcePath: URI! - # Identifies when the comment was last updated. + """ + Identifies when the comment was last updated. + """ updatedAt: DateTime! - # The HTTP URL permalink for this review comment. + """ + The HTTP URL permalink for this review comment. + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# The connection type for PullRequestReviewComment. +""" +The connection type for PullRequestReviewComment. +""" type PullRequestReviewCommentConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PullRequestReviewCommentEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PullRequestReviewComment] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type PullRequestReviewCommentEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PullRequestReviewComment } -# The connection type for PullRequestReview. +""" +The connection type for PullRequestReview. +""" type PullRequestReviewConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PullRequestReviewEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PullRequestReview] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type PullRequestReviewEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PullRequestReview } -# The possible events to perform on a pull request review. +""" +The possible events to perform on a pull request review. +""" enum PullRequestReviewEvent { - # Submit feedback and approve merging these changes. + """ + Submit feedback and approve merging these changes. + """ APPROVE - # Submit general feedback without explicit approval. + """ + Submit general feedback without explicit approval. + """ COMMENT - # Dismiss review so it now longer effects merging. + """ + Dismiss review so it now longer effects merging. + """ DISMISS - # Submit feedback that must be addressed before merging. + """ + Submit feedback that must be addressed before merging. + """ REQUEST_CHANGES } -# The possible states of a pull request review. +""" +The possible states of a pull request review. +""" enum PullRequestReviewState { - # A review allowing the pull request to merge. + """ + A review allowing the pull request to merge. + """ APPROVED - # A review blocking the pull request from merging. + """ + A review blocking the pull request from merging. + """ CHANGES_REQUESTED - # An informational review. + """ + An informational review. + """ COMMENTED - # A review that has been dismissed. + """ + A review that has been dismissed. + """ DISMISSED - # A review that has not yet been submitted. + """ + A review that has not yet been submitted. + """ PENDING } -# A threaded list of comments for a given pull request. +""" +A threaded list of comments for a given pull request. +""" type PullRequestReviewThread implements Node { - # A list of pull request comments associated with the thread. + """ + A list of pull request comments associated with the thread. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): PullRequestReviewCommentConnection! id: ID! - # Identifies the pull request associated with this thread. + """ + Identifies the pull request associated with this thread. + """ pullRequest: PullRequest! - # Identifies the repository associated with this thread. + """ + Identifies the repository associated with this thread. + """ repository: Repository! } -# The possible states of a pull request. +""" +The possible states of a pull request. +""" enum PullRequestState { - # A pull request that has been closed without being merged. + """ + A pull request that has been closed without being merged. + """ CLOSED - # A pull request that has been closed by being merged. + """ + A pull request that has been closed by being merged. + """ MERGED - # A pull request that is still open. + """ + A pull request that is still open. + """ OPEN } -# The connection type for PullRequestTimelineItem. +""" +The connection type for PullRequestTimelineItem. +""" type PullRequestTimelineConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PullRequestTimelineItemEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PullRequestTimelineItem] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An item in an pull request timeline +""" +An item in an pull request timeline +""" union PullRequestTimelineItem = AssignedEvent | BaseRefForcePushedEvent | ClosedEvent | Commit | CommitCommentThread | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MergedEvent | MilestonedEvent | PullRequestReview | PullRequestReviewComment | PullRequestReviewThread | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent -# An edge in a connection. +""" +An edge in a connection. +""" type PullRequestTimelineItemEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PullRequestTimelineItem } -# A team or user who has the ability to push to a protected branch. +""" +A team or user who has the ability to push to a protected branch. +""" type PushAllowance implements Node { - # The actor that can push. + """ + The actor that can push. + """ actor: PushAllowanceActor id: ID! - # Identifies the protected branch associated with the allowed user or team. + """ + Identifies the protected branch associated with the allowed user or team. + """ protectedBranch: ProtectedBranch! } -# Types that can be an actor. +""" +Types that can be an actor. +""" union PushAllowanceActor = Team | User -# The connection type for PushAllowance. +""" +The connection type for PushAllowance. +""" type PushAllowanceConnection { - # A list of edges. + """ + A list of edges. + """ edges: [PushAllowanceEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [PushAllowance] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type PushAllowanceEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: PushAllowance } -# The query root of GitHub's GraphQL interface. +""" +The query root of GitHub's GraphQL interface. +""" type Query { - # Look up a code of conduct by its key + """ + Look up a code of conduct by its key + """ codeOfConduct( - # The code of conduct's key + """ + The code of conduct's key + """ key: String! ): CodeOfConduct - # Look up a code of conduct by its key + """ + Look up a code of conduct by its key + """ codesOfConduct: [CodeOfConduct] - # Look up an open source license by its key + """ + Look up an open source license by its key + """ license( - # The license's downcased SPDX ID + """ + The license's downcased SPDX ID + """ key: String! ): License - # Return a list of known open source licenses + """ + Return a list of known open source licenses + """ licenses: [License]! - # Return information about the GitHub instance + """ + Return information about the GitHub instance + """ meta: GitHubMetadata! - # Fetches an object given its ID. + """ + Fetches an object given its ID. + """ node( - # ID of the object. + """ + ID of the object. + """ id: ID! ): Node - # Lookup nodes by a list of IDs. + """ + Lookup nodes by a list of IDs. + """ nodes( - # The list of node IDs. + """ + The list of node IDs. + """ ids: [ID!]! ): [Node]! - # Lookup a organization by login. + """ + Lookup a organization by login. + """ organization( - # The organization's login. + """ + The organization's login. + """ login: String! ): Organization - # A list of organizations. + """ + A list of organizations. + """ organizations( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): OrganizationConnection! - # The client's rate limit information. + """ + The client's rate limit information. + """ rateLimit( - # If true, calculate the cost for the query without evaluating it + """ + If true, calculate the cost for the query without evaluating it + """ dryRun: Boolean = false ): RateLimit - # Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object + """ + Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object + """ relay: Query! - # Lookup a given repository by the owner and repository name. + """ + Lookup a given repository by the owner and repository name. + """ repository( - # The name of the repository + """ + The name of the repository + """ name: String! - # The login field of a user or organization + """ + The login field of a user or organization + """ owner: String! ): Repository - # Lookup a repository owner (ie. either a User or an Organization) by login. + """ + Lookup a repository owner (ie. either a User or an Organization) by login. + """ repositoryOwner( - # The username to lookup the owner by. + """ + The username to lookup the owner by. + """ login: String! ): RepositoryOwner - # Lookup resource by a URL. + """ + Lookup resource by a URL. + """ resource( - # The URL. + """ + The URL. + """ url: URI! ): UniformResourceLocatable - # Perform a search across resources. + """ + Perform a search across resources. + """ search( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # The search string to look for. + """ + The search string to look for. + """ query: String! - # The types of search items to search within. + """ + The types of search items to search within. + """ type: SearchType! ): SearchResultItemConnection! - # Look up a topic by name. + """ + Look up a topic by name. + """ topic( - # The topic's name. + """ + The topic's name. + """ name: String! ): Topic - # Lookup a user by login. + """ + Lookup a user by login. + """ user( - # The user's login. + """ + The user's login. + """ login: String! ): User - # The currently authenticated user. + """ + The currently authenticated user. + """ viewer: User! } -# Represents the client's rate limit. +""" +Represents the client's rate limit. +""" type RateLimit { - # The point cost for the current query counting against the rate limit. + """ + The point cost for the current query counting against the rate limit. + """ cost: Int! - # The maximum number of points the client is permitted to consume in a 60 minute window. + """ + The maximum number of points the client is permitted to consume in a 60 minute window. + """ limit: Int! - # The maximum number of nodes this query may return + """ + The maximum number of nodes this query may return + """ nodeCount: Int! - # The number of points remaining in the current rate limit window. + """ + The number of points remaining in the current rate limit window. + """ remaining: Int! - # The time at which the current rate limit window resets in UTC epoch seconds. + """ + The time at which the current rate limit window resets in UTC epoch seconds. + """ resetAt: DateTime! } -# Represents a subject that can be reacted on. +""" +Represents a subject that can be reacted on. +""" interface Reactable { - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! } -# The connection type for User. +""" +The connection type for User. +""" type ReactingUserConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ReactingUserEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a user that's made a reaction. +""" +Represents a user that's made a reaction. +""" type ReactingUserEdge { cursor: String! node: User! - # The moment when the user made the reaction. + """ + The moment when the user made the reaction. + """ reactedAt: DateTime! } -# An emoji reaction to a particular piece of content. +""" +An emoji reaction to a particular piece of content. +""" type Reaction implements Node { - # Identifies the emoji reaction. + """ + Identifies the emoji reaction. + """ content: ReactionContent! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # The reactable piece of content + """ + The reactable piece of content + """ reactable: Reactable! - # Identifies the user who created this reaction. + """ + Identifies the user who created this reaction. + """ user: User } -# A list of reactions that have been left on the subject. +""" +A list of reactions that have been left on the subject. +""" type ReactionConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ReactionEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Reaction] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! - # Whether or not the authenticated user has left a reaction on the subject. + """ + Whether or not the authenticated user has left a reaction on the subject. + """ viewerHasReacted: Boolean! } -# Emojis that can be attached to Issues, Pull Requests and Comments. +""" +Emojis that can be attached to Issues, Pull Requests and Comments. +""" enum ReactionContent { - # Represents the 😕 emoji. + """ + Represents the 😕 emoji. + """ CONFUSED - # Represents the ❤️ emoji. + """ + Represents the ❤️ emoji. + """ HEART - # Represents the 🎉 emoji. + """ + Represents the 🎉 emoji. + """ HOORAY - # Represents the 😄 emoji. + """ + Represents the 😄 emoji. + """ LAUGH - # Represents the 👎 emoji. + """ + Represents the 👎 emoji. + """ THUMBS_DOWN - # Represents the 👍 emoji. + """ + Represents the 👍 emoji. + """ THUMBS_UP } -# An edge in a connection. +""" +An edge in a connection. +""" type ReactionEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Reaction } -# A group of emoji reactions to a particular piece of content. +""" +A group of emoji reactions to a particular piece of content. +""" type ReactionGroup { - # Identifies the emoji reaction. + """ + Identifies the emoji reaction. + """ content: ReactionContent! - # Identifies when the reaction was created. + """ + Identifies when the reaction was created. + """ createdAt: DateTime - # The subject that was reacted to. + """ + The subject that was reacted to. + """ subject: Reactable! - # Users who have reacted to the reaction subject with the emotion represented by this reaction group + """ + Users who have reacted to the reaction subject with the emotion represented by this reaction group + """ users( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ReactingUserConnection! - # Whether or not the authenticated user has left a reaction on the subject. + """ + Whether or not the authenticated user has left a reaction on the subject. + """ viewerHasReacted: Boolean! } -# Ways in which lists of reactions can be ordered upon return. +""" +Ways in which lists of reactions can be ordered upon return. +""" input ReactionOrder { - # The direction in which to order reactions by the specified field. + """ + The direction in which to order reactions by the specified field. + """ direction: OrderDirection! - # The field in which to order reactions by. + """ + The field in which to order reactions by. + """ field: ReactionOrderField! } -# A list of fields that reactions can be ordered by. +""" +A list of fields that reactions can be ordered by. +""" enum ReactionOrderField { - # Allows ordering a list of reactions by when they were created. + """ + Allows ordering a list of reactions by when they were created. + """ CREATED_AT } -# Represents a Git reference. +""" +Represents a Git reference. +""" type Ref implements Node { - # A list of pull requests with this ref as the head ref. + """ + A list of pull requests with this ref as the head ref. + """ associatedPullRequests( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # The base ref name to filter the pull requests by. + """ + The base ref name to filter the pull requests by. + """ baseRefName: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # The head ref name to filter the pull requests by. + """ + The head ref name to filter the pull requests by. + """ headRefName: String - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for pull requests returned from the connection. + """ + Ordering options for pull requests returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the pull requests by. + """ + A list of states to filter the pull requests by. + """ states: [PullRequestState!] ): PullRequestConnection! id: ID! - # The ref name. + """ + The ref name. + """ name: String! - # The ref's prefix, such as `refs/heads/` or `refs/tags/`. + """ + The ref's prefix, such as `refs/heads/` or `refs/tags/`. + """ prefix: String! - # The repository the ref belongs to. + """ + The repository the ref belongs to. + """ repository: Repository! - # The object the ref points to. + """ + The object the ref points to. + """ target: GitObject! } -# The connection type for Ref. +""" +The connection type for Ref. +""" type RefConnection { - # A list of edges. + """ + A list of edges. + """ edges: [RefEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Ref] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type RefEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Ref } -# Ways in which lists of git refs can be ordered upon return. +""" +Ways in which lists of git refs can be ordered upon return. +""" input RefOrder { - # The direction in which to order refs by the specified field. + """ + The direction in which to order refs by the specified field. + """ direction: OrderDirection! - # The field in which to order refs by. + """ + The field in which to order refs by. + """ field: RefOrderField! } -# Properties by which ref connections can be ordered. +""" +Properties by which ref connections can be ordered. +""" enum RefOrderField { - # Order refs by their alphanumeric name + """ + Order refs by their alphanumeric name + """ ALPHABETICAL - # Order refs by underlying commit date if the ref prefix is refs/tags/ + """ + Order refs by underlying commit date if the ref prefix is refs/tags/ + """ TAG_COMMIT_DATE } -# Represents a 'referenced' event on a given `ReferencedSubject`. +""" +Represents a 'referenced' event on a given `ReferencedSubject`. +""" type ReferencedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the commit associated with the 'referenced' event. + """ + Identifies the commit associated with the 'referenced' event. + """ commit: Commit - # Identifies the repository associated with the 'referenced' event. + """ + Identifies the repository associated with the 'referenced' event. + """ commitRepository: Repository! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Reference originated in a different repository. + """ + Reference originated in a different repository. + """ isCrossReference: Boolean! @deprecated(reason: "`isCrossReference` will be renamed. Use `ReferencedEvent.isCrossRepository` instead. Removal on 2018-07-01 UTC.") - # Reference originated in a different repository. + """ + Reference originated in a different repository. + """ isCrossRepository: Boolean! - # Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference. + """ + Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference. + """ isDirectReference: Boolean! - # Object referenced by event. + """ + Object referenced by event. + """ subject: ReferencedSubject! } -# Any referencable object +""" +Any referencable object +""" union ReferencedSubject = Issue | PullRequest -# A release contains the content for a release. -type Release implements Node, UniformResourceLocatable { - # The author of the release +""" +A release contains the content for a release. +""" +type Release implements Node & UniformResourceLocatable { + """ + The author of the release + """ author: User - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the description of the release. + """ + Identifies the description of the release. + """ description: String id: ID! - # Whether or not the release is a draft + """ + Whether or not the release is a draft + """ isDraft: Boolean! - # Whether or not the release is a prerelease + """ + Whether or not the release is a prerelease + """ isPrerelease: Boolean! - # Identifies the title of the release. + """ + Identifies the title of the release. + """ name: String - # Identifies the date and time when the release was created. + """ + Identifies the date and time when the release was created. + """ publishedAt: DateTime - # List of releases assets which are dependent on this release. + """ + List of releases assets which are dependent on this release. + """ releaseAssets( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # A list of names to filter the assets by. + """ + A list of names to filter the assets by. + """ name: String ): ReleaseAssetConnection! - # The HTTP path for this issue + """ + The HTTP path for this issue + """ resourcePath: URI! - # The Git tag the release points to + """ + The Git tag the release points to + """ tag: Ref - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this issue + """ + The HTTP URL for this issue + """ url: URI! } -# A release asset contains the content for a release asset. +""" +A release asset contains the content for a release asset. +""" type ReleaseAsset implements Node { - # The asset's content-type + """ + The asset's content-type + """ contentType: String! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The number of times this asset was downloaded + """ + The number of times this asset was downloaded + """ downloadCount: Int! - # Identifies the URL where you can download the release asset via the browser. + """ + Identifies the URL where you can download the release asset via the browser. + """ downloadUrl: URI! id: ID! - # Identifies the title of the release asset. + """ + Identifies the title of the release asset. + """ name: String! - # Release that the asset is associated with + """ + Release that the asset is associated with + """ release: Release - # The size (in bytes) of the asset + """ + The size (in bytes) of the asset + """ size: Int! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The user that performed the upload + """ + The user that performed the upload + """ uploadedBy: User! - # Identifies the URL of the release asset. + """ + Identifies the URL of the release asset. + """ url: URI! } -# The connection type for ReleaseAsset. +""" +The connection type for ReleaseAsset. +""" type ReleaseAssetConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ReleaseAssetEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ReleaseAsset] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ReleaseAssetEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ReleaseAsset } -# The connection type for Release. +""" +The connection type for Release. +""" type ReleaseConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ReleaseEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Release] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ReleaseEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Release } -# Ways in which lists of releases can be ordered upon return. +""" +Ways in which lists of releases can be ordered upon return. +""" input ReleaseOrder { - # The direction in which to order releases by the specified field. + """ + The direction in which to order releases by the specified field. + """ direction: OrderDirection! - # The field in which to order releases by. + """ + The field in which to order releases by. + """ field: ReleaseOrderField! } -# Properties by which release connections can be ordered. +""" +Properties by which release connections can be ordered. +""" enum ReleaseOrderField { - # Order releases by creation time + """ + Order releases by creation time + """ CREATED_AT - # Order releases alphabetically by name + """ + Order releases alphabetically by name + """ NAME } -# Autogenerated input type of RemoveOutsideCollaborator +""" +Autogenerated input type of RemoveOutsideCollaborator +""" input RemoveOutsideCollaboratorInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The ID of the organization to remove the outside collaborator from. + """ + The ID of the organization to remove the outside collaborator from. + """ organizationId: ID! - # The ID of the outside collaborator to remove. + """ + The ID of the outside collaborator to remove. + """ userId: ID! } -# Autogenerated return type of RemoveOutsideCollaborator +""" +Autogenerated return type of RemoveOutsideCollaborator +""" type RemoveOutsideCollaboratorPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The user that was removed as an outside collaborator. + """ + The user that was removed as an outside collaborator. + """ removedUser: User! } -# Autogenerated input type of RemoveReaction +""" +Autogenerated input type of RemoveReaction +""" input RemoveReactionInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of the emoji to react with. + """ + The name of the emoji to react with. + """ content: ReactionContent! - # The Node ID of the subject to modify. + """ + The Node ID of the subject to modify. + """ subjectId: ID! } -# Autogenerated return type of RemoveReaction +""" +Autogenerated return type of RemoveReaction +""" type RemoveReactionPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The reaction object. + """ + The reaction object. + """ reaction: Reaction! - # The reactable subject. + """ + The reactable subject. + """ subject: Reactable! } -# Autogenerated input type of RemoveStar +""" +Autogenerated input type of RemoveStar +""" input RemoveStarInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Starrable ID to unstar. + """ + The Starrable ID to unstar. + """ starrableId: ID! } -# Autogenerated return type of RemoveStar +""" +Autogenerated return type of RemoveStar +""" type RemoveStarPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The starrable. + """ + The starrable. + """ starrable: Starrable! } -# Represents a 'removed_from_project' event on a given issue or pull request. +""" +Represents a 'removed_from_project' event on a given issue or pull request. +""" type RemovedFromProjectEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! } -# Represents a 'renamed' event on a given issue or pull request +""" +Represents a 'renamed' event on a given issue or pull request +""" type RenamedTitleEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the current title of the issue or pull request. + """ + Identifies the current title of the issue or pull request. + """ currentTitle: String! id: ID! - # Identifies the previous title of the issue or pull request. + """ + Identifies the previous title of the issue or pull request. + """ previousTitle: String! - # Subject that was renamed. + """ + Subject that was renamed. + """ subject: RenamedTitleSubject! } -# An object which has a renamable title +""" +An object which has a renamable title +""" union RenamedTitleSubject = Issue | PullRequest -# Represents a 'reopened' event on any `Closable`. +""" +Represents a 'reopened' event on any `Closable`. +""" type ReopenedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Object that was reopened. + """ + Object that was reopened. + """ closable: Closable! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! } -# A repository contains the content for a project. -type Repository implements Node, ProjectOwner, RepositoryInfo, Starrable, Subscribable, UniformResourceLocatable { - # A list of users that can be assigned to issues in this repository. +""" +A repository contains the content for a project. +""" +type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable { + """ + A list of users that can be assigned to issues in this repository. + """ assignableUsers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # Returns the code of conduct for this repository + """ + Returns the code of conduct for this repository + """ codeOfConduct: CodeOfConduct - # A list of collaborators associated with the repository. + """ + A list of collaborators associated with the repository. + """ collaborators( - # Collaborators affiliation level with a repository. + """ + Collaborators affiliation level with a repository. + """ affiliation: CollaboratorAffiliation - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): RepositoryCollaboratorConnection - # A list of commit comments associated with the repository. + """ + A list of commit comments associated with the repository. + """ commitComments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): CommitCommentConnection! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The Ref associated with the repository's default branch. + """ + The Ref associated with the repository's default branch. + """ defaultBranchRef: Ref - # A list of deploy keys that are on this repository. + """ + A list of deploy keys that are on this repository. + """ deployKeys( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): DeployKeyConnection! - # Deployments associated with the repository + """ + Deployments associated with the repository + """ deployments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Environments to list deployments for + """ + Environments to list deployments for + """ environments: [String!] - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): DeploymentConnection! - # The description of the repository. + """ + The description of the repository. + """ description: String - # The description of the repository rendered to HTML. + """ + The description of the repository rendered to HTML. + """ descriptionHTML: HTML! - # The number of kilobytes this repository occupies on disk. + """ + The number of kilobytes this repository occupies on disk. + """ diskUsage: Int - # Returns how many forks there are of this repository in the whole network. + """ + Returns how many forks there are of this repository in the whole network. + """ forkCount: Int! - # A list of direct forked repositories. + """ + A list of direct forked repositories. + """ forks( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # Indicates if the repository has issues feature enabled. + """ + Indicates if the repository has issues feature enabled. + """ hasIssuesEnabled: Boolean! - # Indicates if the repository has wiki feature enabled. + """ + Indicates if the repository has wiki feature enabled. + """ hasWikiEnabled: Boolean! - # The repository's URL. + """ + The repository's URL. + """ homepageUrl: URI id: ID! - # Indicates if the repository is unmaintained. + """ + Indicates if the repository is unmaintained. + """ isArchived: Boolean! - # Identifies if the repository is a fork. + """ + Identifies if the repository is a fork. + """ isFork: Boolean! - # Indicates if the repository has been locked or not. + """ + Indicates if the repository has been locked or not. + """ isLocked: Boolean! - # Identifies if the repository is a mirror. + """ + Identifies if the repository is a mirror. + """ isMirror: Boolean! - # Identifies if the repository is private. + """ + Identifies if the repository is private. + """ isPrivate: Boolean! - # Returns a single issue from the current repository by number. + """ + Returns a single issue from the current repository by number. + """ issue( - # The number for the issue to be returned. + """ + The number for the issue to be returned. + """ number: Int! ): Issue - # Returns a single issue-like object from the current repository by number. + """ + Returns a single issue-like object from the current repository by number. + """ issueOrPullRequest( - # The number for the issue to be returned. + """ + The number for the issue to be returned. + """ number: Int! ): IssueOrPullRequest - # A list of issues that have been opened in the repository. + """ + A list of issues that have been opened in the repository. + """ issues( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for issues returned from the connection. + """ + Ordering options for issues returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the issues by. + """ + A list of states to filter the issues by. + """ states: [IssueState!] ): IssueConnection! - # Returns a single label by name + """ + Returns a single label by name + """ label( - # Label name + """ + Label name + """ name: String! ): Label - # A list of labels associated with the repository. + """ + A list of labels associated with the repository. + """ labels( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): LabelConnection - # A list containing a breakdown of the language composition of the repository. + """ + A list containing a breakdown of the language composition of the repository. + """ languages( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: LanguageOrder ): LanguageConnection - # The license associated with the repository + """ + The license associated with the repository + """ license: String @deprecated(reason: "Field `license` will be replaced by a more detailed license object. Use `Repository.licenseInfo` instead. Removal on 2017-07-01 UTC.") - # The license associated with the repository + """ + The license associated with the repository + """ licenseInfo: License - # The reason the repository has been locked. + """ + The reason the repository has been locked. + """ lockReason: RepositoryLockReason - # A list of Users that can be mentioned in the context of the repository. + """ + A list of Users that can be mentioned in the context of the repository. + """ mentionableUsers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! - # Returns a single milestone from the current repository by number. + """ + Returns a single milestone from the current repository by number. + """ milestone( - # The number for the milestone to be returned. + """ + The number for the milestone to be returned. + """ number: Int! ): Milestone - # A list of milestones associated with the repository. + """ + A list of milestones associated with the repository. + """ milestones( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for milestones. + """ + Ordering options for milestones. + """ orderBy: MilestoneOrder - # Filter by the state of the milestones. + """ + Filter by the state of the milestones. + """ states: [MilestoneState!] ): MilestoneConnection - # The repository's original mirror URL. + """ + The repository's original mirror URL. + """ mirrorUrl: URI - # The name of the repository. + """ + The name of the repository. + """ name: String! - # The repository's name with owner. + """ + The repository's name with owner. + """ nameWithOwner: String! - # A Git object in the repository + """ + A Git object in the repository + """ object( - # A Git revision expression suitable for rev-parse + """ + A Git revision expression suitable for rev-parse + """ expression: String - # The Git object ID + """ + The Git object ID + """ oid: GitObjectID ): GitObject - # The User owner of the repository. + """ + The User owner of the repository. + """ owner: RepositoryOwner! - # The repository parent, if this is a fork. + """ + The repository parent, if this is a fork. + """ parent: Repository - # The primary language of the repository's code. + """ + The primary language of the repository's code. + """ primaryLanguage: Language - # Find project by number. + """ + Find project by number. + """ project( - # The project number to find. + """ + The project number to find. + """ number: Int! ): Project - # A list of projects under the owner. + """ + A list of projects under the owner. + """ projects( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for projects returned from the connection + """ + Ordering options for projects returned from the connection + """ orderBy: ProjectOrder - # Query to search projects by, currently only searching by name. + """ + Query to search projects by, currently only searching by name. + """ search: String - # A list of states to filter the projects by. + """ + A list of states to filter the projects by. + """ states: [ProjectState!] ): ProjectConnection! - # The HTTP path listing repository's projects + """ + The HTTP path listing repository's projects + """ projectsResourcePath: URI! - # The HTTP URL listing repository's projects + """ + The HTTP URL listing repository's projects + """ projectsUrl: URI! - # A list of protected branches that are on this repository. + """ + A list of protected branches that are on this repository. + """ protectedBranches( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): ProtectedBranchConnection! - # Returns a single pull request from the current repository by number. + """ + Returns a single pull request from the current repository by number. + """ pullRequest( - # The number for the pull request to be returned. + """ + The number for the pull request to be returned. + """ number: Int! ): PullRequest - # A list of pull requests that have been opened in the repository. + """ + A list of pull requests that have been opened in the repository. + """ pullRequests( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # The base ref name to filter the pull requests by. + """ + The base ref name to filter the pull requests by. + """ baseRefName: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # The head ref name to filter the pull requests by. + """ + The head ref name to filter the pull requests by. + """ headRefName: String - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for pull requests returned from the connection. + """ + Ordering options for pull requests returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the pull requests by. + """ + A list of states to filter the pull requests by. + """ states: [PullRequestState!] ): PullRequestConnection! - # Identifies when the repository was last pushed to. + """ + Identifies when the repository was last pushed to. + """ pushedAt: DateTime - # Fetch a given ref from the repository + """ + Fetch a given ref from the repository + """ ref( - # The ref to retrieve.Fully qualified matches are checked in order - # (`refs/heads/master`) before falling back onto checks for short name matches (`master`). + """ + The ref to retrieve.Fully qualified matches are checked in order + (`refs/heads/master`) before falling back onto checks for short name matches (`master`). + """ qualifiedName: String! ): Ref - # Fetch a list of refs from the repository + """ + Fetch a list of refs from the repository + """ refs( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # DEPRECATED: use orderBy. The ordering direction. + """ + DEPRECATED: use orderBy. The ordering direction. + """ direction: OrderDirection - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for refs returned from the connection. + """ + Ordering options for refs returned from the connection. + """ orderBy: RefOrder - # A ref name prefix like `refs/heads/`, `refs/tags/`, etc. + """ + A ref name prefix like `refs/heads/`, `refs/tags/`, etc. + """ refPrefix: String! ): RefConnection - # Lookup a single release given various criteria. + """ + Lookup a single release given various criteria. + """ release( - # The name of the Tag the Release was created from + """ + The name of the Tag the Release was created from + """ tagName: String! ): Release - # List of releases which are dependent on this repository. + """ + List of releases which are dependent on this repository. + """ releases( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: ReleaseOrder ): ReleaseConnection! - # A list of applied repository-topic associations for this repository. + """ + A list of applied repository-topic associations for this repository. + """ repositoryTopics( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): RepositoryTopicConnection! - # The HTTP path for this repository + """ + The HTTP path for this repository + """ resourcePath: URI! - # A description of the repository, rendered to HTML without any links in it. + """ + A description of the repository, rendered to HTML without any links in it. + """ shortDescriptionHTML( - # How many characters to return. + """ + How many characters to return. + """ limit: Int = 200 ): HTML! - # The SSH URL to clone this repository + """ + The SSH URL to clone this repository + """ sshUrl: GitSSHRemote! - # A list of users who have starred this starrable. + """ + A list of users who have starred this starrable. + """ stargazers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: StarOrder ): StargazerConnection! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this repository + """ + The HTTP URL for this repository + """ url: URI! - # Indicates whether the viewer has admin permissions on this repository. + """ + Indicates whether the viewer has admin permissions on this repository. + """ viewerCanAdminister: Boolean! - # Can the current viewer create new projects on this owner. + """ + Can the current viewer create new projects on this owner. + """ viewerCanCreateProjects: Boolean! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Indicates whether the viewer can update the topics of this repository. + """ + Indicates whether the viewer can update the topics of this repository. + """ viewerCanUpdateTopics: Boolean! - # Returns a boolean indicating whether the viewing user has starred this starrable. + """ + Returns a boolean indicating whether the viewing user has starred this starrable. + """ viewerHasStarred: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! - # A list of users watching the repository. + """ + A list of users watching the repository. + """ watchers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserConnection! } -# The affiliation of a user to a repository +""" +The affiliation of a user to a repository +""" enum RepositoryAffiliation { - # Repositories that the user has been added to as a collaborator. + """ + Repositories that the user has been added to as a collaborator. + """ COLLABORATOR - # Repositories that the user has access to through being a member of an - # organization. This includes every repository on every team that the user is on. + """ + Repositories that the user has access to through being a member of an + organization. This includes every repository on every team that the user is on. + """ ORGANIZATION_MEMBER - # Repositories that are owned by the authenticated user. + """ + Repositories that are owned by the authenticated user. + """ OWNER } -# The affiliation type between collaborator and repository. -enum RepositoryCollaboratorAffiliation { - # All collaborators of the repository. - ALL - - # All outside collaborators of an organization-owned repository. - OUTSIDE -} - -# The connection type for User. +""" +The connection type for User. +""" type RepositoryCollaboratorConnection { - # A list of edges. + """ + A list of edges. + """ edges: [RepositoryCollaboratorEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a user who is a collaborator of a repository. +""" +Represents a user who is a collaborator of a repository. +""" type RepositoryCollaboratorEdge { cursor: String! node: User! - # The permission the user has on the repository. + """ + The permission the user has on the repository. + """ permission: RepositoryPermission! } -# A list of repositories owned by the subject. +""" +A list of repositories owned by the subject. +""" type RepositoryConnection { - # A list of edges. + """ + A list of edges. + """ edges: [RepositoryEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Repository] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! - # The total size in kilobytes of all repositories in the connection. + """ + The total size in kilobytes of all repositories in the connection. + """ totalDiskUsage: Int! } -# The reason a repository is listed as 'contributed'. +""" +The reason a repository is listed as 'contributed'. +""" enum RepositoryContributionType { - # Created a commit + """ + Created a commit + """ COMMIT - # Created an issue + """ + Created an issue + """ ISSUE - # Created a pull request + """ + Created a pull request + """ PULL_REQUEST - # Reviewed a pull request + """ + Reviewed a pull request + """ PULL_REQUEST_REVIEW - # Created the repository + """ + Created the repository + """ REPOSITORY } -# An edge in a connection. +""" +An edge in a connection. +""" type RepositoryEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Repository } -# A subset of repository info. +""" +A subset of repository info. +""" interface RepositoryInfo { - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The description of the repository. + """ + The description of the repository. + """ description: String - # The description of the repository rendered to HTML. + """ + The description of the repository rendered to HTML. + """ descriptionHTML: HTML! - # Returns how many forks there are of this repository in the whole network. + """ + Returns how many forks there are of this repository in the whole network. + """ forkCount: Int! - # Indicates if the repository has issues feature enabled. + """ + Indicates if the repository has issues feature enabled. + """ hasIssuesEnabled: Boolean! - # Indicates if the repository has wiki feature enabled. + """ + Indicates if the repository has wiki feature enabled. + """ hasWikiEnabled: Boolean! - # The repository's URL. + """ + The repository's URL. + """ homepageUrl: URI - # Indicates if the repository is unmaintained. + """ + Indicates if the repository is unmaintained. + """ isArchived: Boolean! - # Identifies if the repository is a fork. + """ + Identifies if the repository is a fork. + """ isFork: Boolean! - # Indicates if the repository has been locked or not. + """ + Indicates if the repository has been locked or not. + """ isLocked: Boolean! - # Identifies if the repository is a mirror. + """ + Identifies if the repository is a mirror. + """ isMirror: Boolean! - # Identifies if the repository is private. + """ + Identifies if the repository is private. + """ isPrivate: Boolean! - # The license associated with the repository + """ + The license associated with the repository + """ license: String @deprecated(reason: "Field `license` will be replaced by a more detailed license object. Use `Repository.licenseInfo` instead. Removal on 2017-07-01 UTC.") - # The license associated with the repository + """ + The license associated with the repository + """ licenseInfo: License - # The reason the repository has been locked. + """ + The reason the repository has been locked. + """ lockReason: RepositoryLockReason - # The repository's original mirror URL. + """ + The repository's original mirror URL. + """ mirrorUrl: URI - # The name of the repository. + """ + The name of the repository. + """ name: String! - # The repository's name with owner. + """ + The repository's name with owner. + """ nameWithOwner: String! - # The User owner of the repository. + """ + The User owner of the repository. + """ owner: RepositoryOwner! - # Identifies when the repository was last pushed to. + """ + Identifies when the repository was last pushed to. + """ pushedAt: DateTime - # The HTTP path for this repository + """ + The HTTP path for this repository + """ resourcePath: URI! - # A description of the repository, rendered to HTML without any links in it. + """ + A description of the repository, rendered to HTML without any links in it. + """ shortDescriptionHTML( - # How many characters to return. + """ + How many characters to return. + """ limit: Int = 200 ): HTML! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this repository + """ + The HTTP URL for this repository + """ url: URI! } -# An invitation for a user to be added to a repository. +""" +An invitation for a user to be added to a repository. +""" type RepositoryInvitation implements Node { id: ID! - # The user who received the invitation. + """ + The user who received the invitation. + """ invitee: User! - # The user who created the invitation. + """ + The user who created the invitation. + """ inviter: User! - # The Repository the user is invited to. + """ + The Repository the user is invited to. + """ repository: RepositoryInvitationRepository } -# A subset of repository info shared with potential collaborators. +""" +A subset of repository info shared with potential collaborators. +""" type RepositoryInvitationRepository implements RepositoryInfo { - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The description of the repository. + """ + The description of the repository. + """ description: String - # The description of the repository rendered to HTML. + """ + The description of the repository rendered to HTML. + """ descriptionHTML: HTML! - # Returns how many forks there are of this repository in the whole network. + """ + Returns how many forks there are of this repository in the whole network. + """ forkCount: Int! - # Indicates if the repository has issues feature enabled. + """ + Indicates if the repository has issues feature enabled. + """ hasIssuesEnabled: Boolean! - # Indicates if the repository has wiki feature enabled. + """ + Indicates if the repository has wiki feature enabled. + """ hasWikiEnabled: Boolean! - # The repository's URL. + """ + The repository's URL. + """ homepageUrl: URI - # Indicates if the repository is unmaintained. + """ + Indicates if the repository is unmaintained. + """ isArchived: Boolean! - # Identifies if the repository is a fork. + """ + Identifies if the repository is a fork. + """ isFork: Boolean! - # Indicates if the repository has been locked or not. + """ + Indicates if the repository has been locked or not. + """ isLocked: Boolean! - # Identifies if the repository is a mirror. + """ + Identifies if the repository is a mirror. + """ isMirror: Boolean! - # Identifies if the repository is private. + """ + Identifies if the repository is private. + """ isPrivate: Boolean! - # The license associated with the repository + """ + The license associated with the repository + """ license: String @deprecated(reason: "Field `license` will be replaced by a more detailed license object. Use `Repository.licenseInfo` instead. Removal on 2017-07-01 UTC.") - # The license associated with the repository + """ + The license associated with the repository + """ licenseInfo: License - # The reason the repository has been locked. + """ + The reason the repository has been locked. + """ lockReason: RepositoryLockReason - # The repository's original mirror URL. + """ + The repository's original mirror URL. + """ mirrorUrl: URI - # The name of the repository. + """ + The name of the repository. + """ name: String! - # The repository's name with owner. + """ + The repository's name with owner. + """ nameWithOwner: String! - # The owner of the repository associated with this invitation repository. + """ + The owner of the repository associated with this invitation repository. + """ owner: RepositoryOwner! - # Identifies when the repository was last pushed to. + """ + Identifies when the repository was last pushed to. + """ pushedAt: DateTime - # The HTTP path for this repository + """ + The HTTP path for this repository + """ resourcePath: URI! - # A description of the repository, rendered to HTML without any links in it. + """ + A description of the repository, rendered to HTML without any links in it. + """ shortDescriptionHTML( - # How many characters to return. + """ + How many characters to return. + """ limit: Int = 200 ): HTML! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this repository + """ + The HTTP URL for this repository + """ url: URI! } -# The possible reasons a given repository could be in a locked state. +""" +The possible reasons a given repository could be in a locked state. +""" enum RepositoryLockReason { - # The repository is locked due to a billing related reason. + """ + The repository is locked due to a billing related reason. + """ BILLING - # The repository is locked due to a migration. + """ + The repository is locked due to a migration. + """ MIGRATING - # The repository is locked due to a move. + """ + The repository is locked due to a move. + """ MOVING - # The repository is locked due to a rename. + """ + The repository is locked due to a rename. + """ RENAME } -# Represents a object that belongs to a repository. +""" +Represents a object that belongs to a repository. +""" interface RepositoryNode { - # The repository associated with this node. + """ + The repository associated with this node. + """ repository: Repository! } -# Ordering options for repository connections +""" +Ordering options for repository connections +""" input RepositoryOrder { - # The ordering direction. + """ + The ordering direction. + """ direction: OrderDirection! - # The field to order repositories by. + """ + The field to order repositories by. + """ field: RepositoryOrderField! } -# Properties by which repository connections can be ordered. +""" +Properties by which repository connections can be ordered. +""" enum RepositoryOrderField { - # Order repositories by creation time + """ + Order repositories by creation time + """ CREATED_AT - # Order repositories by name + """ + Order repositories by name + """ NAME - # Order repositories by push time + """ + Order repositories by push time + """ PUSHED_AT - # Order repositories by number of stargazers + """ + Order repositories by number of stargazers + """ STARGAZERS - # Order repositories by update time + """ + Order repositories by update time + """ UPDATED_AT } -# Represents an owner of a Repository. +""" +Represents an owner of a Repository. +""" interface RepositoryOwner { - # A URL pointing to the owner's public avatar. + """ + A URL pointing to the owner's public avatar. + """ avatarUrl( - # The size of the resulting square image. + """ + The size of the resulting square image. + """ size: Int ): URI! id: ID! - # The username used to login. + """ + The username used to login. + """ login: String! - # A list of repositories this user has pinned to their profile + """ + A list of repositories this user has pinned to their profile + """ pinnedRepositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # A list of repositories that the user owns. + """ + A list of repositories that the user owns. + """ repositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they are forks of another repository + """ + If non-null, filters repositories according to whether they are forks of another repository + """ isFork: Boolean - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # Find Repository. + """ + Find Repository. + """ repository( - # Name of Repository to find. + """ + Name of Repository to find. + """ name: String! ): Repository - # The HTTP URL for the owner. + """ + The HTTP URL for the owner. + """ resourcePath: URI! - # The HTTP URL for the owner. + """ + The HTTP URL for the owner. + """ url: URI! } -# The access level to a repository +""" +The access level to a repository +""" enum RepositoryPermission { - # Can read, clone, push, and add collaborators + """ + Can read, clone, push, and add collaborators + """ ADMIN - # Can read and clone + """ + Can read and clone + """ READ - # Can read, clone and push + """ + Can read, clone and push + """ WRITE } -# The privacy of a repository +""" +The privacy of a repository +""" enum RepositoryPrivacy { - # Private + """ + Private + """ PRIVATE - # Public + """ + Public + """ PUBLIC } -# A repository-topic connects a repository to a topic. -type RepositoryTopic implements Node, UniformResourceLocatable { +""" +A repository-topic connects a repository to a topic. +""" +type RepositoryTopic implements Node & UniformResourceLocatable { id: ID! - # The HTTP path for this repository-topic. + """ + The HTTP path for this repository-topic. + """ resourcePath: URI! - # The topic. + """ + The topic. + """ topic: Topic! - # The HTTP URL for this repository-topic. + """ + The HTTP URL for this repository-topic. + """ url: URI! } -# The connection type for RepositoryTopic. +""" +The connection type for RepositoryTopic. +""" type RepositoryTopicConnection { - # A list of edges. + """ + A list of edges. + """ edges: [RepositoryTopicEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [RepositoryTopic] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type RepositoryTopicEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: RepositoryTopic } -# Autogenerated input type of RequestReviews +""" +Autogenerated input type of RequestReviews +""" input RequestReviewsInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the pull request to modify. + """ + The Node ID of the pull request to modify. + """ pullRequestId: ID! - # The Node IDs of the team to request. + """ + The Node IDs of the team to request. + """ teamIds: [ID!] - # Add users to the set rather than replace. + """ + Add users to the set rather than replace. + """ union: Boolean - # The Node IDs of the user to request. + """ + The Node IDs of the user to request. + """ userIds: [ID!] } -# Autogenerated return type of RequestReviews +""" +Autogenerated return type of RequestReviews +""" type RequestReviewsPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The pull request that is getting requests. + """ + The pull request that is getting requests. + """ pullRequest: PullRequest! - # The edge from the pull request to the requested reviewers. + """ + The edge from the pull request to the requested reviewers. + """ requestedReviewersEdge: UserEdge! } -# Types that can be requested reviewers. +""" +Types that can be requested reviewers. +""" union RequestedReviewer = Team | User -# A team or user who has the ability to dismiss a review on a protected branch. +""" +A team or user who has the ability to dismiss a review on a protected branch. +""" type ReviewDismissalAllowance implements Node { - # The actor that can dismiss. + """ + The actor that can dismiss. + """ actor: ReviewDismissalAllowanceActor id: ID! - # Identifies the protected branch associated with the allowed user or team. + """ + Identifies the protected branch associated with the allowed user or team. + """ protectedBranch: ProtectedBranch! } -# Types that can be an actor. +""" +Types that can be an actor. +""" union ReviewDismissalAllowanceActor = Team | User -# The connection type for ReviewDismissalAllowance. +""" +The connection type for ReviewDismissalAllowance. +""" type ReviewDismissalAllowanceConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ReviewDismissalAllowanceEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ReviewDismissalAllowance] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ReviewDismissalAllowanceEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ReviewDismissalAllowance } -# Represents a 'review_dismissed' event on a given issue or pull request. -type ReviewDismissedEvent implements Node, UniformResourceLocatable { - # Identifies the actor who performed the event. +""" +Represents a 'review_dismissed' event on a given issue or pull request. +""" +type ReviewDismissedEvent implements Node & UniformResourceLocatable { + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # Identifies the message associated with the 'review_dismissed' event. + """ + Identifies the message associated with the 'review_dismissed' event. + """ message: String! - # The message associated with the event, rendered to HTML. + """ + The message associated with the event, rendered to HTML. + """ messageHtml: HTML! - # Identifies the previous state of the review with the 'review_dismissed' event. + """ + Identifies the previous state of the review with the 'review_dismissed' event. + """ previousReviewState: PullRequestReviewState! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # Identifies the commit which caused the review to become stale. + """ + Identifies the commit which caused the review to become stale. + """ pullRequestCommit: PullRequestCommit - # The HTTP path for this review dismissed event. + """ + The HTTP path for this review dismissed event. + """ resourcePath: URI! - # Identifies the review associated with the 'review_dismissed' event. + """ + Identifies the review associated with the 'review_dismissed' event. + """ review: PullRequestReview - # The HTTP URL for this review dismissed event. + """ + The HTTP URL for this review dismissed event. + """ url: URI! } -# A request for a user to review a pull request. +""" +A request for a user to review a pull request. +""" type ReviewRequest implements Node { - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") id: ID! - # Identifies the pull request associated with this review request. + """ + Identifies the pull request associated with this review request. + """ pullRequest: PullRequest! - # The reviewer that is requested. + """ + The reviewer that is requested. + """ requestedReviewer: RequestedReviewer - # Identifies the author associated with this review request. + """ + Identifies the author associated with this review request. + """ reviewer: User @deprecated(reason: "Field `reviewer` will be changed in favor of returning a union type. Use `ReviewRequest.requestedReviewer` instead. Removal on 2017-07-01 UTC.") } -# The connection type for ReviewRequest. +""" +The connection type for ReviewRequest. +""" type ReviewRequestConnection { - # A list of edges. + """ + A list of edges. + """ edges: [ReviewRequestEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [ReviewRequest] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type ReviewRequestEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: ReviewRequest } -# Represents an 'review_request_removed' event on a given pull request. +""" +Represents an 'review_request_removed' event on a given pull request. +""" type ReviewRequestRemovedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # Identifies the reviewer whose review request was removed. + """ + Identifies the reviewer whose review request was removed. + """ requestedReviewer: RequestedReviewer - # Identifies the user whose review request was removed. + """ + Identifies the user whose review request was removed. + """ subject: User @deprecated(reason: "`subject` will be renamed. Use `ReviewRequestRemovedEvent.requestedReviewer` instead. Removal on 2018-07-01 UTC.") } -# Represents an 'review_requested' event on a given pull request. +""" +Represents an 'review_requested' event on a given pull request. +""" type ReviewRequestedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # PullRequest referenced by event. + """ + PullRequest referenced by event. + """ pullRequest: PullRequest! - # Identifies the reviewer whose review was requested. + """ + Identifies the reviewer whose review was requested. + """ requestedReviewer: RequestedReviewer - # Identifies the user whose review was requested. + """ + Identifies the user whose review was requested. + """ subject: User @deprecated(reason: "`subject` will be renamed. Use `ReviewRequestedEvent.requestedReviewer` instead. Removal on 2018-07-01 UTC.") } -# The results of a search. +""" +The results of a search. +""" union SearchResultItem = Issue | Organization | PullRequest | Repository | User -# A list of results that matched against a search query. +""" +A list of results that matched against a search query. +""" type SearchResultItemConnection { - # The number of pieces of code that matched the search query. + """ + The number of pieces of code that matched the search query. + """ codeCount: Int! - # A list of edges. + """ + A list of edges. + """ edges: [SearchResultItemEdge] - # The number of issues that matched the search query. + """ + The number of issues that matched the search query. + """ issueCount: Int! - # A list of nodes. + """ + A list of nodes. + """ nodes: [SearchResultItem] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # The number of repositories that matched the search query. + """ + The number of repositories that matched the search query. + """ repositoryCount: Int! - # The number of users that matched the search query. + """ + The number of users that matched the search query. + """ userCount: Int! - # The number of wiki pages that matched the search query. + """ + The number of wiki pages that matched the search query. + """ wikiCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type SearchResultItemEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: SearchResultItem - # Text matches on the result found. + """ + Text matches on the result found. + """ textMatches: [TextMatch] } -# Represents the individual results of a search. +""" +Represents the individual results of a search. +""" enum SearchType { - # Returns results matching issues in repositories. + """ + Returns results matching issues in repositories. + """ ISSUE - # Returns results matching repositories. + """ + Returns results matching repositories. + """ REPOSITORY - # Returns results matching users and organizations on GitHub. + """ + Returns results matching users and organizations on GitHub. + """ USER } -# Represents an S/MIME signature on a Commit or Tag. +""" +Represents an S/MIME signature on a Commit or Tag. +""" type SmimeSignature implements GitSignature { - # Email used to sign this object. + """ + Email used to sign this object. + """ email: String! - # True if the signature is valid and verified by GitHub. + """ + True if the signature is valid and verified by GitHub. + """ isValid: Boolean! - # Payload for GPG signing object. Raw ODB object without the signature header. + """ + Payload for GPG signing object. Raw ODB object without the signature header. + """ payload: String! - # ASCII-armored signature header from object. + """ + ASCII-armored signature header from object. + """ signature: String! - # GitHub user corresponding to the email signing this commit. + """ + GitHub user corresponding to the email signing this commit. + """ signer: User - # The state of this signature. `VALID` if signature is valid and verified by - # GitHub, otherwise represents reason why signature is considered invalid. + """ + The state of this signature. `VALID` if signature is valid and verified by + GitHub, otherwise represents reason why signature is considered invalid. + """ state: GitSignatureState! } -# Ways in which star connections can be ordered. +""" +Ways in which star connections can be ordered. +""" input StarOrder { - # The direction in which to order nodes. + """ + The direction in which to order nodes. + """ direction: OrderDirection! - # The field in which to order nodes by. + """ + The field in which to order nodes by. + """ field: StarOrderField! } -# Properties by which star connections can be ordered. +""" +Properties by which star connections can be ordered. +""" enum StarOrderField { - # Allows ordering a list of stars by when they were created. + """ + Allows ordering a list of stars by when they were created. + """ STARRED_AT } -# The connection type for User. +""" +The connection type for User. +""" type StargazerConnection { - # A list of edges. + """ + A list of edges. + """ edges: [StargazerEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a user that's starred a repository. +""" +Represents a user that's starred a repository. +""" type StargazerEdge { cursor: String! node: User! - # Identifies when the item was starred. + """ + Identifies when the item was starred. + """ starredAt: DateTime! } -# Things that can be starred. +""" +Things that can be starred. +""" interface Starrable { id: ID! - # A list of users who have starred this starrable. + """ + A list of users who have starred this starrable. + """ stargazers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: StarOrder ): StargazerConnection! - # Returns a boolean indicating whether the viewing user has starred this starrable. + """ + Returns a boolean indicating whether the viewing user has starred this starrable. + """ viewerHasStarred: Boolean! } -# The connection type for Repository. +""" +The connection type for Repository. +""" type StarredRepositoryConnection { - # A list of edges. + """ + A list of edges. + """ edges: [StarredRepositoryEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Repository] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a starred repository. +""" +Represents a starred repository. +""" type StarredRepositoryEdge { cursor: String! node: Repository! - # Identifies when the item was starred. + """ + Identifies when the item was starred. + """ starredAt: DateTime! } -# Represents a commit status. +""" +Represents a commit status. +""" type Status implements Node { - # The commit this status is attached to. + """ + The commit this status is attached to. + """ commit: Commit - # Looks up an individual status context by context name. + """ + Looks up an individual status context by context name. + """ context( - # The context name. + """ + The context name. + """ name: String! ): StatusContext - # The individual status contexts for this commit. + """ + The individual status contexts for this commit. + """ contexts: [StatusContext!]! id: ID! - # The combined commit status. + """ + The combined commit status. + """ state: StatusState! } -# Represents an individual commit status context +""" +Represents an individual commit status context +""" type StatusContext implements Node { - # This commit this status context is attached to. + """ + This commit this status context is attached to. + """ commit: Commit - # The name of this status context. + """ + The name of this status context. + """ context: String! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The actor who created this status context. + """ + The actor who created this status context. + """ creator: Actor - # The description for this status context. + """ + The description for this status context. + """ description: String id: ID! - # The state of this status context. + """ + The state of this status context. + """ state: StatusState! - # The URL for this status context. + """ + The URL for this status context. + """ targetUrl: URI } -# The possible commit status states. +""" +The possible commit status states. +""" enum StatusState { - # Status is errored. + """ + Status is errored. + """ ERROR - # Status is expected. + """ + Status is expected. + """ EXPECTED - # Status is failing. + """ + Status is failing. + """ FAILURE - # Status is pending. + """ + Status is pending. + """ PENDING - # Status is successful. + """ + Status is successful. + """ SUCCESS } -# Autogenerated input type of SubmitPullRequestReview +""" +Autogenerated input type of SubmitPullRequestReview +""" input SubmitPullRequestReviewInput { - # The text field to set on the Pull Request Review. + """ + The text field to set on the Pull Request Review. + """ body: String - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The event to send to the Pull Request Review. + """ + The event to send to the Pull Request Review. + """ event: PullRequestReviewEvent! - # The Pull Request Review ID to submit. + """ + The Pull Request Review ID to submit. + """ pullRequestReviewId: ID! } -# Autogenerated return type of SubmitPullRequestReview +""" +Autogenerated return type of SubmitPullRequestReview +""" type SubmitPullRequestReviewPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The submitted pull request review. + """ + The submitted pull request review. + """ pullRequestReview: PullRequestReview! } -# Entities that can be subscribed to for web and email notifications. +""" +Entities that can be subscribed to for web and email notifications. +""" interface Subscribable { id: ID! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! } -# Represents a 'subscribed' event on a given `Subscribable`. +""" +Represents a 'subscribed' event on a given `Subscribable`. +""" type SubscribedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Object referenced by event. + """ + Object referenced by event. + """ subscribable: Subscribable! } -# The possible states of a subscription. +""" +The possible states of a subscription. +""" enum SubscriptionState { - # The User is never notified. + """ + The User is never notified. + """ IGNORED - # The User is notified of all conversations. + """ + The User is notified of all conversations. + """ SUBSCRIBED - # Subscriptions are currently unavailable + """ + Subscriptions are currently unavailable + """ UNAVAILABLE - # The User is only notified when particpating or @mentioned. + """ + The User is only notified when particpating or @mentioned. + """ UNSUBSCRIBED } -# A suggestion to review a pull request based on a user's commit history and review comments. +""" +A suggestion to review a pull request based on a user's commit history and review comments. +""" type SuggestedReviewer { - # Is this suggestion based on past commits? + """ + Is this suggestion based on past commits? + """ isAuthor: Boolean! - # Is this suggestion based on past review comments? + """ + Is this suggestion based on past review comments? + """ isCommenter: Boolean! - # Identifies the user suggested to review the pull request. + """ + Identifies the user suggested to review the pull request. + """ reviewer: User! } -# Represents a Git tag. -type Tag implements GitObject, Node { - # An abbreviated version of the Git object ID +""" +Represents a Git tag. +""" +type Tag implements GitObject & Node { + """ + An abbreviated version of the Git object ID + """ abbreviatedOid: String! - # The HTTP path for this Git object + """ + The HTTP path for this Git object + """ commitResourcePath: URI! - # The HTTP URL for this Git object + """ + The HTTP URL for this Git object + """ commitUrl: URI! id: ID! - # The Git tag message. + """ + The Git tag message. + """ message: String - # The Git tag name. + """ + The Git tag name. + """ name: String! - # The Git object ID + """ + The Git object ID + """ oid: GitObjectID! - # The Repository the Git object belongs to + """ + The Repository the Git object belongs to + """ repository: Repository! - # Details about the tag author. + """ + Details about the tag author. + """ tagger: GitActor - # The Git object the tag points to. + """ + The Git object the tag points to. + """ target: GitObject! } -# A team of users in an organization. -type Team implements Node, Subscribable { - # A list of teams that are ancestors of this team. +""" +A team of users in an organization. +""" +type Team implements Node & Subscribable { + """ + A list of teams that are ancestors of this team. + """ ancestors( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): TeamConnection! - # A URL pointing to the team's avatar. + """ + A URL pointing to the team's avatar. + """ avatarUrl( - # The size in pixels of the resulting square image. + """ + The size in pixels of the resulting square image. + """ size: Int = 400 ): URI - # List of child teams belonging to this team + """ + List of child teams belonging to this team + """ childTeams( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Whether to list immediate child teams or all descendant child teams. + """ + Whether to list immediate child teams or all descendant child teams. + """ immediateOnly: Boolean = true - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: TeamOrder - # User logins to filter by + """ + User logins to filter by + """ userLogins: [String!] ): TeamConnection! - # The slug corresponding to the organization and team. + """ + The slug corresponding to the organization and team. + """ combinedSlug: String! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The description of the team. + """ + The description of the team. + """ description: String - # Find a team discussion by its number. + """ + Find a team discussion by its number. + """ discussion( - # The sequence number of the discussion to find. + """ + The sequence number of the discussion to find. + """ number: Int! ): TeamDiscussion @preview(toggledBy: "echo-preview") - # A list of team discussions. + """ + A list of team discussions. + """ discussions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If provided, filters discussions according to whether or not they are pinned. + """ + If provided, filters discussions according to whether or not they are pinned. + """ isPinned: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: TeamDiscussionOrder ): TeamDiscussionConnection! @preview(toggledBy: "echo-preview") - # The HTTP path for team discussions + """ + The HTTP path for team discussions + """ discussionsResourcePath: URI! @preview(toggledBy: "echo-preview") - # The HTTP URL for team discussions + """ + The HTTP URL for team discussions + """ discussionsUrl: URI! @preview(toggledBy: "echo-preview") - # The HTTP path for editing this team + """ + The HTTP path for editing this team + """ editTeamResourcePath: URI! - # The HTTP URL for editing this team + """ + The HTTP URL for editing this team + """ editTeamUrl: URI! id: ID! - # A list of pending invitations for users to this team + """ + A list of pending invitations for users to this team + """ invitations( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): OrganizationInvitationConnection - # A list of users who are members of this team. + """ + A list of users who are members of this team. + """ members( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Filter by membership type + """ + Filter by membership type + """ membership: TeamMembershipType = ALL - # The search string to look for. + """ + The search string to look for. + """ query: String - # Filter by team member role + """ + Filter by team member role + """ role: TeamMemberRole ): TeamMemberConnection! - # The HTTP path for the team' members + """ + The HTTP path for the team' members + """ membersResourcePath: URI! - # The HTTP URL for the team' members + """ + The HTTP URL for the team' members + """ membersUrl: URI! - # The name of the team. + """ + The name of the team. + """ name: String! - # The HTTP path creating a new team + """ + The HTTP path creating a new team + """ newTeamResourcePath: URI! - # The HTTP URL creating a new team + """ + The HTTP URL creating a new team + """ newTeamUrl: URI! - # The organization that owns this team. + """ + The organization that owns this team. + """ organization: Organization! - # The parent team of the team. + """ + The parent team of the team. + """ parentTeam: Team - # The level of privacy the team has. + """ + The level of privacy the team has. + """ privacy: TeamPrivacy! - # A list of repositories this team has access to. + """ + A list of repositories this team has access to. + """ repositories( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for the connection. + """ + Order for the connection. + """ orderBy: TeamRepositoryOrder - # The search string to look for. + """ + The search string to look for. + """ query: String ): TeamRepositoryConnection! - # The HTTP path for this team's repositories + """ + The HTTP path for this team's repositories + """ repositoriesResourcePath: URI! - # The HTTP URL for this team's repositories + """ + The HTTP URL for this team's repositories + """ repositoriesUrl: URI! - # The HTTP path for this team + """ + The HTTP path for this team + """ resourcePath: URI! - # The slug corresponding to the team. + """ + The slug corresponding to the team. + """ slug: String! - # The HTTP path for this team's teams + """ + The HTTP path for this team's teams + """ teamsResourcePath: URI! - # The HTTP URL for this team's teams + """ + The HTTP URL for this team's teams + """ teamsUrl: URI! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this team + """ + The HTTP URL for this team + """ url: URI! - # Team is adminable by the viewer. + """ + Team is adminable by the viewer. + """ viewerCanAdminister: Boolean! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! } -# The connection type for Team. +""" +The connection type for Team. +""" type TeamConnection { - # A list of edges. + """ + A list of edges. + """ edges: [TeamEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Team] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# A team discussion. -type TeamDiscussion implements Comment, Deletable, Node, Reactable, Subscribable, UniformResourceLocatable, Updatable, UpdatableComment @preview(toggledBy: "echo-preview") { - # The actor who authored the comment. +""" +A team discussion. +""" +type TeamDiscussion implements Comment & Deletable & Node & Reactable & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment @preview(toggledBy: "echo-preview") { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the discussion's team. + """ + Author's association with the discussion's team. + """ authorAssociation: CommentAuthorAssociation! - # The comment body as Markdown. + """ + The comment body as Markdown. + """ body: String! - # The discussion body rendered to HTML. + """ + The discussion body rendered to HTML. + """ bodyHTML: HTML! - # Identifies the discussion body hash. + """ + Identifies the discussion body hash. + """ bodyVersion: String! - # A list of comments on this discussion. + """ + A list of comments on this discussion. + """ comments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # When provided, filters the connection such that results begin with the comment with this number. + """ + When provided, filters the connection such that results begin with the comment with this number. + """ fromComment: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: TeamDiscussionCommentOrder ): TeamDiscussionCommentConnection! - # The HTTP path for discussion comments + """ + The HTTP path for discussion comments + """ commentsResourcePath: URI! - # The HTTP URL for discussion comments + """ + The HTTP URL for discussion comments + """ commentsUrl: URI! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # Whether or not the discussion is pinned. + """ + Whether or not the discussion is pinned. + """ isPinned: Boolean! - # Whether or not the discussion is only visible to team members and org admins. + """ + Whether or not the discussion is only visible to team members and org admins. + """ isPrivate: Boolean! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies the discussion within its team. + """ + Identifies the discussion within its team. + """ number: Int! - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The HTTP path for this discussion + """ + The HTTP path for this discussion + """ resourcePath: URI! - # The team that defines the context of this discussion. + """ + The team that defines the context of this discussion. + """ team: Team! - # The title of the discussion + """ + The title of the discussion + """ title: String! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this discussion + """ + The HTTP URL for this discussion + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Whether or not the current viewer can pin this discussion. + """ + Whether or not the current viewer can pin this discussion. + """ viewerCanPin: Boolean! - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the viewer is able to change their subscription status for the repository. + """ + Check if the viewer is able to change their subscription status for the repository. + """ viewerCanSubscribe: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! - # Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ + Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. + """ viewerSubscription: SubscriptionState! } -# A comment on a team discussion. -type TeamDiscussionComment implements Comment, Deletable, Node, Reactable, UniformResourceLocatable, Updatable, UpdatableComment @preview(toggledBy: "echo-preview") { - # The actor who authored the comment. +""" +A comment on a team discussion. +""" +type TeamDiscussionComment implements Comment & Deletable & Node & Reactable & UniformResourceLocatable & Updatable & UpdatableComment @preview(toggledBy: "echo-preview") { + """ + The actor who authored the comment. + """ author: Actor - # Author's association with the comment's team. + """ + Author's association with the comment's team. + """ authorAssociation: CommentAuthorAssociation! - # The comment body as Markdown. + """ + The comment body as Markdown. + """ body: String! - # The comment body rendered to HTML. + """ + The comment body rendered to HTML. + """ bodyHTML: HTML! - # The current version of the body content. + """ + The current version of the body content. + """ bodyVersion: String! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Check if this comment was created via an email reply. + """ + Check if this comment was created via an email reply. + """ createdViaEmail: Boolean! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The discussion this comment is about. + """ + The discussion this comment is about. + """ discussion: TeamDiscussion! - # The actor who edited the comment. + """ + The actor who edited the comment. + """ editor: Actor id: ID! - # The moment the editor made the last edit + """ + The moment the editor made the last edit + """ lastEditedAt: DateTime - # Identifies the comment number. + """ + Identifies the comment number. + """ number: Int! - # Identifies when the comment was published at. + """ + Identifies when the comment was published at. + """ publishedAt: DateTime - # A list of reactions grouped by content left on the subject. + """ + A list of reactions grouped by content left on the subject. + """ reactionGroups: [ReactionGroup!] - # A list of Reactions left on the Issue. + """ + A list of Reactions left on the Issue. + """ reactions( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Allows filtering Reactions by emoji. + """ + Allows filtering Reactions by emoji. + """ content: ReactionContent - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Allows specifying the order in which reactions are returned. + """ + Allows specifying the order in which reactions are returned. + """ orderBy: ReactionOrder ): ReactionConnection! - # The HTTP path for this comment + """ + The HTTP path for this comment + """ resourcePath: URI! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this comment + """ + The HTTP URL for this comment + """ url: URI! - # A list of edits to this content. + """ + A list of edits to this content. + """ userContentEdits( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): UserContentEditConnection - # Check if the current viewer can delete this object. + """ + Check if the current viewer can delete this object. + """ viewerCanDelete: Boolean! - # Can user react to this subject + """ + Can user react to this subject + """ viewerCanReact: Boolean! - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! - # Did the viewer author this comment. + """ + Did the viewer author this comment. + """ viewerDidAuthor: Boolean! } -# The connection type for TeamDiscussionComment. +""" +The connection type for TeamDiscussionComment. +""" type TeamDiscussionCommentConnection @preview(toggledBy: "echo-preview") { - # A list of edges. + """ + A list of edges. + """ edges: [TeamDiscussionCommentEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [TeamDiscussionComment] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type TeamDiscussionCommentEdge @preview(toggledBy: "echo-preview") { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: TeamDiscussionComment } -# Ways in which team discussion comment connections can be ordered. +""" +Ways in which team discussion comment connections can be ordered. +""" input TeamDiscussionCommentOrder @preview(toggledBy: "echo-preview") { - # The direction in which to order nodes. + """ + The direction in which to order nodes. + """ direction: OrderDirection! - # The field by which to order nodes. + """ + The field by which to order nodes. + """ field: TeamDiscussionCommentOrderField! } -# Properties by which team discussion comment connections can be ordered. +""" +Properties by which team discussion comment connections can be ordered. +""" enum TeamDiscussionCommentOrderField @preview(toggledBy: "echo-preview") { - # Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering). + """ + Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering). + """ NUMBER } -# The connection type for TeamDiscussion. +""" +The connection type for TeamDiscussion. +""" type TeamDiscussionConnection @preview(toggledBy: "echo-preview") { - # A list of edges. + """ + A list of edges. + """ edges: [TeamDiscussionEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [TeamDiscussion] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type TeamDiscussionEdge @preview(toggledBy: "echo-preview") { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: TeamDiscussion } -# Ways in which team discussion connections can be ordered. +""" +Ways in which team discussion connections can be ordered. +""" input TeamDiscussionOrder @preview(toggledBy: "echo-preview") { - # The direction in which to order nodes. + """ + The direction in which to order nodes. + """ direction: OrderDirection! - # The field by which to order nodes. + """ + The field by which to order nodes. + """ field: TeamDiscussionOrderField! } -# Properties by which team discussion connections can be ordered. +""" +Properties by which team discussion connections can be ordered. +""" enum TeamDiscussionOrderField @preview(toggledBy: "echo-preview") { - # Allows chronological ordering of team discussions. + """ + Allows chronological ordering of team discussions. + """ CREATED_AT } -# An edge in a connection. +""" +An edge in a connection. +""" type TeamEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: Team } -# The connection type for User. +""" +The connection type for User. +""" type TeamMemberConnection { - # A list of edges. + """ + A list of edges. + """ edges: [TeamMemberEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a user who is a member of a team. +""" +Represents a user who is a member of a team. +""" type TeamMemberEdge { cursor: String! - # The HTTP path to the organization's member access page. + """ + The HTTP path to the organization's member access page. + """ memberAccessResourcePath: URI! - # The HTTP URL to the organization's member access page. + """ + The HTTP URL to the organization's member access page. + """ memberAccessUrl: URI! node: User! - # The role the member has on the team. + """ + The role the member has on the team. + """ role: TeamMemberRole! } -# The possible team member roles; either 'maintainer' or 'member'. +""" +The possible team member roles; either 'maintainer' or 'member'. +""" enum TeamMemberRole { - # A team maintainer has permission to add and remove team members. + """ + A team maintainer has permission to add and remove team members. + """ MAINTAINER - # A team member has no administrative permissions on the team. + """ + A team member has no administrative permissions on the team. + """ MEMBER } -# Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL. +""" +Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL. +""" enum TeamMembershipType { - # Includes immediate and child team members for the team. + """ + Includes immediate and child team members for the team. + """ ALL - # Includes only child team members for the team. + """ + Includes only child team members for the team. + """ CHILD_TEAM - # Includes only immediate members of the team. + """ + Includes only immediate members of the team. + """ IMMEDIATE } -# Ways in which team connections can be ordered. +""" +Ways in which team connections can be ordered. +""" input TeamOrder { - # The direction in which to order nodes. + """ + The direction in which to order nodes. + """ direction: OrderDirection! - # The field in which to order nodes by. + """ + The field in which to order nodes by. + """ field: TeamOrderField! } -# Properties by which team connections can be ordered. +""" +Properties by which team connections can be ordered. +""" enum TeamOrderField { - # Allows ordering a list of teams by name. + """ + Allows ordering a list of teams by name. + """ NAME } -# The possible team privacy values. +""" +The possible team privacy values. +""" enum TeamPrivacy { - # A secret team can only be seen by its members. + """ + A secret team can only be seen by its members. + """ SECRET - # A visible team can be seen and @mentioned by every member of the organization. + """ + A visible team can be seen and @mentioned by every member of the organization. + """ VISIBLE } -# The connection type for Repository. +""" +The connection type for Repository. +""" type TeamRepositoryConnection { - # A list of edges. + """ + A list of edges. + """ edges: [TeamRepositoryEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [Repository] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# Represents a team repository. +""" +Represents a team repository. +""" type TeamRepositoryEdge { cursor: String! node: Repository! - # The permission level the team has on the repository + """ + The permission level the team has on the repository + """ permission: RepositoryPermission! } -# Ordering options for team repository connections +""" +Ordering options for team repository connections +""" input TeamRepositoryOrder { - # The ordering direction. + """ + The ordering direction. + """ direction: OrderDirection! - # The field to order repositories by. + """ + The field to order repositories by. + """ field: TeamRepositoryOrderField! } -# Properties by which team repository connections can be ordered. +""" +Properties by which team repository connections can be ordered. +""" enum TeamRepositoryOrderField { - # Order repositories by creation time + """ + Order repositories by creation time + """ CREATED_AT - # Order repositories by name + """ + Order repositories by name + """ NAME - # Order repositories by permission + """ + Order repositories by permission + """ PERMISSION - # Order repositories by push time + """ + Order repositories by push time + """ PUSHED_AT - # Order repositories by number of stargazers + """ + Order repositories by number of stargazers + """ STARGAZERS - # Order repositories by update time + """ + Order repositories by update time + """ UPDATED_AT } -# The role of a user on a team. +""" +The role of a user on a team. +""" enum TeamRole { - # User has admin rights on the team. + """ + User has admin rights on the team. + """ ADMIN - # User is a member of the team. + """ + User is a member of the team. + """ MEMBER } -# A text match within a search result. +""" +A text match within a search result. +""" type TextMatch { - # The specific text fragment within the property matched on. + """ + The specific text fragment within the property matched on. + """ fragment: String! - # Highlights within the matched fragment. + """ + Highlights within the matched fragment. + """ highlights: [TextMatchHighlight]! - # The property matched on. + """ + The property matched on. + """ property: String! } -# Represents a single highlight in a search result match. +""" +Represents a single highlight in a search result match. +""" type TextMatchHighlight { - # The indice in the fragment where the matched text begins. + """ + The indice in the fragment where the matched text begins. + """ beginIndice: Int! - # The indice in the fragment where the matched text ends. + """ + The indice in the fragment where the matched text ends. + """ endIndice: Int! - # The text matched. + """ + The text matched. + """ text: String! } -# A topic aggregates entities that are related to a subject. +""" +A topic aggregates entities that are related to a subject. +""" type Topic implements Node { id: ID! - # The topic's name. + """ + The topic's name. + """ name: String! - # A list of related topics, including aliases of this topic, sorted with the most relevant - # first. + """ + A list of related topics, including aliases of this topic, sorted with the most relevant + first. + """ relatedTopics: [Topic!]! } -# The connection type for Topic. -type TopicConnection { - # A list of edges. - edges: [TopicEdge] - - # A list of nodes. - nodes: [Topic] - - # Information to aid in pagination. - pageInfo: PageInfo! - - # Identifies the total count of items in the connection. - totalCount: Int! -} - -# An edge in a connection. -type TopicEdge { - # A cursor for use in pagination. - cursor: String! - - # The item at the end of the edge. - node: Topic -} - -# Reason that the suggested topic is declined. +""" +Reason that the suggested topic is declined. +""" enum TopicSuggestionDeclineReason { - # The suggested topic is not relevant to the repository. + """ + The suggested topic is not relevant to the repository. + """ NOT_RELEVANT - # The viewer does not like the suggested topic. + """ + The viewer does not like the suggested topic. + """ PERSONAL_PREFERENCE - # The suggested topic is too general for the repository. + """ + The suggested topic is too general for the repository. + """ TOO_GENERAL - # The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1). + """ + The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1). + """ TOO_SPECIFIC } -# Represents a Git tree. -type Tree implements GitObject, Node { - # An abbreviated version of the Git object ID +""" +Represents a Git tree. +""" +type Tree implements GitObject & Node { + """ + An abbreviated version of the Git object ID + """ abbreviatedOid: String! - # The HTTP path for this Git object + """ + The HTTP path for this Git object + """ commitResourcePath: URI! - # The HTTP URL for this Git object + """ + The HTTP URL for this Git object + """ commitUrl: URI! - # A list of tree entries. + """ + A list of tree entries. + """ entries: [TreeEntry!] id: ID! - # The Git object ID + """ + The Git object ID + """ oid: GitObjectID! - # The Repository the Git object belongs to + """ + The Repository the Git object belongs to + """ repository: Repository! } -# Represents a Git tree entry. +""" +Represents a Git tree entry. +""" type TreeEntry { - # Entry file mode. + """ + Entry file mode. + """ mode: Int! - # Entry file name. + """ + Entry file name. + """ name: String! - # Entry file object. + """ + Entry file object. + """ object: GitObject - # Entry file Git object ID. + """ + Entry file Git object ID. + """ oid: GitObjectID! - # The Repository the tree entry belongs to + """ + The Repository the tree entry belongs to + """ repository: Repository! - # Entry file type. + """ + Entry file type. + """ type: String! } -# An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. +""" +An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. +""" scalar URI -# Represents an 'unassigned' event on any assignable object. +""" +Represents an 'unassigned' event on any assignable object. +""" type UnassignedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the assignable associated with the event. + """ + Identifies the assignable associated with the event. + """ assignable: Assignable! - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the subject (user) who was unassigned. + """ + Identifies the subject (user) who was unassigned. + """ user: User } -# Represents a type that can be retrieved by a URL. +""" +Represents a type that can be retrieved by a URL. +""" interface UniformResourceLocatable { - # The HTML path to this resource. + """ + The HTML path to this resource. + """ resourcePath: URI! - # The URL to this resource. + """ + The URL to this resource. + """ url: URI! } -# Represents an unknown signature on a Commit or Tag. +""" +Represents an unknown signature on a Commit or Tag. +""" type UnknownSignature implements GitSignature { - # Email used to sign this object. + """ + Email used to sign this object. + """ email: String! - # True if the signature is valid and verified by GitHub. + """ + True if the signature is valid and verified by GitHub. + """ isValid: Boolean! - # Payload for GPG signing object. Raw ODB object without the signature header. + """ + Payload for GPG signing object. Raw ODB object without the signature header. + """ payload: String! - # ASCII-armored signature header from object. + """ + ASCII-armored signature header from object. + """ signature: String! - # GitHub user corresponding to the email signing this commit. + """ + GitHub user corresponding to the email signing this commit. + """ signer: User - # The state of this signature. `VALID` if signature is valid and verified by - # GitHub, otherwise represents reason why signature is considered invalid. + """ + The state of this signature. `VALID` if signature is valid and verified by + GitHub, otherwise represents reason why signature is considered invalid. + """ state: GitSignatureState! } -# Represents an 'unlabeled' event on a given issue or pull request. +""" +Represents an 'unlabeled' event on a given issue or pull request. +""" type UnlabeledEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Identifies the label associated with the 'unlabeled' event. + """ + Identifies the label associated with the 'unlabeled' event. + """ label: Label! - # Identifies the `Labelable` associated with the event. + """ + Identifies the `Labelable` associated with the event. + """ labelable: Labelable! } -# Represents an 'unlocked' event on a given issue or pull request. +""" +Represents an 'unlocked' event on a given issue or pull request. +""" type UnlockedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Object that was unlocked. + """ + Object that was unlocked. + """ lockable: Lockable! } -# Represents an 'unsubscribed' event on a given `Subscribable`. +""" +Represents an 'unsubscribed' event on a given `Subscribable`. +""" type UnsubscribedEvent implements Node { - # Identifies the actor who performed the event. + """ + Identifies the actor who performed the event. + """ actor: Actor - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! id: ID! - # Object referenced by event. + """ + Object referenced by event. + """ subscribable: Subscribable! } -# Entities that can be updated. +""" +Entities that can be updated. +""" interface Updatable { - # Check if the current viewer can update this object. + """ + Check if the current viewer can update this object. + """ viewerCanUpdate: Boolean! } -# Comments that can be updated. +""" +Comments that can be updated. +""" interface UpdatableComment { - # Reasons why the current viewer can not update this comment. + """ + Reasons why the current viewer can not update this comment. + """ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]! } -# Autogenerated input type of UpdateProjectCard +""" +Autogenerated input type of UpdateProjectCard +""" input UpdateProjectCardInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The note of ProjectCard. + """ + The note of ProjectCard. + """ note: String! - # The ProjectCard ID to update. + """ + The ProjectCard ID to update. + """ projectCardId: ID! } -# Autogenerated return type of UpdateProjectCard +""" +Autogenerated return type of UpdateProjectCard +""" type UpdateProjectCardPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated ProjectCard. + """ + The updated ProjectCard. + """ projectCard: ProjectCard! } -# Autogenerated input type of UpdateProjectColumn +""" +Autogenerated input type of UpdateProjectColumn +""" input UpdateProjectColumnInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of project column. + """ + The name of project column. + """ name: String! - # The ProjectColumn ID to update. + """ + The ProjectColumn ID to update. + """ projectColumnId: ID! } -# Autogenerated return type of UpdateProjectColumn +""" +Autogenerated return type of UpdateProjectColumn +""" type UpdateProjectColumnPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated project column. + """ + The updated project column. + """ projectColumn: ProjectColumn! } -# Autogenerated input type of UpdateProject +""" +Autogenerated input type of UpdateProject +""" input UpdateProjectInput { - # The description of project. + """ + The description of project. + """ body: String - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The name of project. + """ + The name of project. + """ name: String - # The Project ID to update. + """ + The Project ID to update. + """ projectId: ID! - # Whether the project is public or not. + """ + Whether the project is public or not. + """ public: Boolean - # Whether the project is open or closed. + """ + Whether the project is open or closed. + """ state: ProjectState } -# Autogenerated return type of UpdateProject +""" +Autogenerated return type of UpdateProject +""" type UpdateProjectPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated project. + """ + The updated project. + """ project: Project! } -# Autogenerated input type of UpdatePullRequestReviewComment +""" +Autogenerated input type of UpdatePullRequestReviewComment +""" input UpdatePullRequestReviewCommentInput { - # The text of the comment. + """ + The text of the comment. + """ body: String! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the comment to modify. + """ + The Node ID of the comment to modify. + """ pullRequestReviewCommentId: ID! } -# Autogenerated return type of UpdatePullRequestReviewComment +""" +Autogenerated return type of UpdatePullRequestReviewComment +""" type UpdatePullRequestReviewCommentPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated comment. + """ + The updated comment. + """ pullRequestReviewComment: PullRequestReviewComment! } -# Autogenerated input type of UpdatePullRequestReview +""" +Autogenerated input type of UpdatePullRequestReview +""" input UpdatePullRequestReviewInput { - # The contents of the pull request review body. + """ + The contents of the pull request review body. + """ body: String! - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the pull request review to modify. + """ + The Node ID of the pull request review to modify. + """ pullRequestReviewId: ID! } -# Autogenerated return type of UpdatePullRequestReview +""" +Autogenerated return type of UpdatePullRequestReview +""" type UpdatePullRequestReviewPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated pull request review. + """ + The updated pull request review. + """ pullRequestReview: PullRequestReview! } -# Autogenerated input type of UpdateSubscription +""" +Autogenerated input type of UpdateSubscription +""" input UpdateSubscriptionInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The new state of the subscription. + """ + The new state of the subscription. + """ state: SubscriptionState! - # The Node ID of the subscribable object to modify. + """ + The Node ID of the subscribable object to modify. + """ subscribableId: ID! } -# Autogenerated return type of UpdateSubscription +""" +Autogenerated return type of UpdateSubscription +""" type UpdateSubscriptionPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The input subscribable entity. + """ + The input subscribable entity. + """ subscribable: Subscribable! } -# Autogenerated input type of UpdateTeamDiscussionComment +""" +Autogenerated input type of UpdateTeamDiscussionComment +""" input UpdateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") { - # The updated text of the comment. + """ + The updated text of the comment. + """ body: String! - # The current version of the body content. + """ + The current version of the body content. + """ bodyVersion: String - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The ID of the comment to modify. + """ + The ID of the comment to modify. + """ id: ID! } -# Autogenerated return type of UpdateTeamDiscussionComment +""" +Autogenerated return type of UpdateTeamDiscussionComment +""" type UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated comment. + """ + The updated comment. + """ teamDiscussionComment: TeamDiscussionComment } -# Autogenerated input type of UpdateTeamDiscussion +""" +Autogenerated input type of UpdateTeamDiscussion +""" input UpdateTeamDiscussionInput @preview(toggledBy: "echo-preview") { - # The updated text of the discussion. + """ + The updated text of the discussion. + """ body: String - # The current version of the body content. If provided, this update operation - # will be rejected if the given version does not match the latest version on the server. + """ + The current version of the body content. If provided, this update operation + will be rejected if the given version does not match the latest version on the server. + """ bodyVersion: String - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the discussion to modify. + """ + The Node ID of the discussion to modify. + """ id: ID! - # If provided, sets the pinned state of the updated discussion. + """ + If provided, sets the pinned state of the updated discussion. + """ pinned: Boolean - # The updated title of the discussion. + """ + The updated title of the discussion. + """ title: String } -# Autogenerated return type of UpdateTeamDiscussion +""" +Autogenerated return type of UpdateTeamDiscussion +""" type UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview") { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The updated discussion. + """ + The updated discussion. + """ teamDiscussion: TeamDiscussion } -# Autogenerated input type of UpdateTopics +""" +Autogenerated input type of UpdateTopics +""" input UpdateTopicsInput { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # The Node ID of the repository. + """ + The Node ID of the repository. + """ repositoryId: ID! - # An array of topic names. + """ + An array of topic names. + """ topicNames: [String!]! } -# Autogenerated return type of UpdateTopics +""" +Autogenerated return type of UpdateTopics +""" type UpdateTopicsPayload { - # A unique identifier for the client performing the mutation. + """ + A unique identifier for the client performing the mutation. + """ clientMutationId: String - # Names of the provided topics that are not valid. + """ + Names of the provided topics that are not valid. + """ invalidTopicNames: [String!] - # The updated repository. + """ + The updated repository. + """ repository: Repository! } -# A user is an individual's account on GitHub that owns repositories and can make new content. -type User implements Actor, Node, RepositoryOwner, UniformResourceLocatable { - # A URL pointing to the user's public avatar. +""" +A user is an individual's account on GitHub that owns repositories and can make new content. +""" +type User implements Actor & Node & RepositoryOwner & UniformResourceLocatable { + """ + A URL pointing to the user's public avatar. + """ avatarUrl( - # The size of the resulting square image. + """ + The size of the resulting square image. + """ size: Int ): URI! - # The user's public profile bio. + """ + The user's public profile bio. + """ bio: String - # The user's public profile bio as HTML. + """ + The user's public profile bio as HTML. + """ bioHTML: HTML! - # A list of commit comments made by this user. + """ + A list of commit comments made by this user. + """ commitComments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): CommitCommentConnection! - # The user's public profile company. + """ + The user's public profile company. + """ company: String - # The user's public profile company as HTML. + """ + The user's public profile company as HTML. + """ companyHTML: HTML! - # A list of repositories that the user recently contributed to. + """ + A list of repositories that the user recently contributed to. + """ contributedRepositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! @deprecated(reason: "Arguments for connection `contributedRepositories` are getting redesigned. Use `User.repositoriesContributedTo` instead. Removal on 2017-07-01 UTC.") - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # Identifies the primary key from the database. + """ + Identifies the primary key from the database. + """ databaseId: Int @deprecated(reason: "Exposed database IDs will eventually be removed in favor of global Relay IDs. Use `Node.id` instead. Removal on 2017-07-01 UTC.") - # The user's publicly visible profile email. + """ + The user's publicly visible profile email. + """ email: String! - # A list of users the given user is followed by. + """ + A list of users the given user is followed by. + """ followers( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): FollowerConnection! - # A list of users the given user is following. + """ + A list of users the given user is following. + """ following( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): FollowingConnection! - # Find gist by repo name. + """ + Find gist by repo name. + """ gist( - # The gist name to find. + """ + The gist name to find. + """ name: String! ): Gist - # A list of gist comments made by this user. + """ + A list of gist comments made by this user. + """ gistComments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): GistCommentConnection! - # A list of the Gists the user has created. + """ + A list of the Gists the user has created. + """ gists( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for gists returned from the connection + """ + Ordering options for gists returned from the connection + """ orderBy: GistOrder - # Filters Gists according to privacy. + """ + Filters Gists according to privacy. + """ privacy: GistPrivacy ): GistConnection! id: ID! - # Whether or not this user is a participant in the GitHub Security Bug Bounty. + """ + Whether or not this user is a participant in the GitHub Security Bug Bounty. + """ isBountyHunter: Boolean! - # Whether or not this user is a participant in the GitHub Campus Experts Program. + """ + Whether or not this user is a participant in the GitHub Campus Experts Program. + """ isCampusExpert: Boolean! - # Whether or not this user is a GitHub Developer Program member. + """ + Whether or not this user is a GitHub Developer Program member. + """ isDeveloperProgramMember: Boolean! - # Whether or not this user is a GitHub employee. + """ + Whether or not this user is a GitHub employee. + """ isEmployee: Boolean! - # Whether or not the user has marked themselves as for hire. + """ + Whether or not the user has marked themselves as for hire. + """ isHireable: Boolean! - # Whether or not this user is a site administrator. + """ + Whether or not this user is a site administrator. + """ isSiteAdmin: Boolean! - # Whether or not this user is the viewing user. + """ + Whether or not this user is the viewing user. + """ isViewer: Boolean! - # A list of issue comments made by this user. + """ + A list of issue comments made by this user. + """ issueComments( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): IssueCommentConnection! - # A list of issues assocated with this user. + """ + A list of issues assocated with this user. + """ issues( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for issues returned from the connection. + """ + Ordering options for issues returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the issues by. + """ + A list of states to filter the issues by. + """ states: [IssueState!] ): IssueConnection! - # The user's public profile location. + """ + The user's public profile location. + """ location: String - # The username used to login. + """ + The username used to login. + """ login: String! - # The user's public profile name. + """ + The user's public profile name. + """ name: String - # Find an organization by its login that the user belongs to. + """ + Find an organization by its login that the user belongs to. + """ organization( - # The login of the organization to find. + """ + The login of the organization to find. + """ login: String! ): Organization - # A list of organizations the user belongs to. + """ + A list of organizations the user belongs to. + """ organizations( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): OrganizationConnection! - # A list of repositories this user has pinned to their profile + """ + A list of repositories this user has pinned to their profile + """ pinnedRepositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # A list of public keys associated with this user. + """ + A list of public keys associated with this user. + """ publicKeys( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int ): PublicKeyConnection! - # A list of pull requests assocated with this user. + """ + A list of pull requests assocated with this user. + """ pullRequests( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # The base ref name to filter the pull requests by. + """ + The base ref name to filter the pull requests by. + """ baseRefName: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # The head ref name to filter the pull requests by. + """ + The head ref name to filter the pull requests by. + """ headRefName: String - # A list of label names to filter the pull requests by. + """ + A list of label names to filter the pull requests by. + """ labels: [String!] - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for pull requests returned from the connection. + """ + Ordering options for pull requests returned from the connection. + """ orderBy: IssueOrder - # A list of states to filter the pull requests by. + """ + A list of states to filter the pull requests by. + """ states: [PullRequestState!] ): PullRequestConnection! - # A list of repositories that the user owns. + """ + A list of repositories that the user owns. + """ repositories( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they are forks of another repository + """ + If non-null, filters repositories according to whether they are forks of another repository + """ isFork: Boolean - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # A list of repositories that the user recently contributed to. + """ + A list of repositories that the user recently contributed to. + """ repositoriesContributedTo( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # If non-null, include only the specified types of contributions. The - # GitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY] + """ + If non-null, include only the specified types of contributions. The + GitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY] + """ contributionTypes: [RepositoryContributionType] - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If true, include user repositories + """ + If true, include user repositories + """ includeUserRepositories: Boolean - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # Find Repository. + """ + Find Repository. + """ repository( - # Name of Repository to find. + """ + Name of Repository to find. + """ name: String! ): Repository - # The HTTP path for this user + """ + The HTTP path for this user + """ resourcePath: URI! - # Repositories the user has starred. + """ + Repositories the user has starred. + """ starredRepositories( - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Order for connection + """ + Order for connection + """ orderBy: StarOrder - # Filters starred repositories to only return repositories owned by the viewer. + """ + Filters starred repositories to only return repositories owned by the viewer. + """ ownedByViewer: Boolean ): StarredRepositoryConnection! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") - # The HTTP URL for this user + """ + The HTTP URL for this user + """ url: URI! - # Whether or not the viewer is able to follow the user. + """ + Whether or not the viewer is able to follow the user. + """ viewerCanFollow: Boolean! - # Whether or not this user is followed by the viewer. + """ + Whether or not this user is followed by the viewer. + """ viewerIsFollowing: Boolean! - # A list of repositories the given user is watching. + """ + A list of repositories the given user is watching. + """ watching( - # Affiliation options for repositories returned from the connection + """ + Affiliation options for repositories returned from the connection + """ affiliations: [RepositoryAffiliation] - # Returns the elements in the list that come after the specified global ID. + """ + Returns the elements in the list that come after the specified global ID. + """ after: String - # Returns the elements in the list that come before the specified global ID. + """ + Returns the elements in the list that come before the specified global ID. + """ before: String - # Returns the first _n_ elements from the list. + """ + Returns the first _n_ elements from the list. + """ first: Int - # If non-null, filters repositories according to whether they have been locked + """ + If non-null, filters repositories according to whether they have been locked + """ isLocked: Boolean - # Returns the last _n_ elements from the list. + """ + Returns the last _n_ elements from the list. + """ last: Int - # Ordering options for repositories returned from the connection + """ + Ordering options for repositories returned from the connection + """ orderBy: RepositoryOrder - # If non-null, filters repositories according to privacy + """ + If non-null, filters repositories according to privacy + """ privacy: RepositoryPrivacy ): RepositoryConnection! - # A URL pointing to the user's public website/blog. + """ + A URL pointing to the user's public website/blog. + """ websiteUrl: URI } -# The connection type for User. +""" +The connection type for User. +""" type UserConnection { - # A list of edges. + """ + A list of edges. + """ edges: [UserEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [User] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edit on user content +""" +An edit on user content +""" type UserContentEdit implements Node { - # Identifies the date and time when the object was created. + """ + Identifies the date and time when the object was created. + """ createdAt: DateTime! - # The actor who edited this content, + """ + The actor who edited this content, + """ editor: Actor id: ID! - # Identifies the date and time when the object was last updated. + """ + Identifies the date and time when the object was last updated. + """ updatedAt: DateTime! @deprecated(reason: "General type updated timestamps will eventually be replaced by other field specific timestamps. Removal on 2017-07-01 UTC.") } -# A list of edits to content. +""" +A list of edits to content. +""" type UserContentEditConnection { - # A list of edges. + """ + A list of edges. + """ edges: [UserContentEditEdge] - # A list of nodes. + """ + A list of nodes. + """ nodes: [UserContentEdit] - # Information to aid in pagination. + """ + Information to aid in pagination. + """ pageInfo: PageInfo! - # Identifies the total count of items in the connection. + """ + Identifies the total count of items in the connection. + """ totalCount: Int! } -# An edge in a connection. +""" +An edge in a connection. +""" type UserContentEditEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: UserContentEdit } -# An edge in a connection. +""" +An edge in a connection. +""" type UserEdge { - # A cursor for use in pagination. + """ + A cursor for use in pagination. + """ cursor: String! - # The item at the end of the edge. + """ + The item at the end of the edge. + """ node: User } -# A valid x509 certificate string +""" +A valid x509 certificate string +""" scalar X509Certificate diff --git a/test/graphql-docs/fixtures/named-root-schema.graphql b/test/graphql-docs/fixtures/named-root-schema.graphql index 15f6e58..485af36 100644 --- a/test/graphql-docs/fixtures/named-root-schema.graphql +++ b/test/graphql-docs/fixtures/named-root-schema.graphql @@ -1,7 +1,10 @@ schema { query: RootQuery } + type RootQuery { - #Do a thing + """ + Do a thing + """ thing: [String!]! } diff --git a/test/graphql-docs/fixtures/sw-schema.graphql b/test/graphql-docs/fixtures/sw-schema.graphql index 6cd4823..42df983 100644 --- a/test/graphql-docs/fixtures/sw-schema.graphql +++ b/test/graphql-docs/fixtures/sw-schema.graphql @@ -1,92 +1,154 @@ -# A character in the Star Wars Trilogy +""" +A character in the Star Wars Trilogy +""" interface Character { - # The id of the character. - id: ID! - - # The name of the character. - name: String + """ + Which movies they appear in. + """ + appearsIn: [Episode] - # The friends of the character, or an empty list if they have none. + """ + The friends of the character, or an empty list if they have none. + """ friends: [Character] - # Which movies they appear in. - appearsIn: [Episode] + """ + The id of the character. + """ + id: ID! + + """ + The name of the character. + """ + name: String - # All secrets about their past. + """ + All secrets about their past. + """ secretBackstory: String } -# A mechanical creature in the Star Wars universe. +""" +A mechanical creature in the Star Wars universe. +""" type Droid implements Character { - # The id of the droid. - id: ID! - - # The name of the droid. - name: String + """ + Which movies they appear in. + """ + appearsIn: [Episode] - # The friends of the droid, or an empty list if they have none. + """ + The friends of the droid, or an empty list if they have none. + """ friends: [Character] - # Which movies they appear in. - appearsIn: [Episode] + """ + The id of the droid. + """ + id: ID! - # Construction date and the name of the designer. - secretBackstory: String + """ + The name of the droid. + """ + name: String - # The primary function of the droid. + """ + The primary function of the droid. + """ primaryFunction: String + + """ + Construction date and the name of the designer. + """ + secretBackstory: String } -# One of the films in the Star Wars Trilogy +""" +One of the films in the Star Wars Trilogy +""" enum Episode { - # Released in 1977. - NEWHOPE - - # Released in 1980. + """ + Released in 1980. + """ EMPIRE - # Released in 1983. + """ + Released in 1983. + """ JEDI + + """ + Released in 1977. + """ + NEWHOPE } -# A humanoid creature in the Star Wars universe. +""" +A humanoid creature in the Star Wars universe. +""" type Human implements Character { - # The id of the human. - id: ID! - - # The name of the human. - name: String + """ + Which movies they appear in. + """ + appearsIn: [Episode] - # The friends of the human, or an empty list if they have none. + """ + The friends of the human, or an empty list if they have none. + """ friends: [Character] - # Which movies they appear in. - appearsIn: [Episode] - - # The home planet of the human, or null if unknown. + """ + The home planet of the human, or null if unknown. + """ homePlanet: String - # Where are they from and how they came to be who they are. + """ + The id of the human. + """ + id: ID! + + """ + The name of the human. + """ + name: String + + """ + Where are they from and how they came to be who they are. + """ secretBackstory: String } -# Root query +""" +Root query +""" type Query { - # Return the hero by episode. + """ + Return the Droid by ID. + """ + droid( + """ + id of the droid + """ + id: ID! + ): Droid + + """ + Return the hero by episode. + """ hero( - # If omitted, returns the hero of the whole saga. If provided, returns the hero of that particular episode. + """ + If omitted, returns the hero of the whole saga. If provided, returns the hero of that particular episode. + """ episode: Episode ): Character - # Return the Human by ID. + """ + Return the Human by ID. + """ human( - # id of the human + """ + id of the human + """ id: ID! ): Human - - # Return the Droid by ID. - droid( - # id of the droid - id: ID! - ): Droid } diff --git a/test/graphql-docs/fixtures/tiny-schema.graphql b/test/graphql-docs/fixtures/tiny-schema.graphql index 586d514..989d778 100644 --- a/test/graphql-docs/fixtures/tiny-schema.graphql +++ b/test/graphql-docs/fixtures/tiny-schema.graphql @@ -1,26 +1,44 @@ -# The Code of Conduct for a repository +""" +The Code of Conduct for a repository +""" type CodeOfConduct { - # The body of the CoC + """ + The body of the CoC + """ body: String - # The key for the CoC + """ + The key for the CoC + """ key: String! - # The formal name of the CoC + """ + The formal name of the CoC + """ name: String! - # The path to the CoC + """ + The path to the CoC + """ url: URI } -# An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. -scalar URI - -# The query root of GitHub's GraphQL interface. +""" +The query root of GitHub's GraphQL interface. +""" type Query { - # Look up a code of conduct by its key + """ + Look up a code of conduct by its key + """ codeOfConduct( - # The code of conduct's key + """ + The code of conduct's key + """ key: String! ): CodeOfConduct } + +""" +An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. +""" +scalar URI diff --git a/test/graphql-docs/generator_test.rb b/test/graphql-docs/generator_test.rb index 07567cb..f42704a 100644 --- a/test/graphql-docs/generator_test.rb +++ b/test/graphql-docs/generator_test.rb @@ -137,7 +137,6 @@ def test_that_it_sets_classes end def test_that_named_query_root_generates_fields - skip("graphql 2.2.0+ causes this to fail") options = deep_copy(GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS) options[:output_dir] = @output_dir @@ -197,7 +196,6 @@ def test_that_markdown_preserves_whitespace end def test_that_empty_html_lines_not_interpreted_by_markdown - skip("graphql 2.2.0+ causes this to fail") options = deep_copy(GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS) options[:output_dir] = @output_dir @@ -210,7 +208,6 @@ def test_that_empty_html_lines_not_interpreted_by_markdown end def test_that_non_empty_html_lines_not_interpreted_by_markdown - skip("graphql 2.2.0+ causes this to fail") options = deep_copy(GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS) options[:output_dir] = @output_dir