GraphQL Patterns

query-order.graphql

# Query order pattern from GitHub GraphQL API
# Can be used in conjunction with Relay pagination.

"""
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
}

"""
Ways in which lists of posts can be ordered upon return.
"""
input PostOrder {
  """
  The direction in which to order posts by the specified field.
  """
  direction: OrderDirection!

  """
  The field in which to order reactions by.
  """
  field: PostOrderField!
}

"""
A list of fields that reactions can be ordered by.
"""
enum PostOrderField {
  """
  Allows ordering a list of posts by when they were created.
  """
  CREATED_AT
  
  """
  Allows ordering a list of posts by when they were updated.
  """
  UPDATED_AT
  
  """
  Allows ordering a list of posts by their title.
  """
  TITLE
}

"""
A post.
"""
type Post {
  id: ID!

  """
  The title of the post.
  """
  title: String!
  
  """
  Identifies the date and time when the object was created.
  """
  createdAt: DateTime!
  
  """
  Identifies the date and time when the object was updated.
  """
  updatedAt: DateTime!
}

type User {
  posts(
    """
    Ordering options for posts.
    """
    orderBy: PostOrder
  )
  
  # With default order
  posts(
    """
    Ordering options for posts.
    """
    orderBy = {field: CREATED_AT, direction: DESC}
  )
}

relay-pagination.graphql

# Relay Pagination
# https://facebook.github.io/relay/graphql/connections.htm

"""
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!
}

"""
A post.
"""
type Post {
  id: ID!
  
  """
  The title of the post.
  """
  title: String!
  
  """
  The body of the post.
  """
  body: String
  
  """
  The post author.
  """
  author: User!
  
  """
  Identifies the date and time when the object was created.
  """
  createdAt: DateTime!
  
  """
  Identifies the date and time when the object was updated.
  """
  updatedAt: DateTime!
}

"""
The connection type for Post.
"""
type PostConnection {
  """
  A list of edges.
  """
  edges: [PostEdge]

  """
  A list of nodes.
  """
  nodes: [Post]

  """
  Information to aid in pagination.
  """
  pageInfo: PageInfo!

  """
  Identifies the total count of items in the connection.
  """
  totalCount: Int!
}

"""
An edge in a connection.
"""
type PostEdge {
  """
  A cursor for use in pagination.
  """
  cursor: String!

  """
  The item at the end of the edge.
  """
  node: Post
}

"""
A user.
"""
type User {
  """
  Posts created by the user.
  """
  posts(
    """
    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
  ): PostConnection!
}

reusable-interfaces.graphql

# Reusable interfaces
# Based on GitHub's GraphQL API

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

"""
Represents a subset of user info.
"""
interface UserInfo {
  """
  The email of the user.
  """
  email: String!
  
  """
  The display name of the user.
  """
  displayName: String!
}

"""
Entities that can be subscribed to.
"""
interface Subscribable {
  id: ID!

  """
  Check if the viewer is able to change their subscription status for the entity.
  """
  viewerCanSubscribe: Boolean!
}

"""
A user.
"""
type User implements Node & UserInfo & Subscribable {
  id: ID!
  
  """
  The email of the user.
  """
  email: String!
  
  """
  The display name of the user.
  """
  displayName: String!
  
  """
  Check if the viewer is able to change their subscription status for the entity.
  """
  viewerCanSubscribe: Boolean!
}

setting-pattern.graphql

# A pattern for defining different kinds of settings and messages.
# Based on GitHub's GraphQL API

"""
Autogenerated input type of UpdateUserDiagnosticsSetting
"""
input UpdateUserDiagnosticsSettingInput {
  """
  The ID of the user on which to set the diagnostics settings for.
  """
  userId: ID!

  """
  The value for the diagnostic setting.
  """
  settingValue: DiagnosticSettingValue!
}

"""
Autogenerated return type of UpdateUserDiagnosticsSetting
"""
type UpdateUserDiagnosticsSettingPayload {
  """
  The user with the updated diagnostics setting.
  """
  user: User

  """
  A message confirming the result of updating the diagnostics setting.
  """
  message: String
}

"""
The possible values for diagnostics setting.
"""
enum DiagnosticSettingValue {
  """
  The setting is disabled for collecting diagnostics.
  """
  DISABLED

  """
  The setting is enabled for collecting basic diagnostics.
  """
  BASIC

  """
  There is no policy set for collecting full diagnostics.
  """
  FULL
}

# Reusable setting value for togglable fields.

"""
The possible values for an enabled/disabled setting.
"""
enum EnabledDisabledSettingValue {
  """
  The setting is disabled for the value.
  """
  DISABLED

  """
  The setting is enabled for the value.
  """
  ENABLED
}

type Mutation {
  """
  Sets whether diagnostics are enabled for a user.
  """
  updateUserDiagnosticsSetting(input: UpdateUserDiagnosticsSettingInput!): UpdateUserDiagnosticsSettingPayload
}