Generated SaaS — APIs

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.

GeneratedSaasFoundations

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/product/tenants	ListProductTenants	product.admin.read	read	natural	GW-07	Product tenants with state, region and the opaque customer-tenant id (product owner and fleet).
POST	/product/tenants	ProvisionProductTenant	product.admin.write	shared-write	key-header	GW-07	Provision a customer tenant in the product (self-service sign-up or owner action).
GET	/product/tenants/{productTenantId}/subscription	GetProductSubscription	product.admin.read	read	natural	GW-07	Edition, entitlements, seats and metered usage.
PUT	/product/tenants/{productTenantId}/subscription	ChangeProductSubscription	product.admin.write	shared-write	natural	GW-07	Change edition or seats (the product's own commerce).

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Foundations	ResolveTenant	none	internal	read	Resolve a request's tenant and entitlements for the product's services (per-request claim).

GeneratedProductHost

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/product/descriptor	GetProductDescriptor	product.admin.read	read	natural	GW-07	The product descriptor (identity, provenance, tenancy mode, contexts, health and admin endpoints, objectives); read by fleet inventory through GW-07.
GET	/product/health	ProductHealth	product.health.read	read	natural	GW-07	Liveness, readiness and dependency health of the product's services.
GET	/product/operations/handover	GetOperationsHandover	product.admin.read	read	natural	GW-07	The managed-operations handover record.
POST	/product/operations/handover/acknowledge	AcknowledgeOperationsHandover	product.admin.write	shared-write	natural	GW-07	The product owner acknowledges the handover; fleet onboarding may proceed.
POST	/product/operations/export	ExportProductData	product.admin.write	external	key-header	GW-07	Export a customer tenant's data in open formats (invoked by an off-boarding order).
POST	/product/operations/delete-tenant	DeleteProductTenant	product.admin.write	production	key-header	GW-07	Delete a customer tenant's data (invoked by a deletion order after an acknowledged handover; production class).