Mark various interfaces as api

mrtuvn · mrtuvn · commit 9d5819ae8633 · 2021-04-03T09:10:48.000+07:00
update


update


update


update


update


update


up
diff --git a/app/code/Magento/GraphQl/Model/Query/ContextInterface.php b/app/code/Magento/GraphQl/Model/Query/ContextInterface.php
@@ -16,6 +16,8 @@
  *
  * GraphQL will pass the same instance of this interface to each field resolver, so these resolvers could have
  * shared access to the same data for ease of implementation purposes.
+ *
+ * @api
  */
 interface ContextInterface extends BaseContextInterface, ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Msrp/Pricing/MsrpPriceCalculatorInterface.php b/app/code/Magento/Msrp/Pricing/MsrpPriceCalculatorInterface.php
@@ -3,13 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Msrp\Pricing;
 
 use Magento\Catalog\Api\Data\ProductInterface;
 
 /**
  * Provide information about MSRP price of a product.
+ *
+ * @api
  */
 interface MsrpPriceCalculatorInterface
 {
diff --git a/app/code/Magento/Newsletter/Model/SubscriptionManagerInterface.php b/app/code/Magento/Newsletter/Model/SubscriptionManagerInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface to update newsletter subscription status
+ *
+ * @api
  */
 interface SubscriptionManagerInterface
 {
diff --git a/app/code/Magento/PageCache/Model/Spi/PageCacheTagsPreprocessorInterface.php b/app/code/Magento/PageCache/Model/Spi/PageCacheTagsPreprocessorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface for page tags preprocessors
+ *
+ * @api
  */
 interface PageCacheTagsPreprocessorInterface
 {
diff --git a/app/code/Magento/Payment/Api/Data/PaymentAdditionalInfoInterface.php b/app/code/Magento/Payment/Api/Data/PaymentAdditionalInfoInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Payment additional info interface.
+ *
+ * @api
  */
 interface PaymentAdditionalInfoInterface extends KeyValueObjectInterface
 {
diff --git a/app/code/Magento/Payment/Model/Method/TransparentInterface.php b/app/code/Magento/Payment/Model/Method/TransparentInterface.php
@@ -10,7 +10,9 @@
 /**
  * Interface TransparentInterface need to be implemented by Payment Method service
  * which supports transparent redirect feature
+ *
  * @package Magento\Payment\Model\Method
+ * @api
  */
 interface TransparentInterface extends MethodInterface
 {
diff --git a/app/code/Magento/Paypal/Helper/Shortcut/ValidatorInterface.php b/app/code/Magento/Paypal/Helper/Shortcut/ValidatorInterface.php
@@ -3,12 +3,12 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Paypal\Helper\Shortcut;
 
 /**
  * Interface \Magento\Paypal\Helper\Shortcut\ValidatorInterface
  *
+ * @api
  */
 interface ValidatorInterface
 {
diff --git a/app/code/Magento/Paypal/Model/Billing/AbstractAgreement.php b/app/code/Magento/Paypal/Model/Billing/AbstractAgreement.php
@@ -7,6 +7,8 @@
 
 /**
  * Billing Agreement abstract class
+ *
+ * @api
  */
 abstract class AbstractAgreement extends \Magento\Framework\Model\AbstractModel
 {
diff --git a/app/code/Magento/Paypal/Model/Billing/Agreement/MethodInterface.php b/app/code/Magento/Paypal/Model/Billing/Agreement/MethodInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface for payment methods that support billing agreements management
+ *
+ * @api
  */
 interface MethodInterface
 {
diff --git a/app/code/Magento/Paypal/Model/IpnInterface.php b/app/code/Magento/Paypal/Model/IpnInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Paypal\Model\IpnInterface
  *
+ * @api
  */
 interface IpnInterface
 {
diff --git a/app/code/Magento/Paypal/Model/Payflow/Service/Response/Handler/HandlerInterface.php b/app/code/Magento/Paypal/Model/Payflow/Service/Response/Handler/HandlerInterface.php
@@ -10,7 +10,9 @@
 
 /**
  * Interface HandlerInterface used for error handling of gateway response
+ *
  * @package Magento\Paypal\Model\Payflow\Service\Response\Handler
+ * @api
  */
 interface HandlerInterface
 {
diff --git a/app/code/Magento/Quote/Api/ChangeQuoteControlInterface.php b/app/code/Magento/Quote/Api/ChangeQuoteControlInterface.php
@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Quote\Api;
@@ -12,6 +11,8 @@
 
 /**
  * Service checks if the user has ability to change the quote.
+ *
+ * @api
  */
 interface ChangeQuoteControlInterface
 {
diff --git a/app/code/Magento/Quote/Model/Cart/BuyRequest/BuyRequestDataProviderInterface.php b/app/code/Magento/Quote/Model/Cart/BuyRequest/BuyRequestDataProviderInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Provides data for buy request for different types of products
+ *
+ * @api
  */
 interface BuyRequestDataProviderInterface
 {
diff --git a/app/code/Magento/Quote/Model/Cart/Data/CartItem.php b/app/code/Magento/Quote/Model/Cart/Data/CartItem.php
@@ -9,6 +9,8 @@
 
 /**
  * DTO represents Cart Item data
+ *
+ * @api
  */
 class CartItem
 {
diff --git a/app/code/Magento/Quote/Model/Product/QuoteItemsCleanerInterface.php b/app/code/Magento/Quote/Model/Product/QuoteItemsCleanerInterface.php
@@ -10,6 +10,7 @@
 /**
  * Interface \Magento\Quote\Model\Product\QuoteItemsCleanerInterface
  *
+ * @api
  */
 interface QuoteItemsCleanerInterface
 {
diff --git a/app/code/Magento/Quote/Model/Quote/Address/CustomAttributeListInterface.php b/app/code/Magento/Quote/Model/Quote/Address/CustomAttributeListInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Quote\Model\Quote\Address\CustomAttributeListInterface
  *
+ * @api
  */
 interface CustomAttributeListInterface
 {
diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/CollectorInterface.php b/app/code/Magento/Quote/Model/Quote/Address/Total/CollectorInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Quote\Model\Quote\Address\Total\CollectorInterface
  *
+ * @api
  */
 interface CollectorInterface
 {
diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/ReaderInterface.php b/app/code/Magento/Quote/Model/Quote/Address/Total/ReaderInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Quote\Model\Quote\Address\Total\ReaderInterface
  *
+ * @api
  */
 interface ReaderInterface
 {
diff --git a/app/code/Magento/Quote/Model/Quote/Item/CartItemProcessorInterface.php b/app/code/Magento/Quote/Model/Quote/Item/CartItemProcessorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface CartItemProcessorInterface
+ *
+ * @api
  */
 interface CartItemProcessorInterface
 {
diff --git a/app/code/Magento/Quote/Model/Quote/Item/Option.php b/app/code/Magento/Quote/Model/Quote/Item/Option.php
@@ -15,6 +15,8 @@
  * @method string getCode()
  * @method \Magento\Quote\Model\Quote\Item\Option setCode(string $value)
  * @method \Magento\Quote\Model\Quote\Item\Option setValue(string $value)
+ *
+ * @api
  */
 class Option extends \Magento\Framework\Model\AbstractModel implements
     \Magento\Catalog\Model\Product\Configuration\Item\Option\OptionInterface
diff --git a/app/code/Magento/Quote/Model/ValidationRules/QuoteValidationRuleInterface.php b/app/code/Magento/Quote/Model/ValidationRules/QuoteValidationRuleInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Provides validation of Quote model.
+ *
+ * @api
  */
 interface QuoteValidationRuleInterface
 {
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/BuyRequestDataProviderInterface.php b/app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/BuyRequestDataProviderInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Build buy request for adding products to cart
+ *
+ * @api
  */
 interface BuyRequestDataProviderInterface
 {
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/Payment/AdditionalDataProviderInterface.php b/app/code/Magento/QuoteGraphQl/Model/Cart/Payment/AdditionalDataProviderInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface for payment method additional data provider
+ *
+ * @api
  */
 interface AdditionalDataProviderInterface
 {
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingAddressesOnCartInterface.php b/app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingAddressesOnCartInterface.php
@@ -15,9 +15,10 @@
 
 /**
  * Extension point for setting shipping addresses for a specified shopping cart
- *
  * All objects that are responsible for setting shipping addresses on a cart via GraphQl
  * should implement this interface.
+ *
+ * @api
  */
 interface SetShippingAddressesOnCartInterface
 {
diff --git a/app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingMethodsOnCartInterface.php b/app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingMethodsOnCartInterface.php
@@ -16,9 +16,10 @@
 
 /**
  * Extension point for setting shipping methods for a specified shopping cart
- *
  * All objects that are responsible for setting shipping methods on a cart via GraphQl
  * should implement this interface.
+ *
+ * @api
  */
 interface SetShippingMethodsOnCartInterface
 {
diff --git a/app/code/Magento/QuoteGraphQl/Model/CartItem/DataProvider/CustomizableOptionValueInterface.php b/app/code/Magento/QuoteGraphQl/Model/CartItem/DataProvider/CustomizableOptionValueInterface.php
@@ -13,6 +13,8 @@
 
 /**
  * Customizable Option Value Data provider
+ *
+ * @api
  */
 interface CustomizableOptionValueInterface
 {
diff --git a/app/code/Magento/QuoteGraphQl/Model/CartItem/DataProvider/Processor/ItemDataProcessorInterface.php b/app/code/Magento/QuoteGraphQl/Model/CartItem/DataProvider/Processor/ItemDataProcessorInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Process Cart Item Data
+ *
+ * @api
  */
 interface ItemDataProcessorInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlAuthenticationException.php b/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlAuthenticationException.php
@@ -13,6 +13,8 @@
 
 /**
  * Exception for GraphQL to be thrown when authentication fails
+ *
+ * @api
  */
 class GraphQlAuthenticationException extends AuthenticationException implements ClientAware
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlAuthorizationException.php b/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlAuthorizationException.php
@@ -12,6 +12,8 @@
 
 /**
  * Exception for GraphQL to be thrown when authorization fails
+ *
+ * @api
  */
 class GraphQlAuthorizationException extends AuthorizationException implements \GraphQL\Error\ClientAware
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlInputException.php b/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlInputException.php
@@ -14,6 +14,8 @@
 
 /**
  * Exception for GraphQL to be thrown when user supplies invalid input
+ *
+ * @api
  */
 class GraphQlInputException extends LocalizedException implements AggregateExceptionInterface, ClientAware
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlNoSuchEntityException.php b/lib/internal/Magento/Framework/GraphQl/Exception/GraphQlNoSuchEntityException.php
@@ -12,6 +12,8 @@
 
 /**
  * Exception for GraphQL to be thrown when entity does not exists
+ *
+ * @api
  */
 class GraphQlNoSuchEntityException extends NoSuchEntityException implements \GraphQL\Error\ClientAware
 {
@@ -39,15 +41,15 @@ public function __construct(Phrase $phrase, \Exception $cause = null, $code = 0,
     /**
      * @inheritdoc
      */
-    public function isClientSafe() : bool
+    public function isClientSafe(): bool
     {
         return $this->isSafe;
     }
 
     /**
      * @inheritdoc
      */
-    public function getCategory() : string
+    public function getCategory(): string
     {
         return self::EXCEPTION_CATEGORY;
     }
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/ContextInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/ContextInterface.php
@@ -14,6 +14,8 @@
  *
  * GraphQL will pass the same instance of this interface to each field resolver, so these resolvers could have
  * shared access to the same data for ease of implementation purposes.
+ *
+ * @api
  */
 interface ContextInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`*`
`17`	`17`	`* GraphQL will pass the same instance of this interface to each field resolver, so these resolvers could have`
`18`	`18`	`* shared access to the same data for ease of implementation purposes.`
	`19`	`+ *`
	`20`	`+ * @api`
`19`	`21`	`*/`
`20`	`22`	`interface ContextInterface extends BaseContextInterface, ExtensibleDataInterface`
`21`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Interface to update newsletter subscription status`
	`12`	`+ *`
	`13`	`+ * @api`
`12`	`14`	`*/`
`13`	`15`	`interface SubscriptionManagerInterface`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* Payment additional info interface.`
	`14`	`+ *`
	`15`	`+ * @api`
`14`	`16`	`*/`
`15`	`17`	`interface PaymentAdditionalInfoInterface extends KeyValueObjectInterface`
`16`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,12 @@`
`3`	`3`	`* Copyright © Magento, Inc. All rights reserved.`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
`6`		`-`
`7`	`6`	`namespace Magento\Paypal\Helper\Shortcut;`
`8`	`7`
`9`	`8`	`/**`
`10`	`9`	`* Interface \Magento\Paypal\Helper\Shortcut\ValidatorInterface`
`11`	`10`	`*`
	`11`	`+ * @api`
`12`	`12`	`*/`
`13`	`13`	`interface ValidatorInterface`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Billing Agreement abstract class`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`abstract class AbstractAgreement extends \Magento\Framework\Model\AbstractModel`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface for payment methods that support billing agreements management`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`interface MethodInterface`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`/**`
`9`	`9`	`* Interface \Magento\Paypal\Model\IpnInterface`
`10`	`10`	`*`
	`11`	`+ * @api`
`11`	`12`	`*/`
`12`	`13`	`interface IpnInterface`
`13`	`14`	`{`