📝 Auto-Generated Documentation

from fraiseql import fraiseql

@fraiseql.type
class User:
    """
    A user account in the system.

    Users can create posts, comment on content, and manage their profile.
    Supports multi-tenant isolation via organization_id.

    Fields:
        id: Unique identifier for the user
        email: Primary email address (validated)
        name: Full display name
        created_at: Account creation timestamp
        organization: Associated organization for multi-tenancy
    """
    id: int
    email: str
    name: str
    created_at: datetime
    organization: "Organization"

@fraiseql.query
async def users(info) -> list[User]:
    """
    Retrieve all users in the current organization.

    Automatically filtered by organization_id from JWT context.
    Supports pagination, filtering, and sorting.
    """
    return await info.context.db.fetch_all()

# FraiseQL automatically generates:

"""
A user account in the system.

Users can create posts, comment on content, and manage
their profile. Supports multi-tenant isolation via
organization_id.
"""
type User {
  "Unique identifier for the user"
  id: Int!

  "Primary email address (validated)"
  email: String!

  "Full display name"
  name: String!

  "Account creation timestamp"
  created_at: DateTime!

  "Associated organization for multi-tenancy"
  organization: Organization!
}

"""
Retrieve all users in the current organization.

Automatically filtered by organization_id from JWT context.
Supports pagination, filtering, and sorting.
"""
type Query {
  users: [User!]!
}

# Developers see full documentation in their tools:

# Hovering over "User" type shows:
# ┌───────────────────────────────────────┐
# │ User                                  │
# ├───────────────────────────────────────┤
# │ A user account in the system.         │
# │                                       │
# │ Users can create posts, comment on    │
# │ content, and manage their profile.    │
# │ Supports multi-tenant isolation via   │
# │ organization_id.                      │
# └───────────────────────────────────────┘

# Hovering over "email" field shows:
# ┌───────────────────────────────────────┐
# │ email: String!                        │
# ├───────────────────────────────────────┤
# │ Primary email address (validated)     │
# └───────────────────────────────────────┘

# Zero manual documentation writing needed! ✅