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

Developer ReferenceConfiguration File

comment

Table of contents

Description:

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.

Appears in:
└── _inputs
    └── *
        └── Object Input
            └── options
                └── entries
                    └── comment
Type:
string
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`)"
        }
      }
    }
  }
}
Open in a new tab