Custom Headers

[masitings]

Hi there,

I want to ask, is there a way for me to put custom header in security in AppServiceProvider ? Currently, im using 2 layer of Auth, First one is using Sanctum and second was using App auth. So, i want to put the custom headers somewhere near the Token authenticated. Is it possible ?

[mojtabasoori]

hi,

i add custom header with extension.

use Dedoc\Scramble\Support\RouteInfo;
use Dedoc\Scramble\Support\Generator\Schema;
use Dedoc\Scramble\Support\Generator\Operation;
use Dedoc\Scramble\Support\Generator\Parameter;
use Dedoc\Scramble\Extensions\OperationExtension;
use Dedoc\Scramble\Support\Generator\Types\StringType;

class AddCustomHeader  extends OperationExtension
{
    public function handle(Operation $operation, RouteInfo $routeInfo)
    {
        $operation->addParameters([
            Parameter::make('X-custom-id', 'header')
                ->setSchema(
                    Schema::fromType(new StringType())
                )
                ->required(true)
                ->example("925fdfe2-745c-45d4-aaaf-40f3455c0510")
        ]);
    }
}

[masitings]

@mojtabasoori Its worked! Thanks. For those of you who want to add the same thing, you need to add this as extensions in scramble.php config files.

[romalytvynenko]

@hondamitrajayarayi no, it should've worked. I have no idea why it doesn't. Feel free to create a repro repository so I can help. Otherwise I cannot

[romalytvynenko]

@hondamitrajayarayi try it without call to example method. If it doesn't help, I'd need repro repository.

[hondamitrajayarayi]

I've tried without the example method but it still doesn't work.

here's the repository
https://github.com/hondamitrajayarayi/scrumble-api-docs

[romalytvynenko]

@hondamitrajayarayi notice you place the extension class in Exceptions folder, but you import the file from Extensions folder...

[hondamitrajayarayi]

@romalytvynenko thank you very much, I was not careful enough