Merge remote-tracking branch 'api/MAGETWO-52340-Gift-Message' into pull-request

Cari Spruiell · Cari Spruiell · commit 9ba4a9f0c8c2 · 2016-05-13T15:48:44.000-05:00
diff --git a/app/code/Magento/Customer/Api/CustomerRepositoryInterface.php b/app/code/Magento/Customer/Api/CustomerRepositoryInterface.php
@@ -13,7 +13,7 @@
 interface CustomerRepositoryInterface
 {
     /**
-     * Create customer.
+     * Create or update a customer.
      *
      * @api
      * @param \Magento\Customer\Api\Data\CustomerInterface $customer
@@ -38,7 +38,7 @@ public function save(\Magento\Customer\Api\Data\CustomerInterface $customer, $pa
     public function get($email, $websiteId = null);
 
     /**
-     * Retrieve customer.
+     * Get customer by customer ID.
      *
      * @api
      * @param int $customerId
@@ -51,6 +51,10 @@ public function getById($customerId);
     /**
      * Retrieve customers which match a specified criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine
+     * which call to use to get detailed information about all attributes for an object.
+     *
      * @api
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Customer\Api\Data\CustomerSearchResultsInterface
diff --git a/app/code/Magento/Customer/Api/GroupRepositoryInterface.php b/app/code/Magento/Customer/Api/GroupRepositoryInterface.php
@@ -41,6 +41,10 @@ public function getById($id);
      * The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can
      * be filtered by tax class.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine
+     * which call to use to get detailed information about all attributes for an object.
+     *
      * @api
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Customer\Api\Data\GroupSearchResultsInterface
diff --git a/app/code/Magento/Eav/Api/AttributeSetRepositoryInterface.php b/app/code/Magento/Eav/Api/AttributeSetRepositoryInterface.php
@@ -15,6 +15,10 @@ interface AttributeSetRepositoryInterface
     /**
      * Retrieve list of Attribute Sets
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine
+     * which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Eav\Api\Data\AttributeSetSearchResultsInterface
      */
diff --git a/app/code/Magento/Quote/Api/CartRepositoryInterface.php b/app/code/Magento/Quote/Api/CartRepositoryInterface.php
@@ -23,6 +23,11 @@ public function get($cartId);
     /**
      * Enables administrative users to list carts that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included.  See http://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine
+     * which call to use to get detailed information about all attributes for an object.
+     *
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria
      * @return \Magento\Quote\Api\Data\CartSearchResultsInterface
      */
diff --git a/app/code/Magento/Quote/Api/GuestPaymentMethodManagementInterface.php b/app/code/Magento/Quote/Api/GuestPaymentMethodManagementInterface.php
@@ -35,6 +35,10 @@ public function get($cartId);
     /**
      * List available payment methods for a specified shopping cart.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included.  See http://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param string $cartId The cart ID.
      * @return \Magento\Quote\Api\Data\PaymentMethodInterface[] Array of payment methods.
      * @throws \Magento\Framework\Exception\NoSuchEntityException The specified cart does not exist.
diff --git a/app/code/Magento/Quote/Api/PaymentMethodManagementInterface.php b/app/code/Magento/Quote/Api/PaymentMethodManagementInterface.php
@@ -35,6 +35,10 @@ public function get($cartId);
     /**
      * Lists available payment methods for a specified shopping cart.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included.  See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param int $cartId The cart ID.
      * @return \Magento\Quote\Api\Data\PaymentMethodInterface[] Array of payment methods.
      * @throws \Magento\Framework\Exception\NoSuchEntityException The specified cart does not exist.
diff --git a/app/code/Magento/Sales/Api/CreditmemoRepositoryInterface.php b/app/code/Magento/Sales/Api/CreditmemoRepositoryInterface.php
@@ -18,6 +18,10 @@ interface CreditmemoRepositoryInterface
     /**
      * Lists credit memos that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria The search criteria.
      * @return \Magento\Sales\Api\Data\CreditmemoSearchResultInterface Credit memo search result interface.
      */
diff --git a/app/code/Magento/Sales/Api/InvoiceRepositoryInterface.php b/app/code/Magento/Sales/Api/InvoiceRepositoryInterface.php
@@ -16,6 +16,10 @@ interface InvoiceRepositoryInterface
     /**
      * Lists invoices that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria The search criteria.
      * @return \Magento\Sales\Api\Data\InvoiceSearchResultInterface Invoice search result interface.
      */
diff --git a/app/code/Magento/Sales/Api/OrderItemRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderItemRepositoryInterface.php
@@ -18,6 +18,10 @@ interface OrderItemRepositoryInterface
     /**
      * Lists order items that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria The search criteria.
      * @return \Magento\Sales\Api\Data\OrderItemSearchResultInterface Order item search result interface.
      */
diff --git a/app/code/Magento/Sales/Api/OrderRepositoryInterface.php b/app/code/Magento/Sales/Api/OrderRepositoryInterface.php
@@ -18,6 +18,10 @@ interface OrderRepositoryInterface
     /**
      * Lists orders that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria The search criteria.
      * @return \Magento\Sales\Api\Data\OrderSearchResultInterface Order search result interface.
      */
diff --git a/app/code/Magento/Sales/Api/ShipmentRepositoryInterface.php b/app/code/Magento/Sales/Api/ShipmentRepositoryInterface.php
@@ -17,6 +17,10 @@ interface ShipmentRepositoryInterface
     /**
      * Lists shipments that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria The search criteria.
      * @return \Magento\Sales\Api\Data\ShipmentSearchResultInterface Shipment search results interface.
      */
diff --git a/app/code/Magento/Sales/Api/TransactionRepositoryInterface.php b/app/code/Magento/Sales/Api/TransactionRepositoryInterface.php
@@ -16,6 +16,10 @@ interface TransactionRepositoryInterface
     /**
      * Lists transactions that match specified search criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria The search criteria.
      * @return \Magento\Sales\Api\Data\TransactionSearchResultInterface Transaction search result interface.
      */
diff --git a/app/code/Magento/SalesRule/Api/CouponRepositoryInterface.php b/app/code/Magento/SalesRule/Api/CouponRepositoryInterface.php
@@ -13,7 +13,7 @@
 interface CouponRepositoryInterface
 {
     /**
-     * Save coupon.
+     * Save a coupon.
      *
      * @param \Magento\SalesRule\Api\Data\CouponInterface $coupon
      * @return \Magento\SalesRule\Api\Data\CouponInterface
@@ -34,7 +34,11 @@ public function save(\Magento\SalesRule\Api\Data\CouponInterface $coupon);
     public function getById($couponId);
 
     /**
-     * Retrieve coupon.
+     * Retrieve a coupon using the specified search criteria.
+     *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
      *
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\SalesRule\Api\Data\CouponSearchResultInterface
diff --git a/app/code/Magento/SalesRule/Api/RuleRepositoryInterface.php b/app/code/Magento/SalesRule/Api/RuleRepositoryInterface.php
@@ -34,7 +34,11 @@ public function save(\Magento\SalesRule\Api\Data\RuleInterface $rule);
     public function getById($ruleId);
 
     /**
-     * Retrieve sales rules.
+     * Retrieve sales rules that match te specified criteria.
+     *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
      *
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\SalesRule\Api\Data\RuleSearchResultInterface
diff --git a/app/code/Magento/Tax/Api/TaxClassRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxClassRepositoryInterface.php
@@ -25,6 +25,10 @@ public function get($taxClassId);
     /**
      * Retrieve tax classes which match a specific criteria.
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Tax\Api\Data\TaxClassSearchResultsInterface containing Data\TaxClassInterface
      * @throws \Magento\Framework\Exception\InputException
diff --git a/app/code/Magento/Tax/Api/TaxRateRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxRateRepositoryInterface.php
@@ -45,6 +45,10 @@ public function deleteById($rateId);
     /**
      * Search TaxRates
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Tax\Api\Data\TaxRateSearchResultsInterface containing Data\TaxRateInterface objects
      * @throws \Magento\Framework\Exception\InputException If there is a problem with the input
diff --git a/app/code/Magento/Tax/Api/TaxRuleRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxRuleRepositoryInterface.php
@@ -53,6 +53,10 @@ public function deleteById($ruleId);
     /**
      * Search TaxRules
      *
+     * This call returns an array of objects, but detailed information about each object’s attributes might not be
+     * included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to
+     * determine which call to use to get detailed information about all attributes for an object.
+     *
      * @param \Magento\Framework\Api\SearchCriteria $searchCriteria
      * @return \Magento\Tax\Api\Data\TaxRuleSearchResultsInterface containing TaxRuleInterface objects
      * @throws \Magento\Framework\Exception\InputException If there is a problem with the input
