api/graph2/schema/types/Chapter.gql

# A Chapter is the main content body of a story.
type Chapter {
  # The chapter's ID
  id: String!

  # The chapter's title
  title: String!

  # The chapter's author
  author: String!

  # The chapter's source
  source: String!

  # When the chapter was posted initialy
  createdDate: Time!

  # The in-universe date and time of the chapter
  fictionalDate: Time

  # The date of edit.
  editedDate: Time!

  "The comment mode."
  commentMode: ChapterCommentMode!

  "Whether the author has locket comments."
  commentsLocked: Boolean!

  "A shorthand for checking whether a logged-in user can comment on this chapter."
  canComment: Boolean!

  "Get all chapter comments."
  comments(limit: Int): [Comment!]!
}

"""
The possibles modes of comments for a chapter.
"""
enum ChapterCommentMode {
  "Comments are disabled and hidden."
  Disabled

  "Comments should be shown as typical news article comments."
  Article

  "Comments should be shown in a compact form suitable for many small messages."
  Chat

  "Comments are going to be shown as omni-tool messages."
  Message
}

# Input for addChapter mutation
input ChapterAddInput {
  # The story to add a chapter to
  storyId: String!

  # The title to give the chapter. It can not be left empty
  title: String!

  # The author to set for the chapter. It will use the logged in user ID, and only
  # users with appropriate permissions can post as another author. Even then, it's only
  # for importing/moving content. This author name will not be used when logging the 
  # submission
  author: String

  # The markdown source for the content
  source: String!

  # Optionally, assign a fictional date for the chapter
  fictionalDate: Time

  "The comment mode for the chapter."
  commentMode: ChapterCommentMode
}

# Input for editChapter mutation
input ChapterEditInput {
  # The chapter to edit
  id: String!

  # Change the chapter's title
  title: String

  # Change the source
  source: String

  # Set the fictional date for a chapter
  fictionalDate: Time

  # Remove the fictional date for a chapter
  clearFictionalDate: Boolean

  "Set the comment mode for the chapter"
  commentMode: ChapterCommentMode

  "Set whether the chapter comments are locked"
  commentsLocked: Boolean
}

# Input for moveChapter mutation
input ChapterMoveInput {
  # The chapter to move
  id: String!

  # The story to move it to
  storyId: String!
}

# Input for removeChapter mutation
input ChapterRemoveInput {
  # The chapter to remove
  id: String!
}