Tags description

[Shadercloud]

I notice that the Group tag allows for a description but this doesn't actually go anywhere. For example:

#[Group(name: 'Chat / Messages', description: 'The chat API allows you to send and receive chat messages between yourself and other users/shops.')]

It seems in the OpenAPI specs this should be appended to the JSON array as such:

    "tags": [
        {
            "name": "Chat \/ Messages",
            "description": "The chat API allows you to send and receive chat messages between yourself and other users\/shops."
        }
    ]

However the Dedoc\Scramble\Support\Generator\OpenAPI class does not allow for appending any attribrary fields to the document. Even with DocumentTransformers which only allows you to modify the existing fields in the OpenAPI class; but toArray() does not allow for appending anything else.

So I'm not sure how one would go about appending to this data, right now I've just added a middleware which does this:

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

class OpenApiTags
{
    /**
     * Handle an incoming request.
     *
     * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        $response = $next($request);
        if ($request->getRequestUri() === '/docs/api.json') {
            $content = json_decode($response->getContent());
            $content->tags = [
                [
                    'name'        => 'Chat / Messages',
                    'description' => 'The chat API allows you to send and receive chat messages between yourself and other users/shops.'
                ]
            ];
            $prettyContent = json_encode($content, JSON_PRETTY_PRINT);

            // Update the response content with the pretty-printed JSON
            $response->setContent($prettyContent);
        };
        return $response;
    }
}

However this means manually adding the descriptions to the middleware, or making a whole system to re-scan the tags again. Any suggestions to a better way to handle this?

[romalytvynenko]

This is indeed a good catch and should work like you expected.

Thanks for a good testing and a feedback! Currently I'm working on that issue you've highlighted (about path params) and will handle this after.