schema.graphql

"""A person credited as the author of a book."""
type Author {
  """Author's given name."""
  firstName: String!

  """Author's family name."""
  lastName: String!

  """Author's middle name, when known."""
  middleName: String
}

"""Author details supplied when creating or updating a book."""
input AuthorInput {
  """Author's given name."""
  firstName: String!

  """Author's family name."""
  lastName: String!

  """Author's middle name, when known."""
  middleName: String!
}

"""A book stored in the catalog."""
type Book {
  Id: ID!

  """Primary title of the book."""
  title: String!

  """Author credited on the book."""
  author: Author!

  """Listed price in the store currency."""
  price: Float!

  """Optional subtitle shown with the title."""
  subtitle: String

  """Long-form description or synopsis."""
  description: String

  """ISBN used to identify the edition."""
  isbn: String

  """Physical or digital format (for example paperback or ebook)."""
  bookFormat: String

  """Aggregate customer rating, when available."""
  rating: Float

  """Whether downstream async processing still needs to run."""
  asyncUpdateRequired: Boolean

  """ISO-8601 timestamp when the record was created."""
  createdOn: String

  """ISO-8601 timestamp of the most recent update."""
  lastUpdatedOn: String
}

"""Response wrapper for a create operation."""
type BookCreateResponse {
  success: Boolean!
  errorMessage: String

  """The created record, when persistence succeeds."""
  result: Book

  """MongoDB identifier assigned to the new record."""
  recordId: ID!
}

"""Response wrapper for a delete operation."""
type BookDeleteResponse {
  success: Boolean!
  errorMessage: String

  """The deleted record, when removal succeeds."""
  result: Book

  """MongoDB identifier of the removed record."""
  recordId: ID!
}

"""Response wrapper for a single-record read."""
type BookGetResponse {
  success: Boolean!
  errorMessage: String

  """The requested record, when found."""
  result: Book
}

"""Response wrapper for an update operation."""
type BookUpdateResponse {
  success: Boolean!
  errorMessage: String

  """The updated record after changes are applied."""
  result: Book

  """MongoDB identifier of the updated record."""
  recordId: ID!
}

"""Date with time (isoformat)"""
scalar DateTime

"""Create, update, and delete operations for books and reviews."""
type Mutation {
  """Add a new book to the catalog."""
  createBook(title: String!, author: AuthorInput!, price: Float!, subtitle: String!, description: String!, isbn: String!, bookFormat: String!): BookCreateResponse!

  """Update fields on an existing book."""
  updateBook(bookId: String!, title: String!, author: AuthorInput!, price: Float!, subtitle: String!, description: String!, isbn: String!, bookFormat: String!, rating: Float!): BookUpdateResponse!

  """Remove a book from the catalog."""
  deleteBook(bookId: String!): BookDeleteResponse!

  """Submit a new review for a book."""
  createReview(bookId: String!, reviewerId: String!, rating: Float!, reviewComments: String!): ReviewCreateResponse!

  """Change rating or comments on an existing review."""
  updateReview(reviewId: String!, rating: Float!, reviewComments: String!): ReviewUpdateResponse!

  """Remove a review by ID."""
  deleteReview(reviewId: String!): ReviewDeleteResponse!
}

"""Read operations for books and reviews."""
type Query {
  """Fetch one book by MongoDB document ID."""
  getBookById(bookId: String!): BookGetResponse!

  """Fetch one book by ISBN."""
  getBookByIsbn(isbn: String!): BookGetResponse!

  """Fetch one review by MongoDB document ID."""
  getReviewById(reviewId: String!): ReviewGetResponse!

  """Fetch reviews associated with a book."""
  getReviewByBookId(bookId: String!): ReviewGetResponse!
}

"""A customer review for a book."""
type Review {
  Id: ID!

  """MongoDB identifier of the book being reviewed."""
  bookId: String!

  """Identifier of the reviewer who wrote the review."""
  reviewerId: String!

  """Numeric rating, typically on a 1–5 scale."""
  rating: Float!

  """Free-text review body."""
  reviewComments: String!

  """When the review was first submitted."""
  createdOn: DateTime!

  """When the review was last edited, if ever."""
  lastUpdatedOn: DateTime
}

"""Response wrapper for a create operation."""
type ReviewCreateResponse {
  success: Boolean!
  errorMessage: String

  """The created record, when persistence succeeds."""
  result: Review

  """MongoDB identifier assigned to the new record."""
  recordId: ID!
}

"""Response wrapper for a delete operation."""
type ReviewDeleteResponse {
  success: Boolean!
  errorMessage: String

  """The deleted record, when removal succeeds."""
  result: Review

  """MongoDB identifier of the removed record."""
  recordId: ID!
}

"""Response wrapper for a single-record read."""
type ReviewGetResponse {
  success: Boolean!
  errorMessage: String

  """The requested record, when found."""
  result: Review
}

"""Response wrapper for an update operation."""
type ReviewUpdateResponse {
  success: Boolean!
  errorMessage: String

  """The updated record after changes are applied."""
  result: Review

  """MongoDB identifier of the updated record."""
  recordId: ID!
}