Schema Catalog

Overview

This page gives you a complete overview of the JSON Schema definitions used across Beefree SDK. Each schema plays a role in providing data structures that can be used to validate formats, properly format request bodies for API calls, or serve as a tool for storing templates, rows, and more in your backend.

Each of the following schemas has a dedicated page, but this catalog gives you the big picture and helps you understand how the pieces connect.

Schema Index

The following section includes a comprehensive list of schemas in Beefree SDK.

Name: Definitions Schema

Description: Contains shared definitions and reusable schema components used across all simple schema modules.

GitHub File: definitions.schema.json

---

Name: Button Schema

GitHub File: simple_button.schema.json

Description: Describes the structure for a customizable button.

---

Name: Divider Schema

GitHub File: simple_divider.schema.json

Description: Describes available Divider content block properties.

---

Name: HTML Schema

GitHub File: simple_html.schema.json

Description: Enables the insertion of raw HTML blocks for advanced customization beyond standard modules.

---

Name: Icons Schema

GitHub: simple_icons.schema.json

Description: Describes available Icon content block properties.

---

Name: Image Schema

GitHub: simple_image.schema.json

Description: Describes the available Image content block properties.

---

Name: List Schema

GitHub File: simple_list.schema.json

Description: Describes an unordered or ordered list with multiple items and styling options.

---

Name: Menu Schema

GitHub File: simple_menu.schema.json

Description: Describes available Menu content block properties.

---

Name: Paragraph Schema

GitHub File: simple_paragraph.schema.json

Description: Describes available Paragraph content block properties.

---

Name: Title Schema

GitHub File: simple_title.schema.json

Description: Defines header or title elements with configurable properties.

---

Name: Column Schema

GitHub File: simple_column.schema.json

Description: Defines the layout and content rules for a column.

---

Name: Row Schema

GitHub File: simple_row.schema.json

Description: Manages layout rows, defining structure and grouping content.

---

Name: Template Schema

GitHub File: simple_template.schema.json

Description: Top-level schema representing the entire design template, including layout, metadata, and content.

---

Name: Row Metadata

Description: Reusable or saved rows can include a metadata object to help organize and manage them within the builder interface.

---

Name: Form Validation

GitHub File: form_validation_schema.json

Description: Schema for building and validating forms for popup and page builders.

---

Name: Comments Schema

Description: Defines the structure for storing comment threads tied to specific content elements within a template.

---

Name: Change Schema for Comments

Description: Defines the structure for tracking changes in collaborative environments, particularly for managing comment threads within content blocks.