[BUG] [PHP] php-ze-ph generated operation cannot access description

[agrizzli]

Bug Report Checklist

• [x] Have you provided a full/minimal spec to reproduce the issue?
• [x] Have you validated the input using an OpenAPI validator (example)?
• [x] What's the version of OpenAPI Generator used?
• [x] Have you search for related issues/PRs?
• [x] What's the actual output vs expected output?

Description

php-ze-ph module templates use {{description}} variable in api.mustache to provide description for each operation. However this description won't be available in template, since guard {{#description}} does not twig:

{{#description}}
     * {{description}}
{{/description}}

openapi-generator version

4.0.0

OpenAPI declaration file content or url

openapi: 3.0.0
info:
    description: 'Test description'
    version: 1.0.0
    title: 'Test'
paths:
    /example_item:
        post:
            tags:
                - ExampleItem
            operationId: addExampleItem
            summary: 'Add new example item'
            description: 'Adds example item to the system'
            requestBody:
              description: 'Example item to add'
              content:
                  application/json:
                      schema:
                          $ref: '#/components/schemas/ExampleItem'

            responses:
                201:
                    description: 'Item created'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ExampleItem'
components:
  schemas:
    ExampleItem:
        type: object
        required:
            - example_string
        properties:
            id:
                type: integer
                readOnly: true
                example: 1
            example_string:
                type: string
                maxLength: 6
                pattern: '[0-9]{4,6}'
                example: 'Some string contents'

Command line used for generation

npx openapi-generator generate -Dapis='/example_item' -i spec/openapi/api-v1.yml -g php-ze-ph -o .

Steps to reproduce

• Create /example_item path operation with a summary and description
• Run above command line
• Open src/App/Handler/ExampleItem.php file
• You will see pasted summary but not description in generated PHP code. Below Add new example item should be Adds example item to the system

/**
 * @PHA\Route(pattern="/example_item")
 */
class ExampleItem
{
    /**
     * Add new example item
     * @PHA\Post()
     * TODO check if consumer is valid, if it has correct priority and if it can be moved to class annotation
     * @PHA\Consumer(name=PHConsumer\Json::class, mediaType="application/json")
     * @PHA\Attribute(name=PHAttribute\Transfer::class, options={"type":\App\DTO\ExampleItem::class,"objectAttr":"bodyData"})
     * TODO check if producer is valid, if it has correct priority and if it can be moved to class annotation
     * @PHA\Producer(name=PHProducer\Transfer::class, mediaType="application/json")
     * @param ServerRequestInterface $request
     *
     * @throws PHException\HttpCode 501 if the method is not implemented
     *
     * @return \App\DTO\ExampleItem
     */
    public function addExampleItem(ServerRequestInterface $request): \App\DTO\ExampleItem
    {
        //TODO implement method
        /** @var \App\DTO\ExampleItem $bodyData */
        $bodyData = $request->getAttribute("bodyData");
        throw new PHException\HttpCode(501, "Not implemented");
    }

Related issues/PRs

Suggest a fix

[auto-labeler[bot]]

👍 Thanks for opening this issue! 🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[jbtrystram]

I am seeing the same issue on the asciidoc generator. The description isn't accessible from each operation and endpoint context. The field is properly parsed because adding {{this}} outside of the {{#apiInfo}} loop does outputs the description field in the path objects.