api/graph2/schema/types/Story.gql

# A Story is a piece of content that, unlike wiki articles, are not something that should be ordered by time instead of title. It can
# contain multiple chapters by one or more autohrs
type Story {
  # The story's ID
  id: String!

  # The story's name, which will show up in the lists.
  name: String!

  # The story's author
  author: String!

  # Whether other users may add/edit chapters to the story.
  open: Boolean!

  # Whether users without a direct link can find this story.
  listed: Boolean!

  # The category of the story
  category: StoryCategory!

  # The tags for this tory
  tags: [Tag!]!

  # The chapters of this story
  chapters: [Chapter!]!

  # The date the story was created.
  createdDate: Time!

  # The date the story is set in.
  fictionalDate: Time

  # The date of the last major update to the story. This being bumped means a new chapter has been added.
  updatedDate: Time!

  # Whether to sort by fictional date.
  sortByFictionalDate: Boolean!
}

# Filter for stories query.
input StoriesFilter {
  # What author to query for
  author: String

  # What category to query for
  category: StoryCategory

  # What tags to query for
  tags: [TagInput!]

  # If true, it will only show unlisted page you have access to
  unlisted: Boolean

  # Whether the page is open for additions by other users
  open: Boolean

  # The earliest fictionalDate
  earliestFictionalDate: Time

  # The latest fictionalDate
  latestFictionalDate: Time

  # The max amount of stories to get (default: 30)
  limit: Int
}

# Input for the addStory mutation
input StoryAddInput { 
  # Set the name of the story, which will show up as the title, and as a suggestion for
  # the first chapter being added.
  name: String!

  # Set the category for the new story.
  category: StoryCategory!

  # Add the story under another name. This requires the story.add permission, and should not be
  # abused. The action will be logged with the actual creator's user ID.
  author: String

  # Allow other users to post chapters to the story.
  open: Boolean

  # Allow other users to see this page in any lists or search results.
  listed: Boolean

  # Set which tags the story should have.
  tags: [TagInput!]

  # Set the fictional date of the story.
  fictionalDate: Time

  # Whether to sort by fictional date.
  sortByFictionalDate: Boolean
}

# Input for the editStory mutation
input StoryEditInput {
  # What story to edit
  id: String!

  # Set the name of the story, which will show up as the title, and as a suggestion for
  # the first chapter being added.
  name: String

  # Set the category for the new story.
  category: StoryCategory

  # Add the story under another name. This requires the story.add permission, and should not be
  # abused. The action will be logged with the actual creator's user ID.
  author: String

  # Change whether to allow others to add chapters
  open: Boolean

  # Change whether to show this story in the list and search results
  listed: Boolean

  # Set the fictional date of the story.
  fictionalDate: Time

  # Clear the fictional date of the story.
  clearFictionalDate: Boolean

  # Whether to sort by fictional date.
  sortByFictionalDate: Boolean
}

# Input for the addStoryTag mutation
input StoryTagAddInput {
  # What story to add the tag to.
  id: String!

  # The tag to add.
  tag: TagInput!
}

# Input for the removeStoryTag mutation
input StoryTagRemoveInput {
  # What story to remove the tag from.
  id: String!

  # The tag to remove.
  tag: TagInput!
}

# Input for the removeStory mutation
input StoryRemoveInput {
  # What story to remove.
  id: String!
}

# Possible values for Story.category
enum StoryCategory {
  # General information
  Info

  # News stories
  News

  # Description and content of a document or item
  Document

  # Information about something going on in the background that may or may not inform RP
  Background

  # A short story
  Story
}