api/graph2/schema/types/Character.gql

# A Character represents an RP character
type Character {
  # A unique identifier for the character
  id: String!

  # The primary IRC nick belonging to the character
  nick: String

  # All IRC nicks associated with this character
  nicks: [String!]!

  # The character's author
  author: String!

  # The character's name
  name: String!

  # The name to display when space is scarce, usually the first/given name
  shortName: String!

  # A short description of the character
  description: String!
}

# Filter for characters query
input CharactersFilter {
  # Filter by character IDs
  ids: [String!]

  # Filter by nicks
  nicks: [String!]

  # Filter by names
  names: [String!]

  # Filter by author
  author: String

  # Filter by text search matching against the character's description
  search: String
}

# Input for adding characters
input CharacterAddInput {
  # The primary IRC nick name to recognize this character by
  nick: String!

  # The character's name
  name: String!

  # Optioanl shortened name. By default, it uses the first token in the name
  shortName: String

  # Description for a character.
  description: String

  # Optioanlly, specify another author. This needs special permissions if it's not
  # your own username
  author: String
}

# Input for addNick and removeNick mutation
input CharacterNickInput {
  # The ID of the character
  id: String!

  # The nick to add or remove
  nick: String!
}

# Inpuit for editCharacter mutation
input CharacterEditInput {
  # The id for the character to edit
  id: String!

  # The full name of the character -- not the salarian full name!
  name: String

  # The character's short name that is used in compact lists
  shortName: String

  # A short description for the character
  description: String
}

# Input for removeCharacter mutation
input CharacterRemoveInput {
  # The id for the character to edit
  id: String!
}