wikijs/server/graph/schemas/common.graphql

# ====================== #
# Wiki.js GraphQL Schema #
# ====================== #

# DIRECTIVES
# ----------

directive @auth(requires: [String]) on QUERY | FIELD_DEFINITION | ARGUMENT_DEFINITION

# TYPES
# -----

# Generic Key Value Pair
type KeyValuePair {
  key: String!
  value: String!
}
# General Key Value Pair Input
input KeyValuePairInput {
  key: String!
  value: String!
}

# Generic Range Value
type Range {
  min: Int
  max: Int
}

input RangeInput {
  min: Int!
  max: Int!
}

# Generic Mutation Response
type DefaultResponse {
  responseResult: ResponseStatus
}

# Mutation Status
type ResponseStatus {
  succeeded: Boolean!
  errorCode: Int!
  slug: String!
  message: String
}

# ROOT
# ----

# Query (Read)
type Query

# Mutations (Create, Update, Delete)
type Mutation

# Subscriptions (Push, Real-time)
type Subscription