Skip to main content


A parameter that can be set and used in evaluated code.

This schema type is marked as experimental 🧪 and is subject to change.


Name@idTypeDescriptionInherited from
nameschema:namestringThe name of the variable. See note 1.Variable
defaultschema:defaultValueNodeThe default value of the parameter.Parameter
idschema:idstringThe identifier for this item.Entity
isExtensiblestencila:isExtensiblebooleanIndicates that this parameter is variadic and can accept multiple named arguments.Parameter
isReadonlyschema:readonlyValuebooleanWhether or not a property is mutable. Default is false. See note 2.Variable
isRequiredschema:valueRequiredbooleanIs this parameter required, if not it should have a default or default is assumed to be null.Parameter
isVariadicstencila:isVariadicbooleanIndicates that this parameter is variadic and can accept multiple arguments.Parameter
metastencila:metaobjectMetadata associated with this item.Entity
validatorstencila:validatorValidatorTypesThe validator that the value is validated against.Variable
valueschema:valueNodeThe value of the variable.Variable


  1. name : !array('This regex allows for snake_case and camelCase names but excludes PascalCase for names.')
  2. isReadonly : !array('If ')isReadonly!array(' is ')true!array(' and ')value!array(' is defined then changes to ')value!array(' should not be allowed.')


Available as#


This documentation was generated from Parameter.schema.yaml.