Creating a Resource (Schema)

A Resource Definition (Schema) is the main building block for creating services with Clarabase. Here you will define the name and description of your resource and define the properties and types that describe the schema for your resource.

It is important to note the following:

• The name of a resource definition must be unique for your account

• Clarabase will automatically convert your resource's name and it's property names into a url friendly format

• There are 3 reserved properties that Clarabase automatically manages for you: id, createdAt, and updatedAt. These values are always returned in your API responses

A resource definition is just a JSON Schema, and under-the-hood, it uses these schema to validate creation request objects.

Data Types

Clarabase supports the following data types:

• string

• number

• boolean

• array

• object

• relationship

Depending on the type that you select, there will be type-specific options available. For example, if you select a string type, you can specify a particular regex pattern or format (i.e. Date-Time, URI, etc.). This will be used to validate request payloads to create this resource.

A relationship is a special type. It allows you to reference another resource in your API. It is essentially treated as a foreign key and it's type is always a string.

Once you have defined a resource, you may immediately start making API requests with zero deploy! You can update the schema for your resource at anytime with zero downtime!