☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

Developer ReferenceConfiguration File

entries

Table of contents

Description:

This key defines the appearance and function of entries in a mutable Object Input.

The value is an object that can contain optional allowed_keys, structures, assigned_structures, comment, and documentation keys.

Available for Mutable Objects only.

Appears in:
└── _inputs
    └── *
        └── Object Input
            └── options
                └── entries
Type:
Object
Properties:
allowed_keysArray<allowed_keys[*]>#

This key defines a limited set of key names for nested keys within your Object Input.

The value is an array of key name strings. This affects entries when adding or renaming nested keys.

This set is used when entries are added and renamed with allow_create enabled. Has no effect if allow_create is not enabled.

Available for Mutable Objects only.

By default, this key is [].

Show examplesHide examples

In this example, we have configured an allowed key name for entries in a mutable Object Input.

Copied to clipboard
_inputs:
  metadata:
    type: object
    options:
      allow_create: true
      entries:
        allowed_keys:
          - title
{
  "_inputs": {
    "metadata": {
      "type": "object",
      "options": {
        "allow_create": true,
        "entries": {
          "allowed_keys": [
            "title"
          ]
        }
      }
    }
  }
}
assigned_structuresObject<assigned_structures.*>#

This key defines how to assign structures to specific key names for entries in the Object Input.

The value is an object where each property key is an allowed key name, and each property value is an array of structure key name strings. When selecting an entry key name, CloudCannon will prompt team members to choose one of the assigned structures for that allowed key. Structure values are referred to by their id.

Available for Mutable Objects only.

commentstring#

This key defines the subtitle text above the key input when adding or renaming entries within a mutable Object Input.

The value is a string that supports a limited selection of Markdown formatting: links, bold, italic, subscript, superscript, and inline code elements are allowed.

Available for Mutable Objects only.

Show examplesHide examples

In this example, we have configured a comment with Markdown formatting to provide help text above the key input.

Copied to clipboard
_inputs:
  metadata:
    type: object
    options:
      allow_create: true
      entries:
        comment: >-
          Key names should be **lowercase** and use underscores (e.g.,
          `article_title`)
{
  "_inputs": {
    "metadata": {
      "type": "object",
      "options": {
        "allow_create": true,
        "entries": {
          "comment": "Key names should be **lowercase** and use underscores (e.g., `article_title`)"
        }
      }
    }
  }
}
documentationObject#

This key defines the documentation link at the top of a Collection browser.

Collection documentation is useful for assisting your team members.

Show examplesHide examples

In this example, the documentation link for the data Collection goes to CloudCannon Documentation.

Copied to clipboard
collections_config:
  data:
    documentation:
      url: https://cloudcannon.com/documentation/
      text: CloudCannon Documentation
      icon: star
{
  "collections_config": {
    "data": {
      "documentation": {
        "url": "https://cloudcannon.com/documentation/",
        "text": "CloudCannon Documentation",
        "icon": "star"
      }
    }
  }
}
structuresStructure Reference|Structure#

This key defines which predefined templates to use for populating entries nested in the Object Input.

The value can be a string or an object. When configured, team members can select a structure to populate the Object with input/input groups.

If configured as an object, CloudCannon will use the values directly. If configured as a string, CloudCannon will use the matching structures value defined under _structures in the configuration cascade.

Available for Mutable Objects only.

Note: This key looks similar to structures. However, the structures key applies to the Object input itself, while entries.structures applies to the entries within the object.

This key has no default.

Examples:

In this example, we have configured entries options with assigned structures for specific allowed keys.

Copied to clipboard
_inputs:
  metadata:
    type: object
    options:
      allow_create: true
      entries:
        allowed_keys:
          - title
        assigned_structures:
          title:
            - article_metadata
            - page_metadata
{
  "_inputs": {
    "metadata": {
      "type": "object",
      "options": {
        "allow_create": true,
        "entries": {
          "allowed_keys": [
            "title"
          ],
          "assigned_structures": {
            "title": [
              "article_metadata",
              "page_metadata"
            ]
          }
        }
      }
    }
  }
}
Open in a new tab