Param

class Param

Properties

description

what the parameter means, and any constraints worth stating in prose

public readonly string $description

Type: string

enum

restricts the value to a fixed set

public readonly array $enum

Type: array

minimum

inclusive lower bound for numeric parameters

public readonly null|float|int $minimum

Type: null|float|int

maximum

inclusive upper bound for numeric parameters

public readonly null|float|int $maximum

Type: null|float|int

format

a JSON Schema format annotation, e.g. date-time or email

public readonly string $format

Type: string

items

schema for elements of an array parameter

public readonly array $items

Type: array

schema

replaces the generated schema entirely, for shapes reflection cannot express

public readonly array $schema

Type: array

Methods

__construct

public __construct(string $description, array $enum, null|float|int $minimum, null|float|int $maximum, string $format, array $items, array $schema): void

Parameters

Parameter	Type	Description
$description	string	what the parameter means, and any constraints worth stating in prose
$enum	array	restricts the value to a fixed set
$minimum	null	float
$maximum	null	float
$format	string	a JSON Schema format annotation, e.g. date-time or email
$items	array	schema for elements of an array parameter
$schema	array	replaces the generated schema entirely, for shapes reflection cannot express

---

Generated by Hazaar API Doc Generator on Sun, 23 Aug 2026 10:49:44 +0000