Contracts & data
A diagram shows which parts of a system communicate. Contract Studio adds the useful detail: what a request means, what a message announces, and what information a data store holds.
When to use Contract Studio
Use contracts when a line on the diagram needs a shared explanation. For example: which web request is being made, which event is being published, or which information a service reads from a database. Contracts make reviews clearer without changing how a simulation runs.
You do not need contracts for a first diagram. Add them when the team needs agreement about an important boundary.
The four Contract Studio views
- Protocol contracts
- Describe important web requests, messages, and data operations in words people can review together.
- Data resources
- Name the tables, collections, caches, or business records that appear in the system story.
- Implementation
- Optionally record where an approved component is implemented or deployed, so reviewers can follow up with the right owner.
- Gap report
- Highlights important parts of the diagram that still need a description or an agreed link.
Add useful detail
- Save the diagram, then open Contracts in the workbench.
- Choose the kind of communication you want to describe: a web request, a message, or a data operation.
- Link it to the relevant components and connection, then add only the information your reviewers need.
- Open Gap report and work through the items that matter for this review.
Keep sensitive detail out
Describe shapes and meaning, not live secrets. Do not paste passwords, access keys, customer records, private source code, or production payloads into Contract Studio. Use neutral examples when an example is helpful.
These docs intentionally do not describe Mockflow's internal document formats or private validation rules. The editor presents the supported fields and checks them for you.