add header for all routes

[sajadshouli]

how can I add some headers for all routes like these headers
Accept-language
timezone

[romalytvynenko]

@sajadshouli Using operation extensions, you can add header params to all of your routes (operations).

[sajadshouli]

I read the extension docs but can you give me an example to how add a header to all routes

[romalytvynenko]

@sajadshouli you can follow this example, but add a header instead: https://helgesver.re/articles/operationid-support-scramble-openapi

[romalytvynenko]

@sajadshouli and inside the extension you simply write:

$operation->addParameters([
            Parameter::make('Accept-language', 'header'),
            Parameter::make('timezone', 'header'),
        ]);

[sajadshouli]

thank you @romalytvynenko

I write this extension

namespace App\Extensions;

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

class AddHeadersToDocsForAdmin extends OperationExtension
{
    public function handle(Operation $operation, RouteInfo $routeInfo)
    {
        $operation->addParameters([
            Parameter::make('Accept-language', 'fa'),
            Parameter::make('timezone', 'Asia/Tehran'),
        ]);
    }
}

and add it to config

but nothing happened in the document

[romalytvynenko]

The second parameter you pass to Parameter::make MUST be header. If you want to add an example, you can use something like this:

Parameter::make('Accept-language', 'header')
    ->example('fa')

[sajadshouli]

is there a function to set a default value directly? the example is good but is some cases I want to make sure the request has a specific header with a specific value

[romalytvynenko]

@sajadshouli #490 (comment)

[romalytvynenko]

@sajadshouli
Try this one

use Dedoc\Scramble\Support\Generator\Parameter;
use Dedoc\Scramble\Support\Generator\Schema;
use Dedoc\Scramble\Support\Generator\Types\StringType;

// ...

Parameter::make('Accept-language', 'header')
    ->example('fa')
    ->setSchema(Schema::fromType(
        (new StringType)->default('fa'),
    ));