How harshilmaks/tenancy-service works
Tenancy Service is a FastAPI multi-tenant organization management API. The principal workflow accepts a tenant request, validates and maps it at the API boundary, invokes a use case, applies domain rules, persists through the repository, and returns a response. Separate capabilities cover lifecycle and policy operations, onboarding and compliance, edition-based features, billing, and operational observability. The README documents the overall architecture; sampled routes and the source index confirm selected calls. Other unsampled subsystem links are omitted where their wiring is not shown.
Main entry points: tenant_repository.py Tenant repository · use_cases Tenant use cases · main.py FastAPI application · routes.py Tenant routes
Components 22
API entry
- FastAPI application
app/main.py - Tenant routes
app/api/tenants/routes.py - Request schemas
app/schemas/v1/requests_responses.py - Dependency providers
app/dependencies/providers.py
Tenant business
- Tenant use cases
app/business/use_cases - Lifecycle rules
app/business/domain/entities/lifecycle.py - Policy rules
app/business/domain/entities/policies.py - Domain events
app/business/events/tenant_events.py - Organization model
app/db/models/domain_models.py
Tenant capabilities
- Feature gating API
app/api/features/routes.py - Onboarding workflow
app/api/onboarding/routes.py - Compliance API
app/api/compliance/routes.py - Retention API
app/api/retention/routes.py - Cancellation workflow
app/api/cancellations/routes.py - Billing integration
infrastructure/billing/billing_service.py
Persistence
- Tenant repository
infrastructure/persistence/tenant_repository.py - Relational database
Operations
- Health monitoring
infrastructure/observability/health.py - Structured logging
infrastructure/observability/logging.py - Metrics collection
infrastructure/observability/metrics.py - Distributed tracing
infrastructure/observability/tracing.py
Other components
- API client
Connections 22
- API client → FastAPI application: sends requests
- FastAPI application → Tenant routes: registers routes
app/main.py - Tenant routes → Request schemas: validates requests
app/api/tenants/routes.py - Tenant routes → Dependency providers: resolves dependencies
app/api/tenants/routes.py - Dependency providers → Tenant use cases: builds use cases
app/dependencies/providers.py - Tenant routes → Tenant use cases: executes
app/api/tenants/routes.py - Tenant use cases → Lifecycle rules: checks transitions
app/business/use_cases/create_tenant.py - Tenant use cases → Domain events: publishes events
app/business/use_cases/create_tenant.py - Tenant use cases → Tenant repository: persists tenants
- Tenant repository → Organization model: maps models
- Tenant repository → Relational database: reads and writes
- Tenant use cases → Policy rules: evaluates policies
app/business/use_cases/enforce_policy.py - Feature gating API → Tenant repository: loads tenant
app/api/features/routes.py - Onboarding workflow → Tenant repository: saves progress
app/api/onboarding/routes.py - Compliance API → Tenant repository: loads tenant
app/api/compliance/routes.py - Retention API → Tenant repository: updates retention
app/api/retention/routes.py - Cancellation workflow → Tenant repository: updates status
app/api/cancellations/routes.py - FastAPI application → Health monitoring: exposes checks
- FastAPI application → Structured logging: configures logging
- FastAPI application → Metrics collection: configures metrics
- FastAPI application → Distributed tracing: configures tracing
- Tenant use cases → Billing integration: billing integration