Duplication of query parameter if it's a reference

[jneidel]

Version

4.28.0

Description

Referencing a parameter defined in components duplicates the parameter in the rendered output.

 * @Nelmio\Operation(
 *     @OA\Parameter(ref="#/components/parameters/limit"),
 *      ...
 *
 * @FOS\RestBundle\Controller\Annotations\QueryParam(name="limit", requirements="[1-9]\d*", description="Limit", default="20", strict=true) 

# config/nelmio_api_doc.yaml
nelmio_api_doc:
    documentation:
        components:
            parameters:
                limit:
                    name: limit
                    in: query
                    example: 20
                    description: "How many entries per page?"
                    schema:
                        type: integer

working alternative

Compared to this case where there is no duplication:

@OA\Parameter(name="limit", in="query", description="How many entries per page?", required=false, @OA\Schema(type="string")),

Additional context

Seems similar to the problems described in #1739 and #1407

The error does not happen on parameters of in: path

[DjordyKoert]

Could you share your openapi docs in json?

[jneidel]

@OA\Parameter(ref="#/components/parameters/pagination--limit"),                                                                           
@OA\Parameter(name="page", in="query", description="Which page?", required=false, @OA\Schema(type="string")),
@OA\Parameter(ref="#/components/parameters/channel-id"),
@OA\Parameter(ref="#/components/parameters/version"),

                "parameters": [
                    {
                        "$ref": "#/components/parameters/pagination--limit"
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "description": "Which page?",
                        "required": true,
                        "allowEmptyValue": false,
                        "schema": {
                            "type": "string",
                            "default": "1",
                            "pattern": "\\d+"
                        }
                    },
                    {
                        "$ref": "#/components/parameters/channel-id"
                    },
                    {
                        "$ref": "#/components/parameters/version"
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "description": "Limit",
                        "required": true,
                        "allowEmptyValue": false,
                        "schema": {
                            "type": "string",
                            "default": "20",
                            "pattern": "\\d+"
                        }
                    }
                ],

[jneidel]

For people with the same problem: our solution was to create a custom attribute:

<?php

namespace App\ApiBundle\Attribute\ApiDocs\Parameter;

use OpenApi\Attributes\Parameter;
use OpenApi\Attributes\Schema;

#[\Attribute(\Attribute::TARGET_CLASS_CONSTANT | \Attribute::TARGET_METHOD)]
final class Limit extends Parameter
{
    public function __construct()
    {
        parent::__construct(
            name: 'limit',
            in: 'query',
            description: 'How many entries to show?',
            required: false,
            schema: new Schema(type: 'integer'),
        );
    }
}