RabbinatixDocs
Sign inGet started

Map your systems

Change impact and Draft mode

See what an API change would break before anyone feels it, share the drafts for review, and publish them when they are right.

Open System map in the app

What Draft mode is for

Draft mode answers "if I change this API, what breaks?" before the change is live. (For changes already made in code, in a pull request, between two branches or by your AI assistant, see Code impact.) You edit endpoints as drafts. Nothing changes for anyone else while you do. The map shows what your drafts would do to every contract and flow that depends on them.

Your drafts are saved for you. Leaving Draft mode or reloading the page keeps them until you publish or discard them. Anyone can draft. Publishing needs the permission to edit endpoints.

Draft a change

  1. On the system map, open the Draft tab on the left and turn on Draft mode at its top. Under the switch are Publish drafts, Share, Request change and Discard.
  2. Open the endpoint you want to change. Click a line, then a row, then Edit provider in the contract, or open it from its system.
  3. Edit it. The editor header says DRAFT.
  4. Press Save draft. Repeat for every endpoint the change touches.

While Draft mode is on, systems and connections can't be changed. Only endpoint edits become drafts.

Read the impact

Under the buttons, the Draft tab shows the Draft impact:

  • how many contracts would break, and how many teams to notify
  • each affected contract with its status now and after your drafts; click one to open it
  • Affected flows
  • Owners to notify

If nothing changes status, the panel says it is safe to publish.

Check before you change anything

You don't need Draft mode to see who depends on an endpoint.

  • In the endpoint editor, Impact on consumers lists each consumer with its status before and after your edit, before you save. When the API is public, it also counts the other organizations that subscribe to it.
  • The Consumers & field usage tab lists the consumers, and Response field usage shows which of them read each response field. A field nobody reads is marked safe to remove.
  • Impact on What’s linked, or the Impact tab of a related panel, shows everything a change reaches, with the chain that explains each step.

Publish or discard

  • Publish drafts makes every draft the next revision of its live endpoint, all at once. The confirmation says how many contracts will break. If someone changed one of the drafted endpoints since you drafted it, nothing is published, so you never overwrite their work.
  • Discard throws the drafts away. The live endpoints stay as they are, and links you shared to them stop working.
  • The × closes Draft mode and keeps your drafts. A reminder says how many you have, with Resume.

Share drafts for review

  1. In the Draft tab, press Share.
  2. A read-only link appears. Send it to the teams you want to review the change.
  3. A comment thread is posted in chat, in the channel of the system the drafts change (or #general when they change several). Comments in the panel opens it.

A member who opens the link sees your drafts and their impact, read-only, with View impact and Close. When you publish or discard the drafts, the link says they are no longer available. See Chat.

Ask for a change

Consumers can propose a change to someone else's API in the same way.

  1. Turn on Draft mode and draft the change you need.
  2. Press Request change. A shared copy is made and a "Change request" thread starts in chat.
  3. A member who can edit endpoints opens the link and sees Accept and publish. Accepting publishes the drafts as the next revisions, notes whose request it was, and replies in the thread.
TipShare a draft link in a code change so reviewers see which consumers a change breaks before it is merged.