Merge pull request #1029 from magento-engcom/develop-prs-isolated

[Engcom] SSL for AMQP and @api annotations for URLRewrite and Indexer

Author: vrann

app/code/Magento/Catalog/Model/Category.php

@@ -116,6 +116,7 @@ class Category extends \Magento\Catalog\Model\AbstractModel implements
      * URL rewrite model
      *
      * @var \Magento\UrlRewrite\Model\UrlRewrite
+     * @deprecated since 2.2.0
      */
     protected $_urlRewrite;
 

app/code/Magento/CatalogUrlRewrite/Model/Map/DatabaseMapInterface.php

@@ -5,8 +5,6 @@
  */
 namespace Magento\CatalogUrlRewrite\Model\Map;
 
-use Magento\Framework\DB\Select;
-
 /**
  * Interface for a mysql data type of a map
  *

app/code/Magento/Indexer/Model/Processor/Handler.php

@@ -11,6 +11,7 @@
  * This class is to be used as a container for new generated url rewrites by adding new ones using merge method
  * Removes duplicates for a set/array of Url Rewrites based on the unique key of the url_rewrites table
  *
+ * @api
  */
 class MergeDataProvider
 {

app/code/Magento/UrlRewrite/Model/MergeDataProvider.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\UrlRewrite\Model;
 
+/**
+ * @api
+ */
 interface StorageInterface extends UrlFinderInterface, UrlPersistInterface
 {
 }

app/code/Magento/UrlRewrite/Model/StorageInterface.php

@@ -7,6 +7,7 @@
 
 /**
  * Url Finder Interface
+ * @api
  */
 interface UrlFinderInterface
 {

app/code/Magento/UrlRewrite/Model/UrlFinderInterface.php

@@ -7,6 +7,7 @@
 
 /**
  * Url Persist Interface
+ * @api
  */
 interface UrlPersistInterface
 {

app/code/Magento/UrlRewrite/Model/UrlPersistInterface.php

@@ -11,6 +11,7 @@
 
 /**
  * Data abstract class for url storage
+ * @api
  */
 class UrlRewrite extends AbstractSimpleObject
 {

app/code/Magento/UrlRewrite/Service/V1/Data/UrlRewrite.php

@@ -5,8 +5,6 @@
  */
 namespace Magento\Framework\Indexer;
 
-use Magento\Framework\Indexer\ActionInterface;
-
 class ActionFactory
 {
     /**

lib/internal/Magento/Framework/Indexer/ActionFactory.php

@@ -6,7 +6,7 @@
 namespace Magento\Framework\Indexer;
 
 /**
- * @api
+ * @api Implement custom Action Interface
  */
 interface ActionInterface
 {

lib/internal/Magento/Framework/Indexer/ActionInterface.php

@@ -13,6 +13,8 @@
  *
  * Can be used during indexation process to split large amount of data into batches
  * and process them one by one in order to reduce memory consumption and improve overall performance.
+ *
+ * @api retrieve Batches when implementing custom Indexer\Action
  */
 interface BatchProviderInterface
 {

lib/internal/Magento/Framework/Indexer/BatchProviderInterface.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Indexer;
 
+/**
+ * @api Implement custom Fieldset
+ */
 interface FieldsetInterface
 {
     /**

lib/internal/Magento/Framework/Indexer/FieldsetInterface.php

@@ -7,6 +7,9 @@
 
 use Magento\Framework\ObjectManagerInterface;
 
+/**
+ * @api Retrieve Fieldset when implementing custom Indexer\Action
+ */
 class FieldsetPool
 {
     /**

lib/internal/Magento/Framework/Indexer/FieldsetPool.php

@@ -7,6 +7,9 @@
 
 use Magento\Framework\App\ResourceConnection\SourceProviderInterface;
 
+/**
+ * @api Implement custom Handler
+ */
 interface HandlerInterface
 {
     /**

lib/internal/Magento/Framework/Indexer/FilterInterface.php

@@ -8,6 +8,9 @@
 use Magento\Framework\Indexer\Handler\DefaultHandler;
 use Magento\Framework\ObjectManagerInterface;
 
+/**
+ * @api Instantiate save handler when implementing custom Indexer\Action
+ */
 class HandlerPool
 {
     /**

lib/internal/Magento/Framework/Indexer/HandlerInterface.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Indexer;
 
+/**
+ * @api Retrieve indexer by id, for example when indexer need to be invalidated
+ */
 class IndexerRegistry
 {
     /**

lib/internal/Magento/Framework/Indexer/HandlerPool.php

@@ -9,6 +9,9 @@
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\Indexer\SaveHandler\IndexerInterface as SaveHandlerInterface;
 
+/**
+ * @api Instantiate save handler when implementing custom Indexer\Action
+ */
 class SaveHandlerFactory
 {
     /**

lib/internal/Magento/Framework/Indexer/IndexerRegistry.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Indexer;
 
+/**
+ * @api Retrieve status of the Indexer
+ */
 interface StateInterface
 {
     /**

lib/internal/Magento/Framework/Indexer/SaveHandlerFactory.php

@@ -5,10 +5,6 @@
  */
 namespace Magento\Framework\Indexer\Table;
 
-/**
- * Class Strategy
- * @package Magento\Indexer
- */
 class Strategy implements StrategyInterface
 {
     /**

lib/internal/Magento/Framework/Indexer/StateInterface.php

@@ -6,10 +6,6 @@
 
 namespace Magento\Framework\Indexer\Table;
 
-/**
- * Interface StrategyInterface
- * @package Magento\Indexer
- */
 interface StrategyInterface
 {
     const IDX_SUFFIX = '_idx';

lib/internal/Magento/Framework/Indexer/Table/Strategy.php

@@ -5,11 +5,6 @@
  */
 namespace Magento\Framework\Mview\View;
 
-/**
- * Class SubscriptionFactory
- * @package Magento\Framework\Mview\View
- *
- */
 class SubscriptionFactory extends AbstractFactory
 {
     /**