How-to
View and update a schema
Read a topic's data contract and publish a new version
What you'll achieve
Read a topic's current data contract and, if needed, publish a new version of it (called evolving the schema).
Before you start
- Viewing needs no special rights; updating needs Developer or higher and an environment that allows changes — in a read-only environment only admins can update.
- The portal always shows the latest version of a schema — older versions aren't browsable here, so the Version number you see is the current one.
- New versions must stay compatible with the old one — the rules are in the Schemas guide.
Steps
- Click Schemas in the sidebar (under Resources) and click the schema's name in the Subject column. You'll see the schema text plus its Version, Schema ID, and Type — done, if reading was all you wanted.
- To update it, click Edit.
- Make your change in the editor — typically adding a new optional field. Use Validate JSON to check your edit.
- Click Evolve.
What success looks like
A confirmation appears: "Schema evolved successfully", with a View Schema button. The schema's Version number has gone up by one.
Something went wrong?
- "No changes detected" — the text is identical to the current version; nothing was published.
- An error mentioning compatibility — your change breaks the compatibility rules (e.g. removing a field or adding a required one). See schema evolution for what's allowed, or ask the application team.
- No Edit button appears on the schema's page — you don't have edit rights here (read-only environment or Viewer role); ask your team's admin.
Background — what compatibility means and how versions work? Read the Schemas guide.