Skip to main content

Promoting Schemas to the Schema Registry

The Schema Registry holds finalized schemas shared across your organization. Promote a schema once its structure is settled, so other teams reuse the approved definition instead of writing their own copy.

Promoting also links the application's schema to the published version, so the application now references the shared schema.

Before you begin​

  • Finish the schema. Promote it when its structure is stable, not while you are still changing it.
  • Know which Schema Registry collection it belongs in.

Promote a schema​

  1. Open the schema from the application in view mode.
  2. Select Promote.
  3. Select the Collection to add the schema to.
  4. Optionally, select the Edit icon next to the schema name to rename it before publishing.
  5. Select Promote.

How you know it worked​

A confirmation message reads <name> promoted to global schema successfully, and the schema appears in the collection you selected, available to everyone in the organization.

When it does not work​

SymptomCauseWhat to do
Collection is requiredNo collection was selected.Select a collection before promoting.
Failed to promote application schema.The schema could not be published.Retry. If it persists, confirm you still have access to the collection and contact your workspace administrator.

Next steps​

Promoted schemas can be pulled into any application with Search Registry. See Creating Schemas.