Skip to content

Conversation

dabrokezz
Copy link

@dabrokezz dabrokezz commented Mar 18, 2025

Hi,

Here are some helper functions for Scramble documentation. I'm not sure if they're usable or interesting, but I use them for my documentation.

adding a description for handlers
image

and extraHEaders parameters

image
image
image

class CreateHandler extends Handlers
{

    public static ?string $description = "This endpoint expects a JSON containing the order metadata and the list of order_items.
";

    public static ?array $extraHeaders = [
        "Client-Id" => [
            'sample' => '123456789',
            'required' => true,
            'description' => 'Identifiant unique du client',
        ]
    ];
    }

Thanks for your amazing and simple to use api pluging for filament

@rupadana
Copy link
Owner

i think we need command to publish handler stub, so every one can modify its self.

@dabrokezz
Copy link
Author

i think we need command to publish handler stub, so every one can modify its self.

Oki :)
And sorry for this pull request... i was missing the
use Dedoc\Scramble\Attributes\QueryParameter;
use Dedoc\Scramble\Attributes\HeaderParameter;
etc...

@dabrokezz
Copy link
Author

not needed

@dabrokezz dabrokezz closed this Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants