AzuraCast/src/Controller/Api/IndexController.php

55 lines
1.4 KiB
PHP

<?php
declare(strict_types=1);
namespace App\Controller\Api;
use App\Entity;
use App\Http\Response;
use App\Http\ServerRequest;
use OpenApi\Attributes as OA;
use Psr\Http\Message\ResponseInterface;
final class IndexController
{
#[OA\Get(
path: '/status',
description: 'Returns an affirmative response if the API is active.',
tags: ['Miscellaneous'],
parameters: [],
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: '#/components/schemas/Api_SystemStatus')
),
]
)]
public function statusAction(
ServerRequest $request,
Response $response
): ResponseInterface {
return $response->withJson(new Entity\Api\SystemStatus());
}
#[OA\Get(
path: '/time',
description: "Returns the time (with formatting) in GMT and the user's local time zone, if logged in.",
tags: ['Miscellaneous'],
parameters: [],
responses: [
new OA\Response(
response: 200,
description: 'Success',
content: new OA\JsonContent(ref: '#/components/schemas/Api_Time')
),
]
)]
public function timeAction(
ServerRequest $request,
Response $response
): ResponseInterface {
return $response->withJson(new Entity\Api\Time());
}
}