diff --git a/TwoFactorAuth/Api/AdminTokenServiceInterface.php b/TwoFactorAuth/Api/AdminTokenServiceInterface.php index 5482feba..a8c3e13f 100644 --- a/TwoFactorAuth/Api/AdminTokenServiceInterface.php +++ b/TwoFactorAuth/Api/AdminTokenServiceInterface.php @@ -12,6 +12,7 @@ /** * Obtain basic information about the user required to setup or use 2fa + * @api */ interface AdminTokenServiceInterface extends OriginalTokenServiceInterface { diff --git a/TwoFactorAuth/Api/AuthyAuthenticateInterface.php b/TwoFactorAuth/Api/AuthyAuthenticateInterface.php index f56a1afc..1c7c5a11 100644 --- a/TwoFactorAuth/Api/AuthyAuthenticateInterface.php +++ b/TwoFactorAuth/Api/AuthyAuthenticateInterface.php @@ -10,6 +10,7 @@ /** * Represents the authy provider authentication + * @api */ interface AuthyAuthenticateInterface { diff --git a/TwoFactorAuth/Api/AuthyConfigureInterface.php b/TwoFactorAuth/Api/AuthyConfigureInterface.php index caea7a00..6e692caa 100644 --- a/TwoFactorAuth/Api/AuthyConfigureInterface.php +++ b/TwoFactorAuth/Api/AuthyConfigureInterface.php @@ -13,6 +13,7 @@ /** * Represents the authy provider + * @api */ interface AuthyConfigureInterface { @@ -21,7 +22,7 @@ interface AuthyConfigureInterface * * @param string $tfaToken * @param AuthyDeviceInterface $deviceData - * @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface + * @return ResponseInterface */ public function sendDeviceRegistrationPrompt( string $tfaToken, diff --git a/TwoFactorAuth/Api/CountryRepositoryInterface.php b/TwoFactorAuth/Api/CountryRepositoryInterface.php index a014c581..da7681d1 100644 --- a/TwoFactorAuth/Api/CountryRepositoryInterface.php +++ b/TwoFactorAuth/Api/CountryRepositoryInterface.php @@ -14,7 +14,7 @@ /** * Countries repository - * + * @api * @SuppressWarnings(PHPMD.ShortVariable) */ interface CountryRepositoryInterface diff --git a/TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php b/TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php index 3abc222d..c4efe82a 100644 --- a/TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php +++ b/TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php @@ -9,9 +9,11 @@ namespace Magento\TwoFactorAuth\Api\Data; use Magento\Framework\Api\ExtensibleDataInterface; +use Magento\TwoFactorAuth\Api\ProviderInterface; /** * Represents the response to the new admin token response + * @api */ interface AdminTokenResponseInterface extends ExtensibleDataInterface { @@ -63,14 +65,14 @@ public function setMessage(string $value): void; /** * Get the providers * - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getActiveProviders(): array; /** * Set the providers * - * @param \Magento\TwoFactorAuth\Api\ProviderInterface[] $value + * @param ProviderInterface[] $value * @return void */ public function setActiveProviders(array $value): void; @@ -80,14 +82,14 @@ public function setActiveProviders(array $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface|null + * @return AdminTokenResponseExtensionInterface|null */ public function getExtensionAttributes(): ?AdminTokenResponseExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface $extensionAttributes + * @param AdminTokenResponseExtensionInterface $extensionAttributes * @return void */ public function setExtensionAttributes( diff --git a/TwoFactorAuth/Api/Data/AuthyDeviceInterface.php b/TwoFactorAuth/Api/Data/AuthyDeviceInterface.php index dac2df2a..fc5b8e3d 100644 --- a/TwoFactorAuth/Api/Data/AuthyDeviceInterface.php +++ b/TwoFactorAuth/Api/Data/AuthyDeviceInterface.php @@ -11,6 +11,7 @@ /** * Authy device data interface + * @api */ interface AuthyDeviceInterface extends ExtensibleDataInterface { @@ -89,14 +90,14 @@ public function setMethod(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface|null + * @return AuthyDeviceExtensionInterface|null */ public function getExtensionAttributes(): ?AuthyDeviceExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface $extensionAttributes + * @param AuthyDeviceExtensionInterface $extensionAttributes * @return void */ public function setExtensionAttributes( diff --git a/TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php b/TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php index 439ca5f8..1fd8b2f4 100644 --- a/TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php +++ b/TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php @@ -12,6 +12,7 @@ /** * Response for device registration prompt + * @api */ interface AuthyRegistrationPromptResponseInterface extends ExtensibleDataInterface { @@ -60,14 +61,14 @@ public function setExpirationSeconds(int $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseExtensionInterface|null + * @return AuthyRegistrationPromptResponseExtensionInterface|null */ public function getExtensionAttributes(): ?AuthyRegistrationPromptResponseExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseExtensionInterface $extensionAttributes + * @param AuthyRegistrationPromptResponseExtensionInterface $extensionAttributes * @return void */ public function setExtensionAttributes( diff --git a/TwoFactorAuth/Api/Data/CountryInterface.php b/TwoFactorAuth/Api/Data/CountryInterface.php index b423a851..f277372f 100644 --- a/TwoFactorAuth/Api/Data/CountryInterface.php +++ b/TwoFactorAuth/Api/Data/CountryInterface.php @@ -11,6 +11,7 @@ /** * Country entity interface + * @api */ interface CountryInterface extends ExtensibleDataInterface { @@ -95,14 +96,14 @@ public function setDialCode(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface|null + * @return CountryExtensionInterface|null */ public function getExtensionAttributes(): ?CountryExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface $extensionAttributes + * @param CountryExtensionInterface $extensionAttributes */ public function setExtensionAttributes( CountryExtensionInterface $extensionAttributes diff --git a/TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php b/TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php index 70ab6b02..8d733150 100644 --- a/TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php +++ b/TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php @@ -11,6 +11,7 @@ /** * Represent country search results + * @api */ interface CountrySearchResultsInterface extends SearchResultsInterface { diff --git a/TwoFactorAuth/Api/Data/DuoDataInterface.php b/TwoFactorAuth/Api/Data/DuoDataInterface.php index 2c94c163..0e14ea8c 100644 --- a/TwoFactorAuth/Api/Data/DuoDataInterface.php +++ b/TwoFactorAuth/Api/Data/DuoDataInterface.php @@ -11,6 +11,7 @@ /** * Represents the data needed to use duo + * @api */ interface DuoDataInterface extends ExtensibleDataInterface { @@ -59,14 +60,14 @@ public function setApiHostname(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\DuoDataExtensionInterface|null + * @return DuoDataExtensionInterface|null */ public function getExtensionAttributes(): ?DuoDataExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\DuoDataExtensionInterface $extensionAttributes + * @param DuoDataExtensionInterface $extensionAttributes * @return void */ public function setExtensionAttributes( diff --git a/TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php b/TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php index 93cbece1..8460d2bb 100644 --- a/TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php +++ b/TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php @@ -12,6 +12,7 @@ /** * Represents the Google authentication data + * @api */ interface GoogleAuthenticateInterface extends ExtensibleDataInterface { @@ -37,14 +38,14 @@ public function setOtp(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\GoogleAuthenticateExtensionInterface|null + * @return GoogleAuthenticateExtensionInterface|null */ public function getExtensionAttributes(): ?GoogleAuthenticateExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\GoogleAuthenticateExtensionInterface $extensionAttributes + * @param GoogleAuthenticateExtensionInterface $extensionAttributes */ public function setExtensionAttributes( GoogleAuthenticateExtensionInterface $extensionAttributes diff --git a/TwoFactorAuth/Api/Data/GoogleConfigureInterface.php b/TwoFactorAuth/Api/Data/GoogleConfigureInterface.php index a50f04fe..c0e61a59 100644 --- a/TwoFactorAuth/Api/Data/GoogleConfigureInterface.php +++ b/TwoFactorAuth/Api/Data/GoogleConfigureInterface.php @@ -11,6 +11,7 @@ /** * Google configuration data interface + * @api */ interface GoogleConfigureInterface extends ExtensibleDataInterface { @@ -59,14 +60,14 @@ public function setSecretCode(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\GoogleConfigureExtensionInterface|null + * @return GoogleConfigureExtensionInterface|null */ public function getExtensionAttributes(): ?GoogleConfigureExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\GoogleConfigureExtensionInterface $extensionAttributes + * @param GoogleConfigureExtensionInterface $extensionAttributes * @return void */ public function setExtensionAttributes( diff --git a/TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php b/TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php index eedc296c..b84aa988 100644 --- a/TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php +++ b/TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php @@ -12,6 +12,7 @@ /** * Represents a WebAuthn dataset + * @api */ interface U2fWebAuthnRequestInterface extends ExtensibleDataInterface { @@ -37,14 +38,14 @@ public function setCredentialRequestOptionsJson(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestExtensionInterface|null + * @return U2fWebAuthnRequestExtensionInterface|null */ public function getExtensionAttributes(): ?U2fWebAuthnRequestExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestExtensionInterface $extensionAttributes + * @param U2fWebAuthnRequestExtensionInterface $extensionAttributes * @return void */ public function setExtensionAttributes( diff --git a/TwoFactorAuth/Api/Data/UserConfigInterface.php b/TwoFactorAuth/Api/Data/UserConfigInterface.php index 34442f74..621a845f 100644 --- a/TwoFactorAuth/Api/Data/UserConfigInterface.php +++ b/TwoFactorAuth/Api/Data/UserConfigInterface.php @@ -11,6 +11,7 @@ /** * User configuration interface + * @api */ interface UserConfigInterface extends ExtensibleDataInterface { @@ -95,14 +96,14 @@ public function setDefaultProvider(string $value): void; * * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation * - * @return \Magento\TwoFactorAuth\Api\Data\UserConfigExtensionInterface|null + * @return UserConfigExtensionInterface|null */ public function getExtensionAttributes(): ?UserConfigExtensionInterface; /** * Set an extension attributes object * - * @param \Magento\TwoFactorAuth\Api\Data\UserConfigExtensionInterface $extensionAttributes + * @param UserConfigExtensionInterface $extensionAttributes */ public function setExtensionAttributes(UserConfigExtensionInterface $extensionAttributes): void; } diff --git a/TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php b/TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php index 18c776f9..e8bb7a40 100644 --- a/TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php +++ b/TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php @@ -11,6 +11,7 @@ /** * User config search result + * @api */ interface UserConfigSearchResultsInterface extends SearchResultsInterface { diff --git a/TwoFactorAuth/Api/DuoAuthenticateInterface.php b/TwoFactorAuth/Api/DuoAuthenticateInterface.php index ea3c743a..a34fa85b 100644 --- a/TwoFactorAuth/Api/DuoAuthenticateInterface.php +++ b/TwoFactorAuth/Api/DuoAuthenticateInterface.php @@ -12,6 +12,7 @@ /** * Represents authentication for the duo security provider + * @api */ interface DuoAuthenticateInterface { @@ -20,7 +21,7 @@ interface DuoAuthenticateInterface * * @param string $username * @param string $password - * @return \Magento\TwoFactorAuth\Api\Data\DuoDataInterface + * @return DuoDataInterface */ public function getAuthenticateData( string $username, diff --git a/TwoFactorAuth/Api/DuoConfigureInterface.php b/TwoFactorAuth/Api/DuoConfigureInterface.php index 844e2f41..c17e67be 100644 --- a/TwoFactorAuth/Api/DuoConfigureInterface.php +++ b/TwoFactorAuth/Api/DuoConfigureInterface.php @@ -12,6 +12,7 @@ /** * Represents configuration for the duo security provider + * @api */ interface DuoConfigureInterface { @@ -19,7 +20,7 @@ interface DuoConfigureInterface * Get the information required to configure duo * * @param string $tfaToken - * @return \Magento\TwoFactorAuth\Api\Data\DuoDataInterface + * @return DuoDataInterface */ public function getConfigurationData( string $tfaToken diff --git a/TwoFactorAuth/Api/EngineInterface.php b/TwoFactorAuth/Api/EngineInterface.php index e42ccac8..8f2716dc 100644 --- a/TwoFactorAuth/Api/EngineInterface.php +++ b/TwoFactorAuth/Api/EngineInterface.php @@ -12,6 +12,7 @@ /** * 2FA engine interface + * @api */ interface EngineInterface { diff --git a/TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php b/TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php index 86bfed07..6cdc7444 100644 --- a/TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php +++ b/TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php @@ -10,6 +10,7 @@ /** * Occurs when failed to notify a user. + * @api */ interface NotificationExceptionInterface extends \Throwable { diff --git a/TwoFactorAuth/Api/GoogleAuthenticateInterface.php b/TwoFactorAuth/Api/GoogleAuthenticateInterface.php index 6bdd99a0..0b595626 100644 --- a/TwoFactorAuth/Api/GoogleAuthenticateInterface.php +++ b/TwoFactorAuth/Api/GoogleAuthenticateInterface.php @@ -10,6 +10,7 @@ /** * Represents google authentication + * @api */ interface GoogleAuthenticateInterface { diff --git a/TwoFactorAuth/Api/GoogleConfigureInterface.php b/TwoFactorAuth/Api/GoogleConfigureInterface.php index 882b751e..38d77dde 100644 --- a/TwoFactorAuth/Api/GoogleConfigureInterface.php +++ b/TwoFactorAuth/Api/GoogleConfigureInterface.php @@ -10,6 +10,7 @@ /** * Represents the google provider + * @api */ interface GoogleConfigureInterface { @@ -17,11 +18,11 @@ interface GoogleConfigureInterface * Get the information required to configure google * * @param string $tfaToken - * @return \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface + * @return Data\GoogleConfigureInterface */ public function getConfigurationData( string $tfaToken - ): \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface; + ): Data\GoogleConfigureInterface; /** * Activate the provider and get an admin token diff --git a/TwoFactorAuth/Api/ProviderInterface.php b/TwoFactorAuth/Api/ProviderInterface.php index 1d1b33b5..c2330559 100644 --- a/TwoFactorAuth/Api/ProviderInterface.php +++ b/TwoFactorAuth/Api/ProviderInterface.php @@ -9,6 +9,7 @@ /** * 2FA proviced interface + * @api */ interface ProviderInterface { @@ -22,7 +23,7 @@ public function isEnabled(): bool; /** * Get provider engine * - * @return \Magento\TwoFactorAuth\Api\EngineInterface + * @return EngineInterface */ public function getEngine(); diff --git a/TwoFactorAuth/Api/ProviderPoolInterface.php b/TwoFactorAuth/Api/ProviderPoolInterface.php index 9c77a8b0..446f7cd7 100644 --- a/TwoFactorAuth/Api/ProviderPoolInterface.php +++ b/TwoFactorAuth/Api/ProviderPoolInterface.php @@ -11,13 +11,14 @@ /** * Providers pool + * @api */ interface ProviderPoolInterface { /** * Get a list of providers * - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getProviders(): array; @@ -25,7 +26,7 @@ public function getProviders(): array; * Get provider by code * * @param string $code - * @return \Magento\TwoFactorAuth\Api\ProviderInterface + * @return ProviderInterface * @throws NoSuchEntityException */ public function getProviderByCode(string $code): ProviderInterface; diff --git a/TwoFactorAuth/Api/TfaInterface.php b/TwoFactorAuth/Api/TfaInterface.php index ab819ff3..01075a24 100644 --- a/TwoFactorAuth/Api/TfaInterface.php +++ b/TwoFactorAuth/Api/TfaInterface.php @@ -9,6 +9,7 @@ /** * 2FA configuration manager. + * @api */ interface TfaInterface { @@ -41,7 +42,7 @@ public function getProvider(string $providerCode, bool $onlyEnabled = true): ?Pr /** * Retrieve forced providers list * - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getForcedProviders(): array; @@ -49,14 +50,14 @@ public function getForcedProviders(): array; * Get a user provider * * @param int $userId - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getUserProviders(int $userId): array; /** * Get a list of providers * - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getAllProviders(): array; @@ -64,14 +65,14 @@ public function getAllProviders(): array; * Get a list of providers * * @param string $code - * @return \Magento\TwoFactorAuth\Api\ProviderInterface|null + * @return ProviderInterface|null */ public function getProviderByCode(string $code): ?ProviderInterface; /** * Get a list of providers * - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getAllEnabledProviders(): array; @@ -86,7 +87,7 @@ public function getAllowedUrls(): array; * Returns a list of providers to configure/enroll * * @param int $userId - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getProvidersToActivate(int $userId): array; diff --git a/TwoFactorAuth/Api/TfaSessionInterface.php b/TwoFactorAuth/Api/TfaSessionInterface.php index 8bc1e9d5..ca559b7e 100644 --- a/TwoFactorAuth/Api/TfaSessionInterface.php +++ b/TwoFactorAuth/Api/TfaSessionInterface.php @@ -9,6 +9,7 @@ /** * 2FA session interface + * @api */ interface TfaSessionInterface { diff --git a/TwoFactorAuth/Api/TfatActionsInterface.php b/TwoFactorAuth/Api/TfatActionsInterface.php index d62878ae..a7f0d585 100644 --- a/TwoFactorAuth/Api/TfatActionsInterface.php +++ b/TwoFactorAuth/Api/TfatActionsInterface.php @@ -10,6 +10,7 @@ /** * Actions the user can perform using the pre-2fa token (tfat) + * @api */ interface TfatActionsInterface { @@ -17,7 +18,7 @@ interface TfatActionsInterface * Get the providers that the user is able to use for 2fa * * @param string $tfaToken - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getUserProviders(string $tfaToken): array; @@ -25,7 +26,7 @@ public function getUserProviders(string $tfaToken): array; * Get the providers that the user still needs to configure * * @param string $tfaToken - * @return \Magento\TwoFactorAuth\Api\ProviderInterface[] + * @return ProviderInterface[] */ public function getProvidersToActivate(string $tfaToken): array; } diff --git a/TwoFactorAuth/Api/U2fKeyAuthenticateInterface.php b/TwoFactorAuth/Api/U2fKeyAuthenticateInterface.php index ead9a29a..e5b2ba9d 100644 --- a/TwoFactorAuth/Api/U2fKeyAuthenticateInterface.php +++ b/TwoFactorAuth/Api/U2fKeyAuthenticateInterface.php @@ -12,6 +12,7 @@ /** * Represent Authentication for u2f key provider + * @api */ interface U2fKeyAuthenticateInterface { @@ -20,7 +21,7 @@ interface U2fKeyAuthenticateInterface * * @param string $username * @param string $password - * @return \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface + * @return U2fWebAuthnRequestInterface */ public function getAuthenticationData(string $username, string $password): U2fWebAuthnRequestInterface; diff --git a/TwoFactorAuth/Api/U2fKeyConfigReaderInterface.php b/TwoFactorAuth/Api/U2fKeyConfigReaderInterface.php index d5f3c2d5..67e3bedf 100644 --- a/TwoFactorAuth/Api/U2fKeyConfigReaderInterface.php +++ b/TwoFactorAuth/Api/U2fKeyConfigReaderInterface.php @@ -10,6 +10,7 @@ /** * Represents configuration for u2f key provider + * @api */ interface U2fKeyConfigReaderInterface { diff --git a/TwoFactorAuth/Api/U2fKeyConfigureInterface.php b/TwoFactorAuth/Api/U2fKeyConfigureInterface.php index 31ff6280..9519fafa 100644 --- a/TwoFactorAuth/Api/U2fKeyConfigureInterface.php +++ b/TwoFactorAuth/Api/U2fKeyConfigureInterface.php @@ -12,6 +12,7 @@ /** * Represent configuration for u2f key provider + * @api */ interface U2fKeyConfigureInterface { @@ -19,7 +20,7 @@ interface U2fKeyConfigureInterface * Get the information to initiate a WebAuthn registration ceremony * * @param string $tfaToken - * @return \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface + * @return U2fWebAuthnRequestInterface */ public function getRegistrationData(string $tfaToken): U2fWebAuthnRequestInterface; diff --git a/TwoFactorAuth/Api/UserConfigManagerInterface.php b/TwoFactorAuth/Api/UserConfigManagerInterface.php index a18e8703..5e7ad953 100644 --- a/TwoFactorAuth/Api/UserConfigManagerInterface.php +++ b/TwoFactorAuth/Api/UserConfigManagerInterface.php @@ -11,6 +11,7 @@ /** * User configuration manager + * @api */ interface UserConfigManagerInterface { diff --git a/TwoFactorAuth/Api/UserConfigRepositoryInterface.php b/TwoFactorAuth/Api/UserConfigRepositoryInterface.php index f55abfab..d9ebf6f4 100644 --- a/TwoFactorAuth/Api/UserConfigRepositoryInterface.php +++ b/TwoFactorAuth/Api/UserConfigRepositoryInterface.php @@ -14,6 +14,7 @@ /** * User configuration repository + * @api * * @SuppressWarnings(PHPMD.ShortVariable) */ diff --git a/TwoFactorAuth/Api/UserConfigRequestManagerInterface.php b/TwoFactorAuth/Api/UserConfigRequestManagerInterface.php index b81bada1..2d5210c3 100644 --- a/TwoFactorAuth/Api/UserConfigRequestManagerInterface.php +++ b/TwoFactorAuth/Api/UserConfigRequestManagerInterface.php @@ -14,6 +14,7 @@ /** * Manages configuration requests for users. + * @api */ interface UserConfigRequestManagerInterface { diff --git a/TwoFactorAuth/Api/UserConfigTokenManagerInterface.php b/TwoFactorAuth/Api/UserConfigTokenManagerInterface.php index b5d9662d..36f77a4a 100644 --- a/TwoFactorAuth/Api/UserConfigTokenManagerInterface.php +++ b/TwoFactorAuth/Api/UserConfigTokenManagerInterface.php @@ -10,6 +10,7 @@ /** * Manages tokens issued to users to authorize them to configure 2FA. + * @api */ interface UserConfigTokenManagerInterface { diff --git a/TwoFactorAuth/Api/UserNotifierInterface.php b/TwoFactorAuth/Api/UserNotifierInterface.php index c010badb..85183534 100644 --- a/TwoFactorAuth/Api/UserNotifierInterface.php +++ b/TwoFactorAuth/Api/UserNotifierInterface.php @@ -13,6 +13,7 @@ /** * Sends notifications to users regarding 2FA. + * @api */ interface UserNotifierInterface {