Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 4.42 KB

File metadata and controls

96 lines (66 loc) · 4.42 KB
//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE                                                                  //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-02-23                                            //
//////////////////////////////////////////////////////////////////////////////////////////////

Schema Documentation

This documentation describes a ZModel schema — the data modeling language used by ZenStack.

11 models · 2 views · 3 types · 6 enums · 6 procedures

Models · Views · Types · Enums · Procedures · Relationships · ERD

🗃️ Models

  • Article — A long-form content article published within a workspace.
  • AuditLog — A record in the append-only audit log for compliance and debugging.
  • Category — A content category for organizing articles within a workspace.
  • Comment — A threaded comment on an article.
  • Invoice — An invoice generated for a subscription billing cycle.
  • Notification — A notification delivered to a user.
  • NotificationPreference — Per-user notification delivery preferences.
  • Subscription — A subscription linking a workspace to a billing plan.
  • User — A registered user account in the platform.
  • Workspace — A collaborative workspace that groups users, content, and billing.
  • WorkspaceMember — Represents a user's membership in a workspace with an assigned role.

👁️ Views

  • ArticleAnalytics — Aggregated article metrics for the workspace analytics dashboard.
  • MemberActivity — Per-member activity summary for workspace admin dashboards.

🧩 Types

  • SoftDeletable — Adds soft-delete capability to a model.
  • Timestamps — Standard timestamp fields applied to all persistent entities.
  • WorkspaceAnalytics — Aggregated workspace-level analytics returned by getWorkspaceAnalytics.

🏷️ Enums

⚡ Procedures

  • cancelSubscription · mutation — Cancel a workspace subscription.
  • getWorkspaceAnalytics · query — Retrieve workspace analytics including article counts, total views, and member activity metrics.
  • inviteMember · mutation — Invite a new member to a workspace.
  • publishArticle · mutation — Publish an article, transitioning it from DRAFT to PUBLISHED.
  • searchArticles · query — Search articles within a workspace by title and body content.
  • unpublishArticle · mutation — Unpublish a live article, moving it back to DRAFT status.

🗺️ Entity Relationship Diagram

Entity Relationship Diagram

Mermaid source

📎 See Also


Generation Stats
Metric Value
Files 33
Duration 100.86 ms
Source schema.zmodel
Generated 2026-02-23