Collections | JsonApi

Data models

0 collections in current account.

List of collections

New valid schema is saved; Deleting collection does not delete resources.

Collection	Prefix	Resources	Update	Operation

Create collections

Draft 2020-12, using only local references.

Collection name

Resource prefix Optional

Begins with letters; contains only lowercase letters and numbers.

JSON Schema Draft 2020-12

Maximum 64 KiB, depth 20 and 2,000 nodes.

Instructions for writing JSON Schema

Schema used JSON Schema Draft 2020-12 to check the data before the resource is saved.

Commonly used structure

type defines the data type.
properties declares the fields.
required lists required fields.
additionalProperties: false rejects fields outside the schema.

System rules

The root schema must be an object or a boolean.
Only local references are supported through $ref, for example #/$defs/address.
References to external schemas are not supported.
Maximum 64 KiB, depth 20 and 2,000 nodes.

For example

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": { "type": "string", "minLength": 1 },
    "price": { "type": "number", "minimum": 0 },
    "status": { "enum": ["draft", "published"] }
  },
  "required": ["name"],
  "additionalProperties": false
}

Extras mappings Optional

Array JSON includes sourceField and destField; Use [] if embed is not needed.

Instructions for configuring Extras

Extras automatically embeds referenced resources in the response. Use sourceField to read the resource ID and destField to place the embedded data.

How to declare

sourceField must exist in schema.properties and allow the string type.
destField must not duplicate a property declared in the schema.
The two fields must be different and cannot be repeated between mappings.
Use [] when the collection does not need embedded resources.

Limit

Maximum 20 mappings per collection.
Field name maximum 64 characters.
The name must begin with a letter or an underscore.
Contains only letters, numbers and underscores.

For example

[
  {
    "sourceField": "authorId",
    "destField": "author"
  }
]

With this mapping, authorId must be declared as a string in the JSON Schema; the related resource appears at author.

Data models

List of collections

No collections yet

Create collections

Commonly used structure

System rules

For example

How to declare

Limit

For example