GraphQL Schema Generator

"""
An ISO 8601-encoded datetime string.
"""
scalar DateTime

"""
A unique identifier.
"""
scalar JSON


"""
Directive to enforce role-based access control on fields and types.
"""
directive @auth(requires: Role = USER) on OBJECT | FIELD_DEFINITION

"""
Available roles for authorization.
"""
enum Role {
  """Full system access"""
  ADMIN
  """Standard user access"""
  USER
  """Read-only access"""
  GUEST
}


"""
Information about pagination in a connection.
"""
type PageInfo {
  """Whether there are more items after this page."""
  hasNextPage: Boolean!
  """Whether there are more items before this page."""
  hasPreviousPage: Boolean!
  """Cursor pointing to the first item in the page."""
  startCursor: String
  """Cursor pointing to the last item in the page."""
  endCursor: String
}

"""
Standard error payload for mutations.
"""
type UserError {
  """Human-readable error message."""
  message: String!
  """Which input field caused the error, if applicable."""
  field: [String!]
}

"""
The primary User entity.
"""
type User {
  """Unique identifier for the User."""
  id: ID!
  """Full name of the User."""
  name: String!
  """Email address of the User.""" @auth(requires: ADMIN)
  """Role assigned to the User."""
  role: UserRole!
  """When the User was created."""
  createdAt: DateTime!
  """When the User was last updated."""
  updatedAt: DateTime!
}

"""
Role options for User.
"""
enum UserRole {
  ADMIN
  USER
  VIEWER
}

"""
A connection to a list of users.
"""
type UserConnection {
  """List of edges containing user nodes."""
  edges: [UserEdge!]!
  """Pagination information."""
  pageInfo: PageInfo!
  """Total number of users matching the query."""
  totalCount: Int!
}

"""
An edge in a User connection.
"""
type UserEdge {
  """The cursor for this edge."""
  cursor: String!
  """The User node."""
  node: User
}

type Query {
  """
  Fetch a single User by ID.
  """
  user(id: ID!): User @auth(requires: USER)

  """
  Fetch a paginated list of users using cursor-based pagination.
  """
  users(
    """Number of items to return."""
    first: Int
    """Cursor to start after."""
    after: String
    """Number of items from the end."""
    last: Int
    """Cursor to end before."""
    before: String
    """Filter by role."""
    role: UserRole
    """Search by name or email."""
    search: String
  ): UserConnection! @auth(requires: USER)
}

input CreateUserInput {
  """Full name of the User."""
  name: String!
  """Email address of the User."""
  email: String!
  """Role to assign (defaults to USER)."""
  role: UserRole
}

input UpdateUserInput {
  """Updated name."""
  name: String
  """Updated email."""
  email: String
  """Updated role."""
  role: UserRole
}

"""
Payload returned by user mutations.
"""
type UserPayload {
  """The affected User, or null if the operation failed."""
  user: User
  """Any validation or business logic errors."""
  userErrors: [UserError!]!
}

type Mutation {
  """
  Create a new User.
  """
  userCreate(input: CreateUserInput!): UserPayload! @auth(requires: ADMIN)
  
  """
  Update an existing User.
  """
  userUpdate(id: ID!, input: UpdateUserInput!): UserPayload! @auth(requires: USER)
  
  """
  Delete a User.
  """
  userDelete(id: ID!): UserPayload! @auth(requires: ADMIN)
}