TerminologyΒΆ

Daybed concepts are very similar to those of any other storage or model validation software.

Credentials

Credentials are a way to authenticate yourself, and are composed of two parts:

  1. an ididentifier that you can publicly share
  2. a key – similar to a password (you may prefer to not share it)
Definition
A schema defined as a list of fields, each one with a name, a type and potential parameters.
Field
A model definition is composed of multiple fields. Each one contains a name and a type.
Field type
A type, among those available, whose purpose is to validate values (e.g. int, date, ...). It may have mandatory or optional parameters, when used in a definition (e.g. choices, regex, ...).
Identifier
Identifiers

A unique id, part of the credentials, that will be associated to the models and records you created.

Identifiers are used to define permissions.

Model
Models
A model is made of a definition, a set of records, and a list of permissions.
Permission
Permissions

An operation name used to allow or deny requests on models, records or tokens. Permissions are given to identifiers as an associative array on models.

For example, when trying to delete a record, if the request’s identifier doesn’t have delete_records among its permission on this model, the permission will be denied.

See permissions section.

Record
Records
An item to be stored in a model. It should provide a value for each required field of the definition.
Token
Tokens
Hawk-Session-Token
An unique string from each pair of id and key, and helps you keep, handle or share your credentials as a simple string.