Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Schema section is the key part of your custom data schema and will be where you spend most of your time. The Schema is defined using the JSON-schema standard, except with some additional fields and options that allow you to control the form of the data.

The root of your schema must always have "type": "object". Then, under the properties section is where you start to configure the actual properties of your schema. Here is an example of a section that you could put under properties:

Code Block
        "brief": {
            "description": "A brief description of the project described in the proposal",
            "multiline": true,
            "rows": 4,
            "show_in_table_view": true,
            "table_view_order": 3,
            "title": "Brief",
            "type": "string"
        }

So if you put this into the properties section, the overall would look like this:

Code Block
{
    "properties": {
        "brief": {
            "description": "A brief description of the project described in the proposal",
            "multiline": true,
            "rows": 4,
            "show_in_table_view": true,
            "table_view_order": 3,
            "title": "Brief",
            "type": "string"
        }
    },
    "type": "object"
}

...

If you expand the options for the field, you will get something that looks like this.

...

Configuring Fields

Fields can have any of the following properties:

...