v1.9.2: Endpoint and DTO documentation by convention

Every endpoint and every DTO is documented, with the OpenAPI schema as the single source of truth — consumed by the API reference, the docs site, the MCP surface and the Terraform provider.

Full notes: 1.9.2 on GitHub.

Where to see it

  • docs.snapcd.io/api-reference — the published reference, browsable without an account. Static: it renders the spec, but there is no server behind it, so nothing is callable.
  • /ApiReference in your own dashboard — the same document, interactive. Try-it runs against your organization with your own credentials.

Documentation by convention

Controller XML doc comments are gone. They fed both the OpenAPI document — where inherited generic-controller docs leaked literal {Entity} placeholders — and the MCP codegen, which template-substituted them, giving two consumers inconsistent results.

EndpointDocConvention now derives heading-style summaries from the action name and entity: "Create a new AgentModuleSupply", "List all Agents", "Delete an Agent". Entity names come from the MCP entity attribute where present, else the controller name. [EndpointSummary] overrides the convention wherever the derived text is wrong.

Enforced coverage

An undocumented endpoint or DTO fails the generator, so documentation cannot silently drift from the API as new endpoints are added.

Snap CD

Intelligent GitOps for Infrastructure as Code. Automate, orchestrate, and scale your infrastructure deployments with confidence.


© 2026 Snap CD. All rights reserved.

An unhandled error has occurred. Reload 🗙