schema.graphql

"""A long-form article with excerpt and category."""
type Article implements Content {
  author: User

  """Full article body."""
  body: String!

  """Article category."""
  category: String!

  """Short excerpt for previews."""
  excerpt: String!
  id: ID!
  publishedAt: String
  slug: String!
  title: String!
}

"""A blog post with tags."""
type BlogPost implements Content {
  author: User

  """The blog post content."""
  content: String!
  id: ID!
  publishedAt: String
  slug: String!

  """Tags for categorization."""
  tags: [String!]!
  title: String!
}

"""Base interface for all content types in the CMS."""
interface Content {
  """The author of the content."""
  author: User

  """Unique identifier for the content."""
  id: ID!

  """When the content was published. Null if draft."""
  publishedAt: String

  """URL-friendly slug."""
  slug: String!

  """The title of the content."""
  title: String!
}

type DataForLayer {
  text: String
}

type FormSubmission {
  documents: [FormSubmissionDocument]
  firstName: String
  id: String!
  lastName: String
}

type FormSubmissionDocument {
  file: UploadedFile!
  name: String
}

input FormSubmissionDocumentsInput {
  file: Upload!
  name: String
}

input FormSubmissionInput {
  documents: [FormSubmissionDocumentsInput]
  firstName: String
  lastName: String
}

enum MeansOfContact {
  email
  phone
}

type Mutation {
  createUser(user: UserData!): User!
  deleteUser(id: Int!): Boolean
  initState: Boolean!
  submitForm(input: FormSubmissionInput!): Boolean!
  triggerError: Boolean
  uploadFile(file: Upload): Boolean!
}

type NewsEntityQueryResult {
  items: [NewsItem]
}

type NewsItem {
  date: String
  lead: String
  organizationId: String!
  title: String
  url: NewsUrl
}

type NewsUrl {
  path: String
}

type Organization {
  id: String!
  name: String!
}

"""A static page with a template."""
type Page implements Content {
  author: User

  """The page content."""
  content: String!
  id: ID!
  publishedAt: String
  slug: String!

  """Template to use for rendering."""
  template: String!
  title: String!
}

type Query {
  """Get all content items (articles, blog posts, pages)."""
  allContent: [Content!]!

  """Get all articles."""
  articles: [Article!]!

  """Get all blog posts."""
  blogPosts: [BlogPost!]!

  """Get content by slug."""
  contentBySlug(slug: String!): Content
  dataForLayer: DataForLayer
  foobar: String

  """Get the current time."""
  getCurrentTime: String

  """Produce a GraphQL error."""
  getError: Boolean

  """Returns the value of a request header."""
  getRequestHeader(name: String!): String

  """Get all submissions."""
  getSubmissions: [FormSubmission]
  getText(text: String!): String!

  """
  Get news items, optionally filtered by organization IDs.
  Returns all news if ouIds is null.
  """
  newsEntityQuery(limit: Int, ouIds: [String]): NewsEntityQueryResult!

  """Get all pages."""
  pages: [Page!]!

  """Returns a random number."""
  returnRandomNumber: Int!

  """Returns the same value."""
  returnSameValue(value: Int!, vary: String): Int!

  """Search across all content types and users."""
  search(query: String!): [SearchResult!]!

  """Test the client options."""
  testClientOptions(path: String!): TestClientOptions

  """Test the fetch options."""
  testFetchOptions: TestFetchOptions

  """Load a user by ID."""
  userById(id: ID!): User

  """Get all users."""
  users: [User!]!

  """Get users with pagination metadata."""
  usersPaginated(limit: Int, offset: Int): UsersResult!
}

"""Union type for search results."""
union SearchResult = Article | BlogPost | Page | User

type TestClientOptions {
  language: String
  languageFromPath: String
}

type TestFetchOptions {
  headerClient: String
  headerServer: String
}

"""The `Upload` scalar type represents a file upload."""
scalar Upload

type UploadedFile {
  content: String!
  id: String!
  name: String!
}

type User {
  """Number of articles written by the user."""
  articleCount: Int!

  """Date of birth as YYYY-MM-DD."""
  dateOfBirth: String

  """Description."""
  description: String

  """Email address."""
  email: String!

  """First name of the user."""
  firstName: String!

  """All their friends."""
  friends: [User]

  """The ID of the user."""
  id: Int!

  """Last name of the user."""
  lastName: String!

  """How the user likes to be contacted."""
  meansOfContact: MeansOfContact
  triggerError: Boolean
}

input UserData {
  dateOfBirth: String
  description: String
  email: String!
  firstName: String!
  lastName: String!
}

type UsersResult {
  """Current page limit."""
  limit: Int!

  """Current page offset."""
  offset: Int!

  """Total number of users available."""
  totalCount: Int!

  """List of users for the current page."""
  users: [User!]!
}