Skip to content

Commit 366106a

Browse files
committed
MC-40870: Mark interfaces as api
1 parent 0ea11ca commit 366106a

34 files changed

+73
-41
lines changed

TwoFactorAuth/Api/AdminTokenServiceInterface.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
/**
1414
* Obtain basic information about the user required to setup or use 2fa
15+
*
1516
* @api
1617
*/
1718
interface AdminTokenServiceInterface extends OriginalTokenServiceInterface

TwoFactorAuth/Api/AuthyAuthenticateInterface.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
/**
1212
* Represents the authy provider authentication
13+
*
1314
* @api
1415
*/
1516
interface AuthyAuthenticateInterface

TwoFactorAuth/Api/AuthyConfigureInterface.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
/**
1515
* Represents the authy provider
16+
*
1617
* @api
1718
*/
1819
interface AuthyConfigureInterface
@@ -22,7 +23,7 @@ interface AuthyConfigureInterface
2223
*
2324
* @param string $tfaToken
2425
* @param AuthyDeviceInterface $deviceData
25-
* @return ResponseInterface
26+
* @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
2627
*/
2728
public function sendDeviceRegistrationPrompt(
2829
string $tfaToken,

TwoFactorAuth/Api/CountryRepositoryInterface.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
/**
1616
* Countries repository
17+
*
1718
* @api
1819
* @SuppressWarnings(PHPMD.ShortVariable)
1920
*/

TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
namespace Magento\TwoFactorAuth\Api\Data;
1010

1111
use Magento\Framework\Api\ExtensibleDataInterface;
12-
use Magento\TwoFactorAuth\Api\ProviderInterface;
1312

1413
/**
1514
* Represents the response to the new admin token response
15+
*
1616
* @api
1717
*/
1818
interface AdminTokenResponseInterface extends ExtensibleDataInterface
@@ -65,14 +65,14 @@ public function setMessage(string $value): void;
6565
/**
6666
* Get the providers
6767
*
68-
* @return ProviderInterface[]
68+
* @return \Magento\TwoFactorAuth\Api\ProviderInterface[]
6969
*/
7070
public function getActiveProviders(): array;
7171

7272
/**
7373
* Set the providers
7474
*
75-
* @param ProviderInterface[] $value
75+
* @param \Magento\TwoFactorAuth\Api\ProviderInterface[] $value
7676
* @return void
7777
*/
7878
public function setActiveProviders(array $value): void;
@@ -82,14 +82,14 @@ public function setActiveProviders(array $value): void;
8282
*
8383
* Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
8484
*
85-
* @return AdminTokenResponseExtensionInterface|null
85+
* @return \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface|null
8686
*/
8787
public function getExtensionAttributes(): ?AdminTokenResponseExtensionInterface;
8888

8989
/**
9090
* Set an extension attributes object
9191
*
92-
* @param AdminTokenResponseExtensionInterface $extensionAttributes
92+
* @param \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface $extensionAttributes
9393
* @return void
9494
*/
9595
public function setExtensionAttributes(

TwoFactorAuth/Api/Data/AuthyDeviceInterface.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
/**
1313
* Authy device data interface
14+
*
1415
* @api
1516
*/
1617
interface AuthyDeviceInterface extends ExtensibleDataInterface
@@ -90,14 +91,14 @@ public function setMethod(string $value): void;
9091
*
9192
* Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
9293
*
93-
* @return AuthyDeviceExtensionInterface|null
94+
* @return \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface|null
9495
*/
9596
public function getExtensionAttributes(): ?AuthyDeviceExtensionInterface;
9697

9798
/**
9899
* Set an extension attributes object
99100
*
100-
* @param AuthyDeviceExtensionInterface $extensionAttributes
101+
* @param \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface $extensionAttributes
101102
* @return void
102103
*/
103104
public function setExtensionAttributes(

TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
/**
1414
* Response for device registration prompt
15+
*
1516
* @api
1617
*/
1718
interface AuthyRegistrationPromptResponseInterface extends ExtensibleDataInterface
@@ -61,14 +62,14 @@ public function setExpirationSeconds(int $value): void;
6162
*
6263
* Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
6364
*
64-
* @return AuthyRegistrationPromptResponseExtensionInterface|null
65+
* @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseExtensionInterface|null
6566
*/
6667
public function getExtensionAttributes(): ?AuthyRegistrationPromptResponseExtensionInterface;
6768

6869
/**
6970
* Set an extension attributes object
7071
*
71-
* @param AuthyRegistrationPromptResponseExtensionInterface $extensionAttributes
72+
* @param \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseExtensionInterface $extensionAttributes
7273
* @return void
7374
*/
7475
public function setExtensionAttributes(

TwoFactorAuth/Api/Data/CountryInterface.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
/**
1313
* Country entity interface
14+
*
1415
* @api
1516
*/
1617
interface CountryInterface extends ExtensibleDataInterface
@@ -96,14 +97,14 @@ public function setDialCode(string $value): void;
9697
*
9798
* Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
9899
*
99-
* @return CountryExtensionInterface|null
100+
* @return \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface|null
100101
*/
101102
public function getExtensionAttributes(): ?CountryExtensionInterface;
102103

103104
/**
104105
* Set an extension attributes object
105106
*
106-
* @param CountryExtensionInterface $extensionAttributes
107+
* @param \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface $extensionAttributes
107108
*/
108109
public function setExtensionAttributes(
109110
CountryExtensionInterface $extensionAttributes

TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
/**
1313
* Represent country search results
14+
*
1415
* @api
1516
*/
1617
interface CountrySearchResultsInterface extends SearchResultsInterface

TwoFactorAuth/Api/Data/DuoDataInterface.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
/**
1313
* Represents the data needed to use duo
14+
*
1415
* @api
1516
*/
1617
interface DuoDataInterface extends ExtensibleDataInterface
@@ -60,14 +61,14 @@ public function setApiHostname(string $value): void;
6061
*
6162
* Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
6263
*
63-
* @return DuoDataExtensionInterface|null
64+
* @return \Magento\TwoFactorAuth\Api\Data\DuoDataExtensionInterface|null
6465
*/
6566
public function getExtensionAttributes(): ?DuoDataExtensionInterface;
6667

6768
/**
6869
* Set an extension attributes object
6970
*
70-
* @param DuoDataExtensionInterface $extensionAttributes
71+
* @param \Magento\TwoFactorAuth\Api\Data\DuoDataExtensionInterface $extensionAttributes
7172
* @return void
7273
*/
7374
public function setExtensionAttributes(

0 commit comments

Comments
 (0)