Merge pull request #1045 from magento-okapis/MAGETWO-65444-Api-Annota…

…tions - MAGETWO-65444 Add @api annotation to modules owned by Okapis - MAGETWO-66882 [Clone] Allowing Web API listing to be public - 2.2
magento · Apr 20, 2017 · 6476ac9 · 6476ac9
2 parents ecf775e + 0f2becb
commit 6476ac9
Show file tree

Hide file tree

Showing 149 changed files with 431 additions and 141 deletions.
diff --git a/app/code/Magento/Authorization/Model/CompositeUserContext.php b/app/code/Magento/Authorization/Model/CompositeUserContext.php
@@ -9,7 +9,12 @@
 use Magento\Framework\ObjectManager\Helper\Composite as CompositeHelper;
 
 /**
- * Composite user context (implements composite pattern).
+ * User context.
+ *
+ * This class is not implementing standard composite pattern and will not invoke all of its children.
+ * Instead, it will try to find the first suitable child and return its result.
+ *
+ * @api
  */
 class CompositeUserContext implements \Magento\Authorization\Model\UserContextInterface
 {

diff --git a/app/code/Magento/Authorization/Model/ResourceModel/Permissions/Collection.php b/app/code/Magento/Authorization/Model/ResourceModel/Permissions/Collection.php
@@ -8,20 +8,9 @@
 /**
  * Admin permissions collection
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @deprecated
+ * @see \Magento\Authorization\Model\ResourceModel\Rules\Collection
  */
-class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
+class Collection extends \Magento\Authorization\Model\ResourceModel\Rules\Collection
 {
-    /**
-     * Initialize resource
-     *
-     * @return void
-     */
-    protected function _construct()
-    {
-        $this->_init(
-            \Magento\Authorization\Model\Rules::class,
-            \Magento\Authorization\Model\ResourceModel\Rules::class
-        );
-    }
 }
diff --git a/app/code/Magento/Authorization/Model/ResourceModel/Role/Collection.php b/app/code/Magento/Authorization/Model/ResourceModel/Role/Collection.php
@@ -9,6 +9,8 @@
 
 /**
  * Admin role collection
+ *
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {

diff --git a/app/code/Magento/Authorization/Model/ResourceModel/Rules/Collection.php b/app/code/Magento/Authorization/Model/ResourceModel/Rules/Collection.php
@@ -8,7 +8,7 @@
 /**
  * Rules collection
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {

diff --git a/app/code/Magento/Authorization/Model/Role.php b/app/code/Magento/Authorization/Model/Role.php
@@ -24,6 +24,7 @@
  * @method \Magento\Authorization\Model\Role setUserType(string $value)
  * @method string getRoleName()
  * @method \Magento\Authorization\Model\Role setRoleName(string $value)
+ * @api
  */
 class Role extends \Magento\Framework\Model\AbstractModel
 {

diff --git a/app/code/Magento/Authorization/Model/Rules.php b/app/code/Magento/Authorization/Model/Rules.php
@@ -21,6 +21,7 @@
  * @method \Magento\Authorization\Model\Rules setAssertId(int $value)
  * @method string getPermission()
  * @method \Magento\Authorization\Model\Rules setPermission(string $value)
+ * @api
  */
 class Rules extends \Magento\Framework\Model\AbstractModel
 {
@@ -30,14 +31,14 @@ class Rules extends \Magento\Framework\Model\AbstractModel
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
      * @param \Magento\Authorization\Model\ResourceModel\Rules $resource
-     * @param \Magento\Authorization\Model\ResourceModel\Permissions\Collection $resourceCollection
+     * @param \Magento\Authorization\Model\ResourceModel\Rules\Collection $resourceCollection
      * @param array $data
      */
     public function __construct(
         \Magento\Framework\Model\Context $context,
         \Magento\Framework\Registry $registry,
         \Magento\Authorization\Model\ResourceModel\Rules $resource,
-        \Magento\Authorization\Model\ResourceModel\Permissions\Collection $resourceCollection,
+        \Magento\Authorization\Model\ResourceModel\Rules\Collection $resourceCollection,
         array $data = []
     ) {
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);

diff --git a/app/code/Magento/Authorization/Model/UserContextInterface.php b/app/code/Magento/Authorization/Model/UserContextInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Interface for current user identification.
+ *
+ * @api
  */
 interface UserContextInterface
 {

diff --git a/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php b/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php
@@ -4,13 +4,11 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Captcha\Block\Adminhtml\Captcha;
+
 /**
  * Captcha block for adminhtml area
- *
- * @author     Magento Core Team <core@magentocommerce.com>
  */
-namespace Magento\Captcha\Block\Adminhtml\Captcha;
-
 class DefaultCaptcha extends \Magento\Captcha\Block\Captcha\DefaultCaptcha
 {
     /**

diff --git a/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php b/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php
@@ -7,8 +7,6 @@
 
 /**
  * Captcha block
- *
- * @author     Magento Core Team <core@magentocommerce.com>
  */
 class DefaultCaptcha extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Captcha/Helper/Data.php b/app/code/Magento/Captcha/Helper/Data.php
@@ -11,6 +11,8 @@
 
 /**
  * Captcha image model
+ *
+ * @api
  */
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {

diff --git a/app/code/Magento/Captcha/Model/DefaultModel.php b/app/code/Magento/Captcha/Model/DefaultModel.php
@@ -8,7 +8,7 @@
 /**
  * Implementation of \Zend\Captcha\Image
  *
- * @author     Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class DefaultModel extends \Zend\Captcha\Image implements \Magento\Captcha\Model\CaptchaInterface
 {

diff --git a/app/code/Magento/Captcha/view/frontend/web/captcha.js b/app/code/Magento/Captcha/view/frontend/web/captcha.js
@@ -9,6 +9,9 @@ define([
 ], function ($) {
     'use strict';
 
+    /**
+     * @api
+     */
     $.widget('mage.captcha', {
         options: {
             refreshClass: 'refreshing',
@@ -26,7 +29,7 @@ define([
         },
 
         /**
-         * Method triggeres an AJAX request to refresh the CAPTCHA image
+         * Method triggers an AJAX request to refresh the CAPTCHA image
          */
         refresh: function () {
             var imageLoader = this.options.imageLoader;

diff --git a/app/code/Magento/Catalog/Model/Product/Exception.php b/app/code/Magento/Catalog/Model/Product/Exception.php
@@ -7,6 +7,9 @@
 
 use Magento\Framework\Exception\LocalizedException;
 
+/**
+ * @api
+ */
 class Exception extends LocalizedException
 {
 }
diff --git a/app/code/Magento/CatalogRule/Model/Flag.php b/app/code/Magento/CatalogRule/Model/Flag.php
@@ -4,13 +4,11 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Flag stores status about availability not applied catalog price rules
- *
- * @author      Magento Core Team <core@magentocommerce.com>
- */
 namespace Magento\CatalogRule\Model;
 
+/**
+ * Flag indicates that some rules have changed but changes have not been applied yet.
+ */
 class Flag extends \Magento\Framework\Flag
 {
     /**

diff --git a/app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php b/app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php
@@ -16,6 +16,7 @@
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class IndexBuilder
 {

diff --git a/app/code/Magento/CatalogSearch/Model/Indexer/Scope/IndexTableNotExistException.php b/app/code/Magento/CatalogSearch/Model/Indexer/Scope/IndexTableNotExistException.php
@@ -11,6 +11,8 @@
 /**
  * Exception which represents situation where temporary index table should be used somewhere,
  * but it does not exist in a database
+ *
+ * @api
  */
 class IndexTableNotExistException extends LocalizedException
 {

diff --git a/app/code/Magento/CatalogSearch/Model/Indexer/Scope/UnknownStateException.php b/app/code/Magento/CatalogSearch/Model/Indexer/Scope/UnknownStateException.php
@@ -10,6 +10,8 @@
 
 /**
  * Exception for situation where used state which is not defined in configuration
+ *
+ * @api
  */
 class UnknownStateException extends LocalizedException
 {

diff --git a/app/code/Magento/Checkout/Exception.php b/app/code/Magento/Checkout/Exception.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Checkout;
 
+/**
+ * @api
+ */
 class Exception extends \Magento\Framework\Exception\LocalizedException
 {
 }
diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/AttributeGroupAlreadyExistsException.php b/app/code/Magento/Eav/Model/Entity/Attribute/AttributeGroupAlreadyExistsException.php
@@ -8,7 +8,7 @@
 use Magento\Framework\Exception\AlreadyExistsException;
 
 /**
- * Class AttributeGroupAlreadyExistsException
+ * @api
  */
 class AttributeGroupAlreadyExistsException extends AlreadyExistsException
 {

diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/Exception.php b/app/code/Magento/Eav/Model/Entity/Attribute/Exception.php
@@ -8,7 +8,7 @@
 /**
  * EAV entity attribute exception
  *
- * @author     Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Exception extends \Magento\Framework\Exception\LocalizedException
 {

diff --git a/app/code/Magento/Integration/Model/AdminTokenService.php b/app/code/Magento/Integration/Model/AdminTokenService.php
@@ -17,13 +17,12 @@
 
 /**
  * Class to handle token generation for Admins
- *
  */
 class AdminTokenService implements \Magento\Integration\Api\AdminTokenServiceInterface
 {
     /**
      * Token Model
-     *a
+     *
      * @var TokenModelFactory
      */
     private $tokenModelFactory;

diff --git a/app/code/Magento/Integration/Model/Integration.php b/app/code/Magento/Integration/Model/Integration.php
@@ -26,6 +26,7 @@
  * @method \string getUpdatedAt()
  * @method Integration setUpdatedAt(\string $createdAt)
  * @method \Magento\Integration\Model\ResourceModel\Integration getResource()
+ * @api
  */
 class Integration extends \Magento\Framework\Model\AbstractModel
 {

diff --git a/app/code/Magento/Integration/Model/Message/RecreatedIntegration.php b/app/code/Magento/Integration/Model/Message/RecreatedIntegration.php
@@ -14,7 +14,6 @@
 
 /**
  * Class RecreatedIntegration to display message when a config-based integration needs to be reactivated
- *
  */
 class RecreatedIntegration implements \Magento\Framework\Notification\MessageInterface
 {

diff --git a/app/code/Magento/Integration/Model/Oauth/Token.php b/app/code/Magento/Integration/Model/Oauth/Token.php
@@ -41,6 +41,7 @@
  * @method int getAuthorized()
  * @method Token setAuthorized() setAuthorized(int $authorized)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class Token extends \Magento\Framework\Model\AbstractModel
 {

diff --git a/app/code/Magento/Integration/view/adminhtml/web/js/integration.js b/app/code/Magento/Integration/view/adminhtml/web/js/integration.js
@@ -3,6 +3,11 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * jQuery plugin is added.
+ *
+ * @api
+ */
 define([
     'jquery',
     'Magento_Ui/js/modal/alert',

diff --git a/app/code/Magento/MediaStorage/Helper/File/Storage.php b/app/code/Magento/MediaStorage/Helper/File/Storage.php
@@ -4,13 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\MediaStorage\Helper\File;
+
 /**
  * File storage helper
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
-namespace Magento\MediaStorage\Helper\File;
-
 class Storage extends \Magento\Framework\App\Helper\AbstractHelper
 {
     /**

diff --git a/app/code/Magento/MediaStorage/Helper/File/Storage/Database.php b/app/code/Magento/MediaStorage/Helper/File/Storage/Database.php
@@ -4,16 +4,16 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Database saving file helper
- *
- * @author      Magento Core Team <core@magentocommerce.com>
- */
 namespace Magento\MediaStorage\Helper\File\Storage;
 
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Filesystem;
 
+/**
+ * Database saving file helper
+ *
+ * @api
+ */
 class Database extends \Magento\Framework\App\Helper\AbstractHelper
 {
     /**

diff --git a/app/code/Magento/MediaStorage/Model/File/Storage.php b/app/code/Magento/MediaStorage/Model/File/Storage.php
@@ -14,7 +14,9 @@
 
 /**
  * Class Storage
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class Storage extends AbstractModel
 {

diff --git a/app/code/Magento/MediaStorage/Model/File/Storage/Database.php b/app/code/Magento/MediaStorage/Model/File/Storage/Database.php
@@ -7,6 +7,8 @@
 
 /**
  * Class Database
+ *
+ * @api
  */
 class Database extends \Magento\MediaStorage\Model\File\Storage\Database\AbstractDatabase
 {

diff --git a/app/code/Magento/MediaStorage/Model/File/Storage/File.php b/app/code/Magento/MediaStorage/Model/File/Storage/File.php
@@ -7,6 +7,8 @@
 
 /**
  * Class File
+ *
+ * @api
  */
 class File
 {

diff --git a/app/code/Magento/MediaStorage/Model/File/Uploader.php b/app/code/Magento/MediaStorage/Model/File/Uploader.php
@@ -4,13 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\MediaStorage\Model\File;
+
 /**
  * Core file uploader model
  *
- * @author     Magento Core Team <core@magentocommerce.com>
+ * @api
  */
-namespace Magento\MediaStorage\Model\File;
-
 class Uploader extends \Magento\Framework\File\Uploader
 {
     /**

diff --git a/app/code/Magento/Msrp/Pricing/Price/MsrpPriceInterface.php b/app/code/Magento/Msrp/Pricing/Price/MsrpPriceInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * MSRP price interface
+ *
+ * @api
  */
 interface MsrpPriceInterface
 {

diff --git a/app/code/Magento/Msrp/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js b/app/code/Magento/Msrp/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js
@@ -2,6 +2,11 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+/**
+ * @api
+ */
+
 define([
     'Magento_Tax/js/view/checkout/minicart/subtotal/totals',
     'underscore'