Skip to content
Visit geeconglobal.com
Geecon Global
Menu

Schema Builder docs

Managing schemas

Create, edit, deprecate and delete schemas, and how Schema Builder protects existing entries.

Admins manage schemas from Apps → Schema Builder. A schema has a name, an ID, an optional description and a list of fields. You can drag fields to reorder them with the mouse or the keyboard, and each field has its own settings and validation. A live preview shows the form editors will see.

IDs

  • A schema ID starts with a letter, contains only letters and digits, has at most 64 characters, and must be unique. SchemaRegistry is reserved.
  • A field ID starts with a letter, contains letters, digits or underscores, has at most 64 characters, and must be unique within its schema.
  • Schema Builder suggests the schema ID from its name until you edit the ID yourself.

What locks once entries exist

Once any entry uses a schema, its ID is locked, and so are the ID and type of each of its existing fields. This also applies while the entry count is still loading. Fields you add in the current edit can still change.

Removing and restoring fields

When you remove a field from a schema that has entries, Schema Builder remembers its ID and type. Its values stay in the entries. If you add a field back with the same ID and type, the data returns, and the editor warns you first. You can't reuse the same ID with a different type.

Deprecate

Deprecating a schema hides it from the schema picker for new entries. Existing entries stay editable and show a Deprecated badge. Restore undoes it.

Delete

You can't delete a schema while entries use it, or while the entry count is unknown. Deprecate it instead. A schema with no entries can be deleted after you type its ID to confirm.

Entry counts

The count is the number of Schema Builder entries whose type matches the schema ID. Schema Builder counts again before risky saves, and keeps your draft if a save fails.

Unsaved changes

The app's Back and Discard buttons ask before throwing away unsaved changes, and so does the browser when you close or reload the tab. Moving to another part of Contentful, such as the Content tab, closes the app without a warning, so save first.