ParameterDescription
Definition of a parameter residing in a path, query string, or header, including parameter name, mandatory status, and schema constraints.
{
"allow_empty_value": false,
"deprecated": false,
"name": "string",
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}When false, a parameter present with an empty value (e.g. ?foo=) is treated as a schema violation. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Marks this parameter as deprecated. When a deprecated parameter is received in a request, it is treated as a schema violation and will be learned but not logged. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Name of the parameter. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Marks this parameter as mandatory. A missing parameter is treated as a violation; enforcement depends on the missing-mandatory action configured for its location (query or header). Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Schema specification for scalar types, arrays, or schema references, defining data types and validation constraints for non-object properties.