Schema

The schema outlines the document types that editors are allowed to create within Content.

Introduction

undefined

Main Screen

In the side menu select Schema. For the first time you will land on empty page where you can start adding your schema.

undefined

Here you can manage all your application schemas.

Toolbar

undefined

In the Module Toolbar you can find one main buttons :

  • Add Schema - add new Schema Entity.

Add Schema

undefined

In the Add Schema form you can find the next fields :

  • Name - Unique name used in generated JSON in APIs
  • Display Name - Name exposed to user in UI.
  • Type - A schema can be of two types :
    • ROOT - for document content.
    • NODE - for nested objects inside other schema.
    • ENUM - enumeration of static values.

ROOT and NODE

In the main Schema Screen, in the action section you will find pencil icon for EDIT action.

undefined

Here you can find the next form fields :

  • Name - Unique name used in generated JSON in APIs
  • Display Name - Name exposed to the user in UI.
  • Preview Field - Filed that will appear in Schema overview in Content Editor.
  • Preview Image - The image will appear on Schema mouse over in Content Editor.
  • Fields - Fields definition that defines the Content shape.

A list of all schema kinds available :

ENUM

In the main Schema Screen, in the action section you will find pencil icon for EDIT action.

undefined

Here you can find next form fields :

  • Name - Unique name used in generated JSON in APIs
  • Display Name - Name exposed to user in UI.
  • Values - Values for enumerations with Name and Values. Names will be used in UI and values in REST JSON.

© Copyright 2024 Lessify Rights Reserved. Build with Localess