Example
See what a change breaks before you make it
The auth team wants to drop refreshToken from the login answer. In Draft mode they make the change as a draft, see on the map which apps it breaks and which teams to tell, and then share it, ask for it, publish it or throw it away. Nothing changes for anyone else until it is published.
You will build
- A draft change to POST /api/v1/login
- The impact: the broken contract, the field and the owners to notify
- A shared read-only link with a comment thread in chat
System map
- Web AppAuth ServicePOST /api/v1/login
Part 1: Draft the change
- 1.
Open System map and open the Draft tab on the left and turn on Draft mode. It shows 0 drafts. - 2.
Open Auth Service → APIs and click the POST /api/v1/loginrow, then Edit. The form says it is a draft. - 3.
Under Responses, delete the refreshToken: stringline from the 200 body and click Save draft.
Check:
Part 2: Read the impact
- 1.
Under Draft impact, the panel lists what would break and the Owners to notify. - 2.
Click Web App → Auth Service in the panel. The connection opens and shows refreshTokenas the field the web app expects but would no longer get.
Part 3: Share it, then decide
- 1.
Click Share. A read-only link is copied, and a comment thread for it starts in chat. Send the link to the web app team. - 2.
Or click Request change instead: someone who edits endpoints opens the link and clicks Accept and publish. - 3.
To keep it, click Publish drafts. The dialog says how many contracts it breaks before you confirm. - 4.
To drop it, click Discard and confirm. The live API was never touched. - 5.
Turn off the Draft mode switch at the top of the Draft tab to leave it. Unpublished drafts are kept for you; the map offers Resume.
Check:
