App\InfoController

Complexity

Total Complexity

2

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	index()	0	3	1
A	__construct()	0	2	1

<?php

declare(strict_types=1);

namespace App;

use Psr\Http\Message\ResponseInterface;
use Yiisoft\DataResponse\DataResponseFactoryInterface;
use OpenApi\Annotations as OA;

/**
 * @OA\Info(title="Yii API application", version="1.0")
 */
class InfoController
{
    public function __construct(private VersionProvider $versionProvider)
    {
    }

    /**
     * @OA\Get(
     *     path="/",
     *     summary="Returns info about the API",
     *     description="",
     *     @OA\Response(
     *          response="200",
     *          description="Success",
     *          @OA\JsonContent(
     *              allOf={
     *                  @OA\Schema(ref="#/components/schemas/Response"),
     *                  @OA\Schema(
     *                      @OA\Property(
     *                          property="data",
     *                          type="object",
     *                          @OA\Property(
     *                              property="version",
     *                              type="string",
     *                              example="3.0"
     *                          ),
     *                          @OA\Property(
     *                              property="author",
     *                              type="string",
     *                              example="yiisoft"
     *                          ),
     *                      ),
     *                  ),
     *              },
     *          )
     *    ),
     * )
     */
    public function index(DataResponseFactoryInterface $responseFactory): ResponseInterface
    {
        return $responseFactory->createResponse(['version' => $this->versionProvider->version, 'author' => 'yiisoft']);
    }
}