Template & Library — 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.

BlueprintService

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

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/blueprints	ListBlueprints	factory.blueprints.read	read	natural	GW-03	Blueprints of a project by kind and state with versions.
GET	/factory/blueprints/{blueprintId}/versions/{version}	GetBlueprintVersion	factory.blueprints.read	read	natural	GW-03	One version with document, validation report, context map and domain model references.
POST	/factory/blueprints	CreateBlueprintVersion	factory.blueprints.write	shared-write	key-header	GW-03	Store a descriptor document as a new Draft version (people through the Studio; agents through the write-file and propose-change-set tools under their run).
POST	/factory/blueprints/{blueprintId}/versions/{version}/validate	ValidateBlueprint	factory.blueprints.write	shared-write	natural	GW-03	Validate against the kind's schema and rules; derive the context map and domain model; store the report.
POST	/factory/blueprints/{blueprintId}/versions/{version}/submit	SubmitBlueprint	factory.blueprints.publish	publication	natural	GW-03	Submit a Validated version to Asset Publication as a blueprint release candidate.

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Blueprints	GetDerivedModel	none	internal	read	Context map and domain model for a blueprint version (generation recipes and agents read it).

TemplateCatalogHost

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

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/templates/health	TemplatesHealth	factory.health.read	read	natural	GW-01	Liveness, readiness and dependency health (templates store, package feeds, asset publication, inbox lag).
GET	/templates/meta/feeds	TemplatesFeeds	factory.meta.read	read	natural	GW-03	Package feeds and template sources configured per installation.

GenerationRecipeService

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

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/recipes	ListRecipes	factory.recipes.read	read	natural	GW-03	Recipes of a project with versions and state.
GET	/factory/recipes/{recipeId}/versions/{version}	GetRecipe	factory.recipes.read	read	natural	GW-03	The module plan, pinned versions, switches, parameters, layout and compatibility evidence.
POST	/factory/recipes	DraftRecipe	factory.recipes.write	shared-write	key-header	GW-03	Draft a recipe from a Published blueprint version (the module plan is proposed from the context map; people or agents adjust it).
POST	/factory/recipes/{recipeId}/versions/{version}/validate	ValidateRecipe	factory.recipes.write	shared-write	natural	GW-03	Validate modules against manifests, switches and the compatibility matrix.
POST	/factory/recipes/{recipeId}/versions/{version}/approve	ApproveRecipe	factory.recipes.approve	shared-write	natural	GW-03	Approve a Validated recipe for generation (Requester or Asset maintainer; policy may require a Reviewer).
GET	/factory/projects/{projectId}/generated-outputs	ListGeneratedOutputs	factory.recipes.read	read	natural	GW-03	Provenance of generated modules by commit with generated and preserved files.

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Recipes	GetApprovedRecipe	none	internal	read	The approved recipe a generation run executes (agents read it at the start of the run).
Recipes	RecordOutput	none	internal	shared-write	Record generated-output provenance from a generation attempt.

TemplateRegistryService

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

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/templates	ListTemplates	factory.catalog.read	read	natural	GW-03	Template versions with layer, state, switches and consumers (the generated template catalog at runtime).
GET	/factory/templates/{templateId}/versions/{version}	GetTemplateVersion	factory.catalog.read	read	natural	GW-03	The pinned manifest with projects, switches, generated and preserved paths, pipelines, docs and compatibility.
GET	/factory/libraries	ListLibraries	factory.catalog.read	read	natural	GW-03	Library versions by area and layer with packages and consumers.
GET	/factory/compatibility	QueryCompatibility	factory.catalog.read	read	natural	GW-03	Compatibility of a template or library version with libraries, runtimes, editions and topologies, with evidence.
POST	/factory/templates/discover	DiscoverTemplates	factory.catalog.admin	shared-write	natural	GW-03	Re-read template repositories and feeds now (Asset maintainer, Platform admin).
POST	/factory/templates/{templateId}/versions/{version}/publish	PublishTemplateVersion	factory.catalog.admin	publication	natural	GW-03	Submit a Verified template version to Asset Publication as a template release.

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Catalog	ResolveManifest	none	internal	read	Pinned manifest of a template version for recipes and agents.