Custom rule

[fixytech]

hello good! I have a custom rule and I can't find a way to document it, I leave an example:

SetAvatarRequest.php

public function rules(): array
{

    return [

        'avatar' => [
            'required',
            'string',
            new Base64ImageSizeRule()
        ]
    ];
}

Thank you so much!

[romalytvynenko]

@fixytech hey!

You can implement method docs on your rule class:

use Dedoc\Scramble\Support\Generator\Types\Type as OpenApiType;

public function docs(OpenApiType $prevType, TypeTransformer $openApiTransformer): OpenApiType;

For example:

use Dedoc\Scramble\Support\Generator\Types\Type as OpenApiType; 
use Dedoc\Scramble\Support\Generator\Types\StringType; 

public function docs(OpenApiType $prevType, TypeTransformer $openApiTransformer): OpenApiType
{
    return (new StringType)->format('password');
} 

This is not documented feature as in the near future I plan to change namespaces and potentially the API for this feature.

But for now it should do the work.