schema.ghall.graphql

"""
Represents an object which can take actions on GitHub. Typically a User or Bot.
"""
interface Actor {
  """
  A URL pointing to the actor's public avatar.
  """
  avatarUrl(
    """
    The size of the resulting square image.
    """
    size: Int
  ): URI!
  """
  The username of the actor.
  """
  login: String!
  """
  The HTTP path for this actor.
  """
  resourcePath: URI!
  """
  The HTTP URL for this actor.
  """
  url: URI!
}

"""
A Gist.
"""
type Gist implements Node & Starrable & UniformResourceLocatable {
  """
  The gist description.
  """
  description: String
  """
  A list of forks associated with the gist
  """
  forks(
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Ordering options for gists returned from the connection
    """
    orderBy: GistOrder
  ): GistConnection!
  id: ID!
  """
  The gist name.
  """
  name: String!
  """
  The gist owner.
  """
  owner: RepositoryOwner
  """
  The HTML path to this resource.
  """
  resourcePath: URI!
  """
  Returns a count of how many stargazers there are on this object
  """
  stargazerCount: Int!
  """
  A list of users who have starred this starrable.
  """
  stargazers(
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Order for connection
    """
    orderBy: StarOrder
  ): StargazerConnection!
  """
  The HTTP URL for this Gist.
  """
  url: URI!
}

"""
The connection type for Gist.
"""
type GistConnection {
  """
  Identifies the total count of items in the connection.
  """
  totalCount: Int!
}

"""
Ordering options for gist connections
"""
input GistOrder {
  """
  The ordering direction.
  """
  direction: OrderDirection!
  """
  The field to order repositories by.
  """
  field: GistOrderField!
}

"""
Properties by which gist connections can be ordered.
"""
enum GistOrderField {
  """
  Order gists by creation time
  """
  CREATED_AT
  """
  Order gists by push time
  """
  PUSHED_AT
  """
  Order gists by update time
  """
  UPDATED_AT
}

"""
Git SSH string
"""
scalar GitSSHRemote

"""
A string containing HTML code.
"""
scalar HTML

"""
Represents a given language found in repositories.
"""
type Language {
  """
  The color defined for the current language.
  """
  color: String
  """
  The name of the current language.
  """
  name: String!
}

"""
An object with an ID.
"""
interface Node {
  """
  ID of the object.
  """
  id: ID!
}

"""
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.
  """
  ASC
  """
  Specifies a descending order for a given `orderBy` argument.
  """
  DESC
}

"""
Information about pagination in a connection.
"""
type PageInfo {
  """
  When paginating forwards, the cursor to continue.
  """
  endCursor: String
  """
  When paginating forwards, are there more items?
  """
  hasNextPage: Boolean!
  """
  When paginating backwards, are there more items?
  """
  hasPreviousPage: Boolean!
  """
  When paginating backwards, the cursor to continue.
  """
  startCursor: String
}

"""
Types that can be pinned to a profile page.
"""
union PinnableItem = Gist | Repository

"""
The connection type for PinnableItem.
"""
type PinnableItemConnection {
  """
  A list of edges.
  """
  edges: [PinnableItemEdge]
  """
  A list of nodes.
  """
  nodes: [PinnableItem]
  """
  Information to aid in pagination.
  """
  pageInfo: PageInfo!
  """
  Identifies the total count of items in the connection.
  """
  totalCount: Int!
}

"""
An edge in a connection.
"""
type PinnableItemEdge {
  """
  A cursor for use in pagination.
  """
  cursor: String!
  """
  The item at the end of the edge.
  """
  node: PinnableItem
}

"""
Represents items that can be pinned to a profile page or dashboard.
"""
enum PinnableItemType {
  """
  A gist.
  """
  GIST
  """
  An issue.
  """
  ISSUE
  """
  An organization.
  """
  ORGANIZATION
  """
  A project.
  """
  PROJECT
  """
  A pull request.
  """
  PULL_REQUEST
  """
  A repository.
  """
  REPOSITORY
  """
  A team.
  """
  TEAM
  """
  A user.
  """
  USER
}

"""
Represents any entity on GitHub that has a profile page.
"""
interface ProfileOwner {
  """
  The public profile email.
  """
  email: String
  """
  The public profile location.
  """
  location: String
  """
  The username used to login.
  """
  login: String!
  """
  The public profile name.
  """
  name: String
  """
  A list of repositories and gists this profile owner has pinned to their profile
  """
  pinnedItems(
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Filter the types of pinned items that are returned.
    """
    types: [PinnableItemType!]
  ): PinnableItemConnection!
  """
  The public profile website URL.
  """
  websiteUrl: URI
}

"""
The query root of GitHub's GraphQL interface.
"""
type Query {
  """
  Lookup a user by login.
  """
  user(
    """
    The user's login.
    """
    login: String!
  ): User
}

"""
A repository contains the content for a project.
"""
type Repository implements RepositoryInfo & Starrable & UniformResourceLocatable {
  """
  The description of the repository.
  """
  description: String
  """
  The description of the repository rendered to HTML.
  """
  descriptionHTML: HTML!
  """
  Returns how many forks there are of this repository in the whole network.
  """
  forkCount: Int!
  """
  A list of direct forked repositories.
  """
  forks(
    """
    Array of viewer's affiliation options for repositories returned from the
    connection. For example, OWNER will include only repositories that the
    current viewer owns.
    """
    affiliations: [RepositoryAffiliation]
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    If non-null, filters repositories according to whether they have been locked
    """
    isLocked: Boolean
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Ordering options for repositories returned from the connection
    """
    orderBy: RepositoryOrder
    """
    Array of owner's affiliation options for repositories returned from the
    connection. For example, OWNER will include only repositories that the
    organization or user being viewed owns.
    """
    ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
    """
    If non-null, filters repositories according to privacy
    """
    privacy: RepositoryPrivacy
  ): RepositoryConnection!
  """
  Identifies if the repository is a fork.
  """
  isFork: Boolean!
  """
  The name of the repository.
  """
  name: String!
  """
  The repository's name with owner.
  """
  nameWithOwner: String!
  """
  The User owner of the repository.
  """
  owner: RepositoryOwner!
  """
  The repository parent, if this is a fork.
  """
  parent: Repository
  """
  The primary language of the repository's code.
  """
  primaryLanguage: Language
  """
  The HTTP path for this repository
  """
  resourcePath: URI!
  """
  A description of the repository, rendered to HTML without any links in it.
  """
  shortDescriptionHTML(
    """
    How many characters to return.
    """
    limit: Int = 200
  ): HTML!
  """
  The SSH URL to clone this repository
  """
  sshUrl: GitSSHRemote!
  """
  Returns a count of how many stargazers there are on this object
  """
  stargazerCount: Int!
  """
  A list of users who have starred this starrable.
  """
  stargazers(
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Order for connection
    """
    orderBy: StarOrder
  ): StargazerConnection!
  """
  The HTTP URL for this repository
  """
  url: URI!
}

"""
The affiliation of a user to a repository
"""
enum RepositoryAffiliation {
  """
  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.
  """
  ORGANIZATION_MEMBER
  """
  Repositories that are owned by the authenticated user.
  """
  OWNER
}

"""
A list of repositories owned by the subject.
"""
type RepositoryConnection {
  """
  Identifies the total count of items in the connection.
  """
  totalCount: Int!
}

"""
A subset of repository info.
"""
interface RepositoryInfo {
  """
  The description of the repository.
  """
  description: String
  """
  The description of the repository rendered to HTML.
  """
  descriptionHTML: HTML!
  """
  Returns how many forks there are of this repository in the whole network.
  """
  forkCount: Int!
  """
  Identifies if the repository is a fork.
  """
  isFork: Boolean!
  """
  The name of the repository.
  """
  name: String!
  """
  The repository's name with owner.
  """
  nameWithOwner: String!
  """
  The User owner of the repository.
  """
  owner: RepositoryOwner!
  """
  The HTTP path for this repository
  """
  resourcePath: URI!
  """
  A description of the repository, rendered to HTML without any links in it.
  """
  shortDescriptionHTML(
    """
    How many characters to return.
    """
    limit: Int = 200
  ): HTML!
  """
  The HTTP URL for this repository
  """
  url: URI!
}

"""
Ordering options for repository connections
"""
input RepositoryOrder {
  """
  The ordering direction.
  """
  direction: OrderDirection!
  """
  The field to order repositories by.
  """
  field: RepositoryOrderField!
}

"""
Properties by which repository connections can be ordered.
"""
enum RepositoryOrderField {
  """
  Order repositories by creation time
  """
  CREATED_AT
  """
  Order repositories by name
  """
  NAME
  """
  Order repositories by push time
  """
  PUSHED_AT
  """
  Order repositories by number of stargazers
  """
  STARGAZERS
  """
  Order repositories by update time
  """
  UPDATED_AT
}

"""
Represents an owner of a Repository.
"""
interface RepositoryOwner {
  """
  A URL pointing to the owner's public avatar.
  """
  avatarUrl(
    """
    The size of the resulting square image.
    """
    size: Int
  ): URI!
  id: ID!
  """
  The username used to login.
  """
  login: String!
  """
  The HTTP URL for the owner.
  """
  resourcePath: URI!
  """
  The HTTP URL for the owner.
  """
  url: URI!
}

"""
The privacy of a repository
"""
enum RepositoryPrivacy {
  """
  Private
  """
  PRIVATE
  """
  Public
  """
  PUBLIC
}

"""
Ways in which star connections can be ordered.
"""
input StarOrder {
  """
  The direction in which to order nodes.
  """
  direction: OrderDirection!
  """
  The field in which to order nodes by.
  """
  field: StarOrderField!
}

"""
Properties by which star connections can be ordered.
"""
enum StarOrderField {
  """
  Allows ordering a list of stars by when they were created.
  """
  STARRED_AT
}

"""
The connection type for User.
"""
type StargazerConnection {
  """
  Identifies the total count of items in the connection.
  """
  totalCount: Int!
}

"""
Things that can be starred.
"""
interface Starrable {
  """
  Returns a count of how many stargazers there are on this object
  """
  stargazerCount: Int!
  """
  A list of users who have starred this starrable.
  """
  stargazers(
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Order for connection
    """
    orderBy: StarOrder
  ): StargazerConnection!
}

"""
An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
"""
scalar URI

"""
Represents a type that can be retrieved by a URL.
"""
interface UniformResourceLocatable {
  """
  The HTML path to this resource.
  """
  resourcePath: URI!
  """
  The URL to this resource.
  """
  url: URI!
}

"""
A user is an individual's account on GitHub that owns repositories and can make new content.
"""
type User implements Actor & Node & ProfileOwner & RepositoryOwner & UniformResourceLocatable {
  """
  A URL pointing to the user's public avatar.
  """
  avatarUrl(
    """
    The size of the resulting square image.
    """
    size: Int
  ): URI!
  """
  The user's public profile bio.
  """
  bio: String
  """
  The user's public profile bio as HTML.
  """
  bioHTML: HTML!
  """
  The user's public profile company.
  """
  company: String
  """
  The user's public profile company as HTML.
  """
  companyHTML: HTML!
  """
  Identifies the primary key from the database.
  """
  databaseId: Int
  """
  The user's publicly visible profile email.
  """
  email: String!
  id: ID!
  """
  The user's public profile location.
  """
  location: String
  """
  The username used to login.
  """
  login: String!
  """
  The user's public profile name.
  """
  name: String
  """
  A list of repositories and gists this profile owner has pinned to their profile
  """
  pinnedItems(
    """
    Returns the elements in the list that come after the specified cursor.
    """
    after: String
    """
    Returns the elements in the list that come before the specified cursor.
    """
    before: String
    """
    Returns the first _n_ elements from the list.
    """
    first: Int
    """
    Returns the last _n_ elements from the list.
    """
    last: Int
    """
    Filter the types of pinned items that are returned.
    """
    types: [PinnableItemType!]
  ): PinnableItemConnection!
  """
  The HTTP path for this user
  """
  resourcePath: URI!
  """
  The user's description of what they're currently doing.
  """
  status: UserStatus
  """
  The user's Twitter username.
  """
  twitterUsername: String
  """
  The HTTP URL for this user
  """
  url: URI!
  """
  A URL pointing to the user's public website/blog.
  """
  websiteUrl: URI
}

"""
The user's description of what they're currently doing.
"""
type UserStatus {
  """
  An emoji summarizing the user's status.
  """
  emoji: String
  """
  The status emoji as HTML.
  """
  emojiHTML: HTML
  """
  A brief message describing what the user is doing.
  """
  message: String
  """
  The user who has this status.
  """
  user: User!
}