ParamDefinition

A param you write. An array declares its element under item, an object its fields, and a one_of the ways it may be written under one_of.

read_when is a condition on another param. While it does not hold, this param is ignored: not its rules, not even being required. A block often keeps a value it no longer reads, and this is how you tell that apart from a value that is wrong.

  • fields
    Type: array of ParamDefinition
    required

    The params an object param is made of. Empty on a param that is not an object.

    Properties: 12
  • has_default
    Type: boolean
    required

    Whether a value is applied when the param is absent. It answers what default alone cannot: a param whose default is null, 0 or an empty list is not a param without one.

  • name
    Type: string
    required
  • one_of
    Type: array of ParamDefinition
    required

    The shapes this value may take, when it may take more than one — a condition that is either an object or a bare string, say. Each is a param in its own right.

    A value matching none of them is refused with param_no_matching_shape. Empty unless type is one_of.

    Properties: 12
  • read_when
    Type: array of ParamSelector
    required

    The conditions under which the param is read, written in the same vocabulary as a variant's selector and evaluated the same way. Every one of them has to hold. Empty on a param that is always read, which is most of them.

    Properties: 5
  • required
    Type: boolean
    required
  • rules
    Type: array of ParamRule
    required

    Constraints beyond the type. Only rules that can be stated declaratively appear here; rules that depend on the brand's own data, such as whether an integration credential belongs to it, are enforced on write and reported as violations.

    Properties: 2
  • type
    Type: ParamTypeenum
    required

    The kind of value a param takes. one_of is the one that is not a shape of its own: it says the value may be written in more than one way, and the ways are under one_of.

    values
    stringintegernumberbooleanarrayobjectone_of
  • default

    The value used when the block is placed and the param is not given. Absent when has_default is false.

  • description
    Type: string
  • item
    Type: ParamElement

    What one element of an array param is. Present only on an array param.

    Properties: 5
  • title
    Type: string