Skip to content
Geecon Global
Menu

Schema Builder docs

Getting started

Install Schema Builder in a Contentful space and create your first schema.

Install in a space

Install Schema Builder from your space's Apps area. During installation the configuration screen asks which content type to use. The default ID is schemaBuilderEntry.

  • If the content type doesn't exist, Schema Builder creates and publishes it with three fields: title (Short text), type (Short text) and jsonField (JSON object). It also sets itself as the editor for jsonField.
  • If it exists with those fields, Schema Builder reuses it as it is.
  • If it exists with different fields, installation stops and lists the problems. Schema Builder never changes an existing content type.

Create your first schema

  1. In Contentful, open Apps → Schema Builder.
  2. Create a schema and give it a name. Schema Builder suggests an ID from the name, and you can change it until the first entry uses the schema.
  3. Add fields, choose their types and set any validation.
  4. Save. The first save creates the Schema Registry entry that stores all your schemas.

Create an entry

Editors add a Schema Builder Entry, pick a schema and fill in the form. See Filling in entries.