From 98d64ea05d67f6f6deb8d481512e777e776ad7c9 Mon Sep 17 00:00:00 2001 From: provokateurin Date: Thu, 18 Jan 2024 10:38:37 +0100 Subject: [PATCH 1/2] refactor: Migrate IgnoreOpenAPI attributes to OpenAPI Signed-off-by: provokateurin --- apps/comments/lib/Controller/NotificationsController.php | 4 ++-- apps/dashboard/lib/Controller/DashboardController.php | 4 ++-- apps/dav/lib/Controller/InvitationResponseController.php | 4 ++-- apps/files/lib/Controller/ApiController.php | 4 ++-- apps/files/lib/Controller/DirectEditingViewController.php | 4 ++-- apps/files/lib/Controller/ViewController.php | 4 ++-- apps/files_external/lib/Controller/ApiController.php | 4 ++-- apps/files_sharing/lib/Controller/AcceptController.php | 4 ++-- apps/files_sharing/lib/Controller/ShareController.php | 4 ++-- .../lib/Controller/VerificationController.php | 4 ++-- apps/settings/lib/Controller/AdminSettingsController.php | 4 ++-- apps/settings/lib/Controller/AppSettingsController.php | 4 ++-- apps/settings/lib/Controller/CheckSetupController.php | 4 ++-- apps/settings/lib/Controller/HelpController.php | 4 ++-- .../lib/Controller/PersonalSettingsController.php | 4 ++-- apps/settings/lib/Controller/ReasonsController.php | 4 ++-- apps/settings/lib/Controller/UsersController.php | 4 ++-- apps/settings/lib/Controller/WebAuthnController.php | 4 ++-- core/Controller/CSRFTokenController.php | 4 ++-- core/Controller/ClientFlowLoginController.php | 4 ++-- core/Controller/ClientFlowLoginV2Controller.php | 8 ++++---- core/Controller/CssController.php | 4 ++-- core/Controller/ErrorController.php | 4 ++-- core/Controller/JsController.php | 4 ++-- core/Controller/LoginController.php | 4 ++-- core/Controller/LostController.php | 4 ++-- core/Controller/OCJSController.php | 4 ++-- core/Controller/OCSController.php | 8 ++++---- core/Controller/ProfilePageController.php | 4 ++-- core/Controller/RecommendedAppsController.php | 4 ++-- core/Controller/TwoFactorChallengeController.php | 4 ++-- core/Controller/UnsupportedBrowserController.php | 4 ++-- core/Controller/WalledGardenController.php | 4 ++-- core/Controller/WellKnownController.php | 4 ++-- 34 files changed, 72 insertions(+), 72 deletions(-) diff --git a/apps/comments/lib/Controller/NotificationsController.php b/apps/comments/lib/Controller/NotificationsController.php index cc37dc628be5d..1e1f0e563e228 100644 --- a/apps/comments/lib/Controller/NotificationsController.php +++ b/apps/comments/lib/Controller/NotificationsController.php @@ -26,7 +26,7 @@ use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\RedirectResponse; use OCP\Comments\IComment; @@ -41,7 +41,7 @@ /** * @package OCA\Comments\Controller */ -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class NotificationsController extends Controller { public function __construct( string $appName, diff --git a/apps/dashboard/lib/Controller/DashboardController.php b/apps/dashboard/lib/Controller/DashboardController.php index e7a1a71ccd498..625881b001c09 100644 --- a/apps/dashboard/lib/Controller/DashboardController.php +++ b/apps/dashboard/lib/Controller/DashboardController.php @@ -34,7 +34,7 @@ use OCA\Viewer\Event\LoadViewer; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\AppFramework\Http\TemplateResponse; use OCP\AppFramework\Services\IInitialState; @@ -46,7 +46,7 @@ use OCP\IL10N; use OCP\IRequest; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class DashboardController extends Controller { /** @var IInitialState */ diff --git a/apps/dav/lib/Controller/InvitationResponseController.php b/apps/dav/lib/Controller/InvitationResponseController.php index 69d6bea4e5b63..4a32966220f1f 100644 --- a/apps/dav/lib/Controller/InvitationResponseController.php +++ b/apps/dav/lib/Controller/InvitationResponseController.php @@ -30,7 +30,7 @@ use OCA\DAV\CalDAV\InvitationResponse\InvitationResponseServer; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\TemplateResponse; use OCP\AppFramework\Utility\ITimeFactory; use OCP\IDBConnection; @@ -38,7 +38,7 @@ use Sabre\VObject\ITip\Message; use Sabre\VObject\Reader; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class InvitationResponseController extends Controller { /** @var IDBConnection */ diff --git a/apps/files/lib/Controller/ApiController.php b/apps/files/lib/Controller/ApiController.php index a82fe7078af94..285857c9a198e 100644 --- a/apps/files/lib/Controller/ApiController.php +++ b/apps/files/lib/Controller/ApiController.php @@ -43,7 +43,7 @@ use OCA\Files\Service\ViewConfig; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\ContentSecurityPolicy; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\FileDisplayResponse; @@ -391,7 +391,7 @@ public function getGridView() { * @NoCSRFRequired * @PublicPage */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] public function serviceWorker(): StreamResponse { $response = new StreamResponse(__DIR__ . '/../../../../dist/preview-service-worker.js'); $response->setHeaders([ diff --git a/apps/files/lib/Controller/DirectEditingViewController.php b/apps/files/lib/Controller/DirectEditingViewController.php index b2a9b780b34a1..fcd570b9aacf8 100644 --- a/apps/files/lib/Controller/DirectEditingViewController.php +++ b/apps/files/lib/Controller/DirectEditingViewController.php @@ -24,7 +24,7 @@ use Exception; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\Response; use OCP\DirectEditing\IManager; @@ -33,7 +33,7 @@ use OCP\IRequest; use Psr\Log\LoggerInterface; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class DirectEditingViewController extends Controller { public function __construct( $appName, diff --git a/apps/files/lib/Controller/ViewController.php b/apps/files/lib/Controller/ViewController.php index 8de679f25ddd0..b8090e1cf29a7 100644 --- a/apps/files/lib/Controller/ViewController.php +++ b/apps/files/lib/Controller/ViewController.php @@ -44,7 +44,7 @@ use OCA\Viewer\Event\LoadViewer; use OCP\App\IAppManager; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\ContentSecurityPolicy; use OCP\AppFramework\Http\RedirectResponse; use OCP\AppFramework\Http\Response; @@ -67,7 +67,7 @@ /** * @package OCA\Files\Controller */ -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class ViewController extends Controller { private IURLGenerator $urlGenerator; private IL10N $l10n; diff --git a/apps/files_external/lib/Controller/ApiController.php b/apps/files_external/lib/Controller/ApiController.php index f9fbcdfeca80d..591f73a28d72b 100644 --- a/apps/files_external/lib/Controller/ApiController.php +++ b/apps/files_external/lib/Controller/ApiController.php @@ -34,7 +34,7 @@ use OCA\Files_External\Service\UserGlobalStoragesService; use OCA\Files_External\Service\UserStoragesService; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCSController; use OCP\IRequest; @@ -131,7 +131,7 @@ public function getUserMounts(): DataResponse { * Ask for credentials using a browser's native basic auth prompt * Then returns it if provided */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] public function askNativeAuth(): DataResponse { if (!isset($_SERVER['PHP_AUTH_USER']) || !isset($_SERVER['PHP_AUTH_PW'])) { $response = new DataResponse([], Http::STATUS_UNAUTHORIZED); diff --git a/apps/files_sharing/lib/Controller/AcceptController.php b/apps/files_sharing/lib/Controller/AcceptController.php index 60bdaf519be6c..603f0089ba87d 100644 --- a/apps/files_sharing/lib/Controller/AcceptController.php +++ b/apps/files_sharing/lib/Controller/AcceptController.php @@ -28,7 +28,7 @@ use OCA\Files_Sharing\AppInfo\Application; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\RedirectResponse; use OCP\AppFramework\Http\Response; @@ -38,7 +38,7 @@ use OCP\Share\Exceptions\ShareNotFound; use OCP\Share\IManager as ShareManager; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class AcceptController extends Controller { /** @var ShareManager */ diff --git a/apps/files_sharing/lib/Controller/ShareController.php b/apps/files_sharing/lib/Controller/ShareController.php index 835d08c446ca9..7ee2f35cde880 100644 --- a/apps/files_sharing/lib/Controller/ShareController.php +++ b/apps/files_sharing/lib/Controller/ShareController.php @@ -52,7 +52,7 @@ use OCA\Files_Sharing\Event\ShareLinkAccessedEvent; use OCP\Accounts\IAccountManager; use OCP\AppFramework\AuthPublicShareController; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\TemplateResponse; use OCP\Defaults; @@ -78,7 +78,7 @@ /** * @package OCA\Files_Sharing\Controllers */ -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class ShareController extends AuthPublicShareController { protected ?Share\IShare $share = null; diff --git a/apps/provisioning_api/lib/Controller/VerificationController.php b/apps/provisioning_api/lib/Controller/VerificationController.php index 0b04a0d7218e3..6b2443796fc01 100644 --- a/apps/provisioning_api/lib/Controller/VerificationController.php +++ b/apps/provisioning_api/lib/Controller/VerificationController.php @@ -31,7 +31,7 @@ use OC\Security\Crypto; use OCP\Accounts\IAccountManager; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\TemplateResponse; use OCP\IL10N; use OCP\IRequest; @@ -40,7 +40,7 @@ use OCP\Security\VerificationToken\InvalidTokenException; use OCP\Security\VerificationToken\IVerificationToken; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class VerificationController extends Controller { /** @var IVerificationToken */ diff --git a/apps/settings/lib/Controller/AdminSettingsController.php b/apps/settings/lib/Controller/AdminSettingsController.php index 2e5d2fce953b1..7b0313c9fa72e 100644 --- a/apps/settings/lib/Controller/AdminSettingsController.php +++ b/apps/settings/lib/Controller/AdminSettingsController.php @@ -28,7 +28,7 @@ use OC\AppFramework\Middleware\Security\Exceptions\NotAdminException; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\TemplateResponse; use OCP\Group\ISubAdmin; use OCP\IGroupManager; @@ -39,7 +39,7 @@ use OCP\Settings\IManager as ISettingsManager; use OCP\Template; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class AdminSettingsController extends Controller { use CommonSettingsTrait; diff --git a/apps/settings/lib/Controller/AppSettingsController.php b/apps/settings/lib/Controller/AppSettingsController.php index 77bebbd1becae..1e4387bdcfdf1 100644 --- a/apps/settings/lib/Controller/AppSettingsController.php +++ b/apps/settings/lib/Controller/AppSettingsController.php @@ -43,7 +43,7 @@ use OCP\App\IAppManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\ContentSecurityPolicy; use OCP\AppFramework\Http\JSONResponse; use OCP\AppFramework\Http\TemplateResponse; @@ -55,7 +55,7 @@ use OCP\L10N\IFactory; use Psr\Log\LoggerInterface; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class AppSettingsController extends Controller { /** @var \OCP\IL10N */ diff --git a/apps/settings/lib/Controller/CheckSetupController.php b/apps/settings/lib/Controller/CheckSetupController.php index 8897548a97713..7c304d43be91e 100644 --- a/apps/settings/lib/Controller/CheckSetupController.php +++ b/apps/settings/lib/Controller/CheckSetupController.php @@ -48,7 +48,7 @@ use OC\AppFramework\Http; use OC\IntegrityCheck\Checker; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataDisplayResponse; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\RedirectResponse; @@ -61,7 +61,7 @@ use OCP\SetupCheck\ISetupCheckManager; use Psr\Log\LoggerInterface; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class CheckSetupController extends Controller { /** @var IConfig */ private $config; diff --git a/apps/settings/lib/Controller/HelpController.php b/apps/settings/lib/Controller/HelpController.php index 94de5cd8d9567..1a85830650204 100644 --- a/apps/settings/lib/Controller/HelpController.php +++ b/apps/settings/lib/Controller/HelpController.php @@ -31,7 +31,7 @@ namespace OCA\Settings\Controller; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\ContentSecurityPolicy; use OCP\AppFramework\Http\TemplateResponse; use OCP\IConfig; @@ -41,7 +41,7 @@ use OCP\IRequest; use OCP\IURLGenerator; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class HelpController extends Controller { /** @var INavigationManager */ diff --git a/apps/settings/lib/Controller/PersonalSettingsController.php b/apps/settings/lib/Controller/PersonalSettingsController.php index 09340117610c6..7d219f5c165ac 100644 --- a/apps/settings/lib/Controller/PersonalSettingsController.php +++ b/apps/settings/lib/Controller/PersonalSettingsController.php @@ -27,7 +27,7 @@ namespace OCA\Settings\Controller; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\TemplateResponse; use OCP\Group\ISubAdmin; use OCP\IGroupManager; @@ -37,7 +37,7 @@ use OCP\Settings\IManager as ISettingsManager; use OCP\Template; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class PersonalSettingsController extends Controller { use CommonSettingsTrait; diff --git a/apps/settings/lib/Controller/ReasonsController.php b/apps/settings/lib/Controller/ReasonsController.php index 1ef61d7970fb5..bd2860217ec70 100644 --- a/apps/settings/lib/Controller/ReasonsController.php +++ b/apps/settings/lib/Controller/ReasonsController.php @@ -27,10 +27,10 @@ namespace OCA\Settings\Controller; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataDisplayResponse; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class ReasonsController extends Controller { /** diff --git a/apps/settings/lib/Controller/UsersController.php b/apps/settings/lib/Controller/UsersController.php index a2619b3cc4a0b..3c6ee1806f0db 100644 --- a/apps/settings/lib/Controller/UsersController.php +++ b/apps/settings/lib/Controller/UsersController.php @@ -55,7 +55,7 @@ use OCP\Accounts\PropertyDoesNotExistException; use OCP\App\IAppManager; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\JSONResponse; use OCP\AppFramework\Http\TemplateResponse; @@ -73,7 +73,7 @@ use OCP\Mail\IMailer; use function in_array; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class UsersController extends Controller { /** @var UserManager */ private $userManager; diff --git a/apps/settings/lib/Controller/WebAuthnController.php b/apps/settings/lib/Controller/WebAuthnController.php index 59c4d2146b155..4bc813ffd7e7d 100644 --- a/apps/settings/lib/Controller/WebAuthnController.php +++ b/apps/settings/lib/Controller/WebAuthnController.php @@ -31,7 +31,7 @@ use OCA\Settings\AppInfo\Application; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\IRequest; use OCP\ISession; @@ -39,7 +39,7 @@ use Psr\Log\LoggerInterface; use Webauthn\PublicKeyCredentialCreationOptions; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class WebAuthnController extends Controller { private const WEBAUTHN_REGISTRATION = 'webauthn_registration'; diff --git a/core/Controller/CSRFTokenController.php b/core/Controller/CSRFTokenController.php index fb51744fb7454..046d809702c8e 100644 --- a/core/Controller/CSRFTokenController.php +++ b/core/Controller/CSRFTokenController.php @@ -30,11 +30,11 @@ use OC\Security\CSRF\CsrfTokenManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\IRequest; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class CSRFTokenController extends Controller { public function __construct( string $appName, diff --git a/core/Controller/ClientFlowLoginController.php b/core/Controller/ClientFlowLoginController.php index 40b47a6685dcd..d6e381b36740c 100644 --- a/core/Controller/ClientFlowLoginController.php +++ b/core/Controller/ClientFlowLoginController.php @@ -41,7 +41,7 @@ use OCA\OAuth2\Db\ClientMapper; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Attribute\UseSession; use OCP\AppFramework\Http\Response; use OCP\AppFramework\Http\StandaloneTemplateResponse; @@ -59,7 +59,7 @@ use OCP\Security\ISecureRandom; use OCP\Session\Exceptions\SessionNotAvailableException; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class ClientFlowLoginController extends Controller { public const STATE_NAME = 'client.flow.state.token'; diff --git a/core/Controller/ClientFlowLoginV2Controller.php b/core/Controller/ClientFlowLoginV2Controller.php index b52672a5cccf7..f5bd2d216dde3 100644 --- a/core/Controller/ClientFlowLoginV2Controller.php +++ b/core/Controller/ClientFlowLoginV2Controller.php @@ -33,7 +33,7 @@ use OCA\Core\ResponseDefinitions; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Attribute\UseSession; use OCP\AppFramework\Http\JSONResponse; use OCP\AppFramework\Http\RedirectResponse; @@ -98,7 +98,7 @@ public function poll(string $token): JSONResponse { * @NoCSRFRequired * @PublicPage */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] #[UseSession] public function landing(string $token, $user = ''): Response { if (!$this->loginFlowV2Service->startLoginFlow($token)) { @@ -116,7 +116,7 @@ public function landing(string $token, $user = ''): Response { * @NoCSRFRequired * @PublicPage */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] #[UseSession] public function showAuthPickerPage($user = ''): StandaloneTemplateResponse { try { @@ -150,7 +150,7 @@ public function showAuthPickerPage($user = ''): StandaloneTemplateResponse { * @NoCSRFRequired * @NoSameSiteCookieRequired */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] #[UseSession] public function grantPage(?string $stateToken): StandaloneTemplateResponse { if ($stateToken === null) { diff --git a/core/Controller/CssController.php b/core/Controller/CssController.php index 3406db406532c..6d12309366124 100644 --- a/core/Controller/CssController.php +++ b/core/Controller/CssController.php @@ -34,7 +34,7 @@ use OC\Files\AppData\Factory; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\FileDisplayResponse; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\Response; @@ -45,7 +45,7 @@ use OCP\Files\SimpleFS\ISimpleFolder; use OCP\IRequest; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class CssController extends Controller { protected IAppData $appData; diff --git a/core/Controller/ErrorController.php b/core/Controller/ErrorController.php index 9882b48195142..0bc9e605e13fc 100644 --- a/core/Controller/ErrorController.php +++ b/core/Controller/ErrorController.php @@ -28,10 +28,10 @@ namespace OC\Core\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\TemplateResponse; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class ErrorController extends \OCP\AppFramework\Controller { /** * @PublicPage diff --git a/core/Controller/JsController.php b/core/Controller/JsController.php index e2b432fef5ed2..213231eb85448 100644 --- a/core/Controller/JsController.php +++ b/core/Controller/JsController.php @@ -34,7 +34,7 @@ use OC\Files\AppData\Factory; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\FileDisplayResponse; use OCP\AppFramework\Http\NotFoundResponse; use OCP\AppFramework\Http\Response; @@ -45,7 +45,7 @@ use OCP\Files\SimpleFS\ISimpleFolder; use OCP\IRequest; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class JsController extends Controller { protected IAppData $appData; diff --git a/core/Controller/LoginController.php b/core/Controller/LoginController.php index db3e8a64d64c4..72f69241c9d02 100644 --- a/core/Controller/LoginController.php +++ b/core/Controller/LoginController.php @@ -42,7 +42,7 @@ use OC_App; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Attribute\UseSession; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\RedirectResponse; @@ -60,7 +60,7 @@ use OCP\Security\Bruteforce\IThrottler; use OCP\Util; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class LoginController extends Controller { public const LOGIN_MSG_INVALIDPASSWORD = 'invalidpassword'; public const LOGIN_MSG_USERDISABLED = 'userdisabled'; diff --git a/core/Controller/LostController.php b/core/Controller/LostController.php index 56b8b8eadcb87..d6b13a4cb963a 100644 --- a/core/Controller/LostController.php +++ b/core/Controller/LostController.php @@ -44,7 +44,7 @@ use OC\Security\RateLimiting\Exception\RateLimitExceededException; use OC\Security\RateLimiting\Limiter; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\AppFramework\Http\TemplateResponse; use OCP\AppFramework\Services\IInitialState; @@ -74,7 +74,7 @@ * * @package OC\Core\Controller */ -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class LostController extends Controller { protected string $from; diff --git a/core/Controller/OCJSController.php b/core/Controller/OCJSController.php index 096242b5e9ceb..e909343912574 100644 --- a/core/Controller/OCJSController.php +++ b/core/Controller/OCJSController.php @@ -34,7 +34,7 @@ use OCP\App\IAppManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataDisplayResponse; use OCP\Defaults; use OCP\IConfig; @@ -46,7 +46,7 @@ use OCP\IUserSession; use OCP\L10N\IFactory; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class OCJSController extends Controller { private JSConfigHelper $helper; diff --git a/core/Controller/OCSController.php b/core/Controller/OCSController.php index 3669c006a0b62..ace9875130cf7 100644 --- a/core/Controller/OCSController.php +++ b/core/Controller/OCSController.php @@ -31,7 +31,7 @@ use OC\CapabilitiesManager; use OC\Security\IdentityProof\Manager; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataResponse; use OCP\IRequest; use OCP\IUserManager; @@ -52,7 +52,7 @@ public function __construct( /** * @PublicPage */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] public function getConfig(): DataResponse { $data = [ 'version' => '1.7', @@ -101,7 +101,7 @@ public function getCapabilities(): DataResponse { * @PublicPage * @BruteForceProtection(action=login) */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] public function personCheck(string $login = '', string $password = ''): DataResponse { if ($login !== '' && $password !== '') { if ($this->userManager->checkPassword($login, $password)) { @@ -122,7 +122,7 @@ public function personCheck(string $login = '', string $password = ''): DataResp /** * @PublicPage */ - #[IgnoreOpenAPI] + #[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] public function getIdentityProof(string $cloudId): DataResponse { $userObject = $this->userManager->get($cloudId); diff --git a/core/Controller/ProfilePageController.php b/core/Controller/ProfilePageController.php index 8ea2ad699c1dc..eb5b0aa4c0aee 100644 --- a/core/Controller/ProfilePageController.php +++ b/core/Controller/ProfilePageController.php @@ -29,7 +29,7 @@ use OC\Profile\ProfileManager; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\TemplateResponse; use OCP\AppFramework\Services\IInitialState; use OCP\EventDispatcher\IEventDispatcher; @@ -42,7 +42,7 @@ use OCP\Share\IManager as IShareManager; use OCP\UserStatus\IManager as IUserStatusManager; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class ProfilePageController extends Controller { public function __construct( string $appName, diff --git a/core/Controller/RecommendedAppsController.php b/core/Controller/RecommendedAppsController.php index 5d2c2ba67ced3..59e40f56f730d 100644 --- a/core/Controller/RecommendedAppsController.php +++ b/core/Controller/RecommendedAppsController.php @@ -27,14 +27,14 @@ namespace OC\Core\Controller; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Response; use OCP\AppFramework\Http\StandaloneTemplateResponse; use OCP\IInitialStateService; use OCP\IRequest; use OCP\IURLGenerator; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class RecommendedAppsController extends Controller { public function __construct( IRequest $request, diff --git a/core/Controller/TwoFactorChallengeController.php b/core/Controller/TwoFactorChallengeController.php index 172d0240f20da..bc25121034b9a 100644 --- a/core/Controller/TwoFactorChallengeController.php +++ b/core/Controller/TwoFactorChallengeController.php @@ -29,7 +29,7 @@ use OC\Authentication\TwoFactorAuth\Manager; use OC_User; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Attribute\UseSession; use OCP\AppFramework\Http\RedirectResponse; use OCP\AppFramework\Http\StandaloneTemplateResponse; @@ -43,7 +43,7 @@ use OCP\IUserSession; use Psr\Log\LoggerInterface; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class TwoFactorChallengeController extends Controller { public function __construct( string $appName, diff --git a/core/Controller/UnsupportedBrowserController.php b/core/Controller/UnsupportedBrowserController.php index d736401c218d0..4f096d4409226 100644 --- a/core/Controller/UnsupportedBrowserController.php +++ b/core/Controller/UnsupportedBrowserController.php @@ -28,13 +28,13 @@ namespace OC\Core\Controller; use OCP\AppFramework\Controller; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Response; use OCP\AppFramework\Http\TemplateResponse; use OCP\IRequest; use OCP\Util; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class UnsupportedBrowserController extends Controller { public function __construct(IRequest $request) { parent::__construct('core', $request); diff --git a/core/Controller/WalledGardenController.php b/core/Controller/WalledGardenController.php index b1668bb6d97c5..2ae91135b1dc1 100644 --- a/core/Controller/WalledGardenController.php +++ b/core/Controller/WalledGardenController.php @@ -26,10 +26,10 @@ use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\Response; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class WalledGardenController extends Controller { /** * @PublicPage diff --git a/core/Controller/WellKnownController.php b/core/Controller/WellKnownController.php index a4fd1689cdf9f..896d216308d98 100644 --- a/core/Controller/WellKnownController.php +++ b/core/Controller/WellKnownController.php @@ -29,12 +29,12 @@ use OC\Http\WellKnown\RequestManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; -use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\AppFramework\Http\Response; use OCP\IRequest; -#[IgnoreOpenAPI] +#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)] class WellKnownController extends Controller { public function __construct( IRequest $request, From 651caed6aa4c155f1da9f261c2e5f6e5ebdc48a9 Mon Sep 17 00:00:00 2001 From: provokateurin Date: Thu, 18 Jan 2024 16:23:36 +0100 Subject: [PATCH 2/2] refactor: Configure OpenAPI scopes Signed-off-by: provokateurin --- .../lib/Controller/RequestHandlerController.php | 2 ++ .../lib/Controller/MountPublicLinkController.php | 2 ++ .../lib/Controller/RequestHandlerController.php | 2 ++ apps/federation/lib/Controller/OCSAuthAPIController.php | 2 ++ 4 files changed, 8 insertions(+) diff --git a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php index 0a536aec431c7..0255e011ea4c2 100644 --- a/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php +++ b/apps/cloud_federation_api/lib/Controller/RequestHandlerController.php @@ -30,6 +30,7 @@ use OCA\CloudFederationAPI\ResponseDefinitions; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\Federation\Exceptions\ActionNotSupportedException; use OCP\Federation\Exceptions\AuthenticationFailedException; @@ -55,6 +56,7 @@ * @psalm-import-type CloudFederationAPIValidationError from ResponseDefinitions * @psalm-import-type CloudFederationAPIError from ResponseDefinitions */ +#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)] class RequestHandlerController extends Controller { public function __construct( string $appName, diff --git a/apps/federatedfilesharing/lib/Controller/MountPublicLinkController.php b/apps/federatedfilesharing/lib/Controller/MountPublicLinkController.php index f13a77d936858..a8e6975a49869 100644 --- a/apps/federatedfilesharing/lib/Controller/MountPublicLinkController.php +++ b/apps/federatedfilesharing/lib/Controller/MountPublicLinkController.php @@ -35,6 +35,7 @@ use OCA\FederatedFileSharing\FederatedShareProvider; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\JSONResponse; use OCP\Constants; use OCP\Federation\ICloudIdManager; @@ -55,6 +56,7 @@ * * @package OCA\FederatedFileSharing\Controller */ +#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)] class MountPublicLinkController extends Controller { /** * MountPublicLinkController constructor. diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 5855d98f34edc..d5b931d0b49e6 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -32,6 +32,7 @@ use OCA\FederatedFileSharing\Notifications; use OCP\App\IAppManager; use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\OCS\OCSBadRequestException; use OCP\AppFramework\OCS\OCSException; use OCP\AppFramework\OCSController; @@ -50,6 +51,7 @@ use OCP\Share\Exceptions\ShareNotFound; use Psr\Log\LoggerInterface; +#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)] class RequestHandlerController extends OCSController { /** @var FederatedShareProvider */ diff --git a/apps/federation/lib/Controller/OCSAuthAPIController.php b/apps/federation/lib/Controller/OCSAuthAPIController.php index 8fa33fa48ef8a..82c3e20da3164 100644 --- a/apps/federation/lib/Controller/OCSAuthAPIController.php +++ b/apps/federation/lib/Controller/OCSAuthAPIController.php @@ -31,6 +31,7 @@ use OCA\Federation\DbHandler; use OCA\Federation\TrustedServers; use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\OpenAPI; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCS\OCSForbiddenException; use OCP\AppFramework\OCSController; @@ -47,6 +48,7 @@ * * @package OCA\Federation\Controller */ +#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)] class OCSAuthAPIController extends OCSController { private ISecureRandom $secureRandom; private IJobList $jobList;