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

Developer ReferenceConfiguration File

models

Table of contents

Description:

This key defines the models for each key in key-value list parser configurations.

The value is an object where each property key is a key name and each property value is a model configuration object. These models define how each key-value pair is parsed and validated.

Appears in:
└── Snippet
    └── params
        └── *
            └── Key Value List Parser Configuration
                └── options
                    └── models
Type:
Array<Snippet Model> Required
Items:
snippet-modelObject#

This key defines the parsing configuration for this argument.

Examples:

In this example, we have configured models for key-value pairs in a key-value list parser.

Copied to clipboard
_snippets:
  example:
    snippet: <<example key1=value1 key2=value2>>
    params:
      params:
        parser: key_values
        options:
          models:
            key1:
              editor_key: value1_input
            key2:
              editor_key: value2_input
{
  "_snippets": {
    "example": {
      "snippet": "<<example key1=value1 key2=value2>>",
      "params": {
        "params": {
          "parser": "key_values",
          "options": {
            "models": {
              "key1": {
                "editor_key": "value1_input"
              },
              "key2": {
                "editor_key": "value2_input"
              }
            }
          }
        }
      }
    }
  }
}
Open in a new tab