Skip to content

Commit

Permalink
Flag endpoints missing API docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
BusterNeece committed Mar 4, 2025
1 parent bb5e7fc commit e6fad6f
Show file tree
Hide file tree
Showing 113 changed files with 490 additions and 59 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\Utilities\File;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class CertificateLogAction implements SingleActionInterface
{
use HasLogViewer;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\Messenger\MessageBus;

/*
* TODO API
*/
final class GenerateCertificateAction implements SingleActionInterface
{
public function __construct(
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/AuditLogAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Backups/DeleteAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
use App\Http\ServerRequest;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class DeleteAction extends AbstractFileAction
{
public function __invoke(
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Backups/DownloadAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
use App\Http\ServerRequest;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class DownloadAction extends AbstractFileAction
{
public function __invoke(
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Backups/GetAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
use League\Flysystem\StorageAttributes;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class GetAction implements SingleActionInterface
{
public function __construct(
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Backups/GetLogAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\Utilities\File;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class GetLogAction implements SingleActionInterface
{
use HasLogViewer;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Backups/RunAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\Messenger\MessageBus;

/*
* TODO API
*/
final class RunAction implements SingleActionInterface
{
public function __construct(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ enum: AssetTypes::class
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ enum: AssetTypes::class
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/ClearCacheAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\Http\ServerRequest;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ClearCacheAction implements SingleActionInterface
{
public function __construct(
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/ClearQueueAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
use App\MessageQueue\QueueNames;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ClearQueueAction implements SingleActionInterface
{
public function __construct(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
use Monolog\Level;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ClearStationQueueAction implements SingleActionInterface
{
use LoggerAwareTrait;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/ListQueuesAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\MessageQueue\QueueNames;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ListQueuesAction implements SingleActionInterface
{
public function __construct(
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/ListStationsAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
use App\Http\ServerRequest;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ListStationsAction implements SingleActionInterface
{
public function __construct(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ListSyncTasksAction implements SingleActionInterface
{
use EnvironmentAwareTrait;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/NextSongAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
use Monolog\Level;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class NextSongAction implements SingleActionInterface
{
use LoggerAwareTrait;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/NowPlayingAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
use Monolog\Level;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class NowPlayingAction implements SingleActionInterface
{
use LoggerAwareTrait;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/SyncAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class SyncAction implements SingleActionInterface
{
use LoggerAwareTrait;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Debug/TelnetAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
use Monolog\Level;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class TelnetAction implements SingleActionInterface
{
use LoggerAwareTrait;
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/PermissionsAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/RelaysAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/Rsas/GetAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/Rsas/PostAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/SendTestMessageAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
use Symfony\Component\Validator\Constraints\Required;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/*
* TODO API
*/
final class SendTestMessageAction implements SingleActionInterface
{
public function __construct(
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/ServerStatsAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
content: new OA\JsonContent(ref: ApiServerStats::class)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/ServiceControlController.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\Service\ServiceControl;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class ServiceControlController
{
public function __construct(
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/Shoutcast/GetAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/Shoutcast/PostAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Stations/CloneAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
use Psr\Http\Message\ResponseInterface;
use Throwable;

/*
* TODO API
*/
final class CloneAction extends StationsController implements SingleActionInterface
{
use EnvironmentAwareTrait;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\Http\ServerRequest;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class StorageLocationsAction extends StationsController implements SingleActionInterface
{
public function __invoke(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/StereoTool/GetAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
)
),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
1 change: 0 additions & 1 deletion backend/src/Controller/Api/Admin/StereoTool/PostAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)]
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Updates/GetUpdatesAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
use Psr\Http\Message\ResponseInterface;
use RuntimeException;

/*
* TODO API
*/
final class GetUpdatesAction implements SingleActionInterface
{
use SettingsAwareTrait;
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Admin/Updates/PutUpdatesAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
use App\Service\WebUpdater;
use Psr\Http\Message\ResponseInterface;

/*
* TODO API
*/
final class PutUpdatesAction implements SingleActionInterface
{
public function __construct(
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Frontend/Account/GetMeAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/*
* TODO API
*/
final class GetMeAction extends UsersController implements SingleActionInterface
{
use EntityManagerAwareTrait;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
/**
* @template TEntity as UserPasskey
* @extends AbstractApiCrudController<TEntity>
*
* TODO API
*/
final class PasskeysController extends AbstractApiCrudController
{
Expand Down
3 changes: 3 additions & 0 deletions backend/src/Controller/Api/Frontend/Account/PutMeAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;

/*
* TODO API
*/
final class PutMeAction extends UsersController implements SingleActionInterface
{
public function __invoke(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
responses: [
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
]
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
use Psr\Http\Message\ResponseInterface;
use Throwable;

/*
* TODO API
*/
final class PutTwoFactorAction implements SingleActionInterface
{
use EntityManagerAwareTrait;
Expand Down
Loading

0 comments on commit e6fad6f

Please sign in to comment.