Data Architect Docs

API Contract Examples

Data Architect derives OpenAPI, GraphQL, and Zod schemas from your approved database schema. Example OpenAPI snippet:

openapi: 3.0.3
paths:
  /api/users:
    get:
      summary: List users
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/User"
components:
  schemas:
    User:
      type: object
      properties:
        id: { type: string, format: uuid }
        email: { type: string, format: email }
        created_at: { type: string, format: date-time }

Schemas are synchronized with the database. No manual drift. Human approval required before schema changes propagate.

Migration Plan Sample

Expand/Contract pattern for zero-downtime schema evolution. Example migration plan:

-- Phase 1: Expand (add new column, nullable)
ALTER TABLE orders ADD COLUMN region VARCHAR(64) NULL;

-- Phase 2: Backfill (run application logic)
-- Application populates region from existing data

-- Phase 3: Contract (make NOT NULL after backfill)
ALTER TABLE orders ALTER COLUMN region SET NOT NULL;

Migration plans are produced as structured artifacts. Review and approve before deployment.

Schema Drift Visualization

When the live database diverges from the approved schema, Data Architect surfaces drift reports:

Alerts notify the team. Audit logs track every schema change. Role-based access controls govern who can approve deployments.