Documentation for v2.8.0. Read the latest, v2.12.0.
Developer
Developer track
Seven chapters for the developer who provides a spec, pins a dependency and wires both into a build. They assume the Concepts page.
-
Chapter 1
The web UI
Producers, the spec viewer with diff and blame, Consumers, the graph, the reports.
-
Chapter 2
sanshain.yaml
The one file every client reads: provides, requires with exact pins, the catalog push.
-
Chapter 3
Clients
Maven, cargo, Go, JavaScript with its GitHub Action, Conan: install and commands.
-
Chapter 4
API lifecycle
Snapshots, GA, the proposed next version, deprecation, AsyncAPI message contracts.
-
Chapter 5
Release graphs
Trunk and the main graph, cutting a sanshain-branch, hotfixes by tag, the timeline.
-
Chapter 6
CI integration
Tokens, stability and streams from the pipeline, dry runs, idempotency, examples.
-
Chapter 7
MCP for AI assistants
A read-only token, the endpoint, client configuration, the seven tools, the limits.
-
Chapter 8
A team's story
The payments team from a first sanshain.yaml to a released 2.1.0, with the orders Consumer pinning it: twelve steps, every answer recorded against 2.6.0, with a live graph.
-
Chapter 9
Developer recipes
Single tasks with the command, the recorded answer and the links: a read-only token, the validator, a forgotten bump, a branch, the catalog push, MCP.
The REST contract itself is the REST API reference, and Using the API explains tokens, scopes and error shapes. Webhook receivers, deployment and administration are in the Operator track.
Checked against v2.6.0.