Blueprints
Blueprints (formerly Custom Resource Definitions) define the structure of resources. Think of a blueprint as a form template that users can fill out to create resources. Each blueprint has fields that define the type of data that can be stored in the resource.
Blueprint types
Resource
A resource blueprint is the most basic type of blueprint. It defines a resource that can be created and modified using the admin panel. It's suitable for resources that are consumed by a static website, such as blog posts or products.
Singular resource
A singular resource blueprint is a special type of blueprint that can only have one instance. It's suitable for storing project-wide information such as site settings or contact information. A singular resource will only create a form page in the project navigation, meaning that it won't be possible to list or delete the resource. API responses will only include the singular resource attributes.
Read-only resource
A read-only resource blueprint is a special type of blueprint that can't be modified using the admin panel. It's suitable for resources that can be created by a static site, such as form submissions or comments. A read-only resource appears in the admin panel, but it cannot be published or deleted.
Blueprint fields
Blueprint fields define the structure of the resource. Each field has a type that determines the type of data that can be stored in the field.
Text
A text field is a standard text field. It's suitable for storing short text values such as titles or names.
Rich text
A rich text field is an HTML text editor. It's suitable for storing long text values such as blog posts or product descriptions.
The contents of a rich text are stored as HTML, which means that it can contain images, links, and other HTML elements.
Image
An image field is an image upload field. It will allow users to upload an image file, which will be stored and served from the Diggama CDN.
The image field will return the URL of the uploaded image, which can be used in the frontend to display the image.
File
Same as the image field, but for any type of file.
Link
A link field is a URL field. It will enforce the user to enter a valid URL.
Color
A color field is a color selector. It will allow users to select a color from a color picker.
The color field will return the color value in HEX code format.
Date
A date field is a date picker. It will allow users to select a date from a calendar.
It will be returned by the API in the YYYY-MM-DD format.
Date and time
A date and time field is a date and time picker. It will allow users to select a date and time from a calendar.
It will be returned by the API in the YYYY-MM-DD HH:MM format.
Boolean
A boolean field is a checkbox. It will allow users to select a true or false value.
Slug
A slug field is a text field that will be used to generate a URL-friendly slug from the resource title, or any other field you may choose.
A slug is guaranteed to be unique for the specific resource, and will not be able to change once the resource is created, so it can be used as URL variable.
Reference
A reference field is a field that will allow users to link another resource to the current resource.
The API will return the linked resource ID in the response.