ApiPlatform\Core\Api\FilterInterface::getDescription PHP Method

getDescription() public method

Returns an array with the filter parameter names as keys and array with the following data as values: - property: the property where the filter is applied - type: the type of the filter - required: if this filter is required - strategy: the used strategy - swagger (optional): additional parameters for the path operation, e.g. 'swagger' => ['description' => 'My Description'] The description can contain additional data specific to a filter.
public getDescription ( string $resourceClass ) : array
$resourceClass string
return array
    public function getDescription(string $resourceClass) : array;
FilterInterface