MAGETWO-53850: API interfaces lack @api annotation

mslabko · mslabko · commit 0bbf590bdb2b · 2016-06-04T21:46:04.000+03:00
diff --git a/app/code/Magento/Catalog/Api/AttributeSetFinderInterface.php b/app/code/Magento/Catalog/Api/AttributeSetFinderInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Catalog\Api;
 
+/**
+ * Interface AttributeSetFinderInterface
+ * @api
+ */
 interface AttributeSetFinderInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Api/Data/CategoryProductSearchResultInterface.php b/app/code/Magento/Catalog/Api/Data/CategoryProductSearchResultInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Catalog\Api\Data;
 
+/**
+ * Interface CategoryProductSearchResultInterface
+ * @api
+ */
 interface CategoryProductSearchResultInterface extends \Magento\Framework\Api\SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Api/Data/ProductOptionInterface.php b/app/code/Magento/Catalog/Api/Data/ProductOptionInterface.php
@@ -9,6 +9,7 @@
 
 /**
  * Product option interface
+ * @api
  */
 interface ProductOptionInterface extends ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Catalog/Api/ProductWebsiteLinkRepositoryInterface.php b/app/code/Magento/Catalog/Api/ProductWebsiteLinkRepositoryInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Catalog\Api;
 
+/**
+ * Interface ProductWebsiteLinkRepositoryInterface
+ * @api
+ */
 interface ProductWebsiteLinkRepositoryInterface
 {
     /**
diff --git a/app/code/Magento/Checkout/Api/AgreementsValidatorInterface.php b/app/code/Magento/Checkout/Api/AgreementsValidatorInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface AgreementsValidatorInterface
+ * @api
  */
 interface AgreementsValidatorInterface
 {
diff --git a/app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php b/app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Checkout\Api\Data;
 
+/**
+ * Interface PaymentDetailsInterface
+ * @api
+ */
 interface PaymentDetailsInterface
 {
     /**#@+
diff --git a/app/code/Magento/Checkout/Api/Data/ShippingInformationInterface.php b/app/code/Magento/Checkout/Api/Data/ShippingInformationInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Checkout\Api\Data;
 
+/**
+ * Interface ShippingInformationInterface
+ * @api
+ */
 interface ShippingInformationInterface extends \Magento\Framework\Api\CustomAttributesDataInterface
 {
     /**#@+
diff --git a/app/code/Magento/Checkout/Api/Data/TotalsInformationInterface.php b/app/code/Magento/Checkout/Api/Data/TotalsInformationInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Checkout\Api\Data;
 
+/**
+ * Interface TotalsInformationInterface
+ * @api
+ */
 interface TotalsInformationInterface extends \Magento\Framework\Api\CustomAttributesDataInterface
 {
     /**#@+
diff --git a/app/code/Magento/Checkout/Api/GuestTotalsInformationManagementInterface.php b/app/code/Magento/Checkout/Api/GuestTotalsInformationManagementInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface for guest quote totals calculation
+ * @api
  */
 interface GuestTotalsInformationManagementInterface
 {
diff --git a/app/code/Magento/Checkout/Api/TotalsInformationManagementInterface.php b/app/code/Magento/Checkout/Api/TotalsInformationManagementInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface for quote totals calculation
+ * @api
  */
 interface TotalsInformationManagementInterface
 {
diff --git a/app/code/Magento/CheckoutAgreements/Api/Data/AgreementInterface.php b/app/code/Magento/CheckoutAgreements/Api/Data/AgreementInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\CheckoutAgreements\Api\Data;
 
+/**
+ * Interface AgreementInterface
+ * @api
+ */
 interface AgreementInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**#@+
diff --git a/app/code/Magento/ConfigurableProduct/Api/Data/OptionInterface.php b/app/code/Magento/ConfigurableProduct/Api/Data/OptionInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\ConfigurableProduct\Api\Data;
 
+/**
+ * Interface OptionInterface
+ * @api
+ */
 interface OptionInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Api/Data/OptionValueInterface.php b/app/code/Magento/ConfigurableProduct/Api/Data/OptionValueInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\ConfigurableProduct\Api\Data;
 
+/**
+ * Interface OptionValueInterface
+ * @api
+ */
 interface OptionValueInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Customer/Api/AddressMetadataInterface.php b/app/code/Magento/Customer/Api/AddressMetadataInterface.php
@@ -8,6 +8,7 @@
 
 /**
  * Interface for retrieval information about customer address attributes metadata.
+ * @api
  */
 interface AddressMetadataInterface extends MetadataInterface
 {
diff --git a/app/code/Magento/Customer/Api/AddressMetadataManagementInterface.php b/app/code/Magento/Customer/Api/AddressMetadataManagementInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface for managing customer address attributes metadata.
+ * @api
  */
 interface AddressMetadataManagementInterface extends MetadataManagementInterface
 {
diff --git a/app/code/Magento/Customer/Api/CustomerMetadataInterface.php b/app/code/Magento/Customer/Api/CustomerMetadataInterface.php
@@ -8,6 +8,7 @@
 
 /**
  * Interface for retrieval information about customer attributes metadata.
+ * @api
  */
 interface CustomerMetadataInterface extends MetadataInterface
 {
diff --git a/app/code/Magento/Customer/Api/CustomerMetadataManagementInterface.php b/app/code/Magento/Customer/Api/CustomerMetadataManagementInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface for managing customer attributes metadata.
+ * @api
  */
 interface CustomerMetadataManagementInterface extends MetadataManagementInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/Data/DownloadableOptionInterface.php b/app/code/Magento/Downloadable/Api/Data/DownloadableOptionInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Downloadable Option
+ * @api
  */
 interface DownloadableOptionInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/Data/File/ContentInterface.php b/app/code/Magento/Downloadable/Api/Data/File/ContentInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * @codeCoverageIgnore
+ * @api
  */
 interface ContentInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/Data/File/ContentUploaderInterface.php b/app/code/Magento/Downloadable/Api/Data/File/ContentUploaderInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * @codeCoverageIgnore
+ * @api
  */
 interface ContentUploaderInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/Data/LinkInterface.php b/app/code/Magento/Downloadable/Api/Data/LinkInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * @codeCoverageIgnore
+ * @api
  */
 interface LinkInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/Data/ProductAttributeInterface.php b/app/code/Magento/Downloadable/Api/Data/ProductAttributeInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface ProductAttributeInterface
+ * @api
  */
 interface ProductAttributeInterface extends \Magento\Catalog\Api\Data\ProductAttributeInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/Data/SampleInterface.php b/app/code/Magento/Downloadable/Api/Data/SampleInterface.php
@@ -9,6 +9,7 @@
 
 /**
  * @codeCoverageIgnore
+ * @api
  */
 interface SampleInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Downloadable/Api/LinkRepositoryInterface.php b/app/code/Magento/Downloadable/Api/LinkRepositoryInterface.php
@@ -11,6 +11,7 @@
 /**
  * Interface LinkRepositoryInterface
  * @package Magento\Downloadable\Api
+ * @api
  */
 interface LinkRepositoryInterface
 {
diff --git a/app/code/Magento/Eav/Api/Data/AttributeFrontendLabelInterface.php b/app/code/Magento/Eav/Api/Data/AttributeFrontendLabelInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeFrontendLabelInterface
+ * @api
+ */
 interface AttributeFrontendLabelInterface extends AttributeOptionLabelInterface
 {
 }
diff --git a/app/code/Magento/Eav/Api/Data/AttributeGroupInterface.php b/app/code/Magento/Eav/Api/Data/AttributeGroupInterface.php
@@ -7,6 +7,10 @@
 
 use Magento\Framework\Api\ExtensibleDataInterface;
 
+/**
+ * Interface AttributeGroupInterface
+ * @api
+ */
 interface AttributeGroupInterface extends ExtensibleDataInterface
 {
     const GROUP_ID = 'attribute_group_id';
diff --git a/app/code/Magento/Eav/Api/Data/AttributeGroupSearchResultsInterface.php b/app/code/Magento/Eav/Api/Data/AttributeGroupSearchResultsInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeGroupSearchResultsInterface
+ * @api
+ */
 interface AttributeGroupSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Eav/Api/Data/AttributeInterface.php b/app/code/Magento/Eav/Api/Data/AttributeInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeInterface
+ * @api
+ */
 interface AttributeInterface extends \Magento\Framework\Api\CustomAttributesDataInterface
 {
     const ATTRIBUTE_ID = 'attribute_id';
diff --git a/app/code/Magento/Eav/Api/Data/AttributeOptionInterface.php b/app/code/Magento/Eav/Api/Data/AttributeOptionInterface.php
@@ -9,6 +9,7 @@
 /**
  * Created from:
  * @codeCoverageIgnore
+ * @api
  */
 interface AttributeOptionInterface
 {
diff --git a/app/code/Magento/Eav/Api/Data/AttributeOptionLabelInterface.php b/app/code/Magento/Eav/Api/Data/AttributeOptionLabelInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeOptionLabelInterface
+ * @api
+ */
 interface AttributeOptionLabelInterface
 {
     const LABEL = 'label';
diff --git a/app/code/Magento/Eav/Api/Data/AttributeSearchResultsInterface.php b/app/code/Magento/Eav/Api/Data/AttributeSearchResultsInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeSearchResultsInterface
+ * @api
+ */
 interface AttributeSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Eav/Api/Data/AttributeSetInterface.php b/app/code/Magento/Eav/Api/Data/AttributeSetInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeSetInterface
+ * @api
+ */
 interface AttributeSetInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Eav/Api/Data/AttributeSetSearchResultsInterface.php b/app/code/Magento/Eav/Api/Data/AttributeSetSearchResultsInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeSetSearchResultsInterface
+ * @api
+ */
 interface AttributeSetSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
 {
     /**
diff --git a/app/code/Magento/Eav/Api/Data/AttributeValidationRuleInterface.php b/app/code/Magento/Eav/Api/Data/AttributeValidationRuleInterface.php
@@ -6,6 +6,10 @@
  */
 namespace Magento\Eav\Api\Data;
 
+/**
+ * Interface AttributeValidationRuleInterface
+ * @api
+ */
 interface AttributeValidationRuleInterface extends \Magento\Framework\DataObject\KeyValueObjectInterface
 {
 }
diff --git a/app/code/Magento/GiftMessage/Api/Data/MessageInterface.php b/app/code/Magento/GiftMessage/Api/Data/MessageInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\GiftMessage\Api\Data;
 
+/**
+ * Interface MessageInterface
+ * @api
+ */
 interface MessageInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**#@+
diff --git a/app/code/Magento/Quote/Api/CartTotalManagementInterface.php b/app/code/Magento/Quote/Api/CartTotalManagementInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Bundled API to collect totals for cart based on shipping/payment methods and additional data.
+ * @api
  */
 interface CartTotalManagementInterface
 {
diff --git a/app/code/Magento/Quote/Api/Data/AddressAdditionalDataInterface.php b/app/code/Magento/Quote/Api/Data/AddressAdditionalDataInterface.php
@@ -9,6 +9,7 @@
 
 /**
  * Additional data that is provided with quote address information
+ * @api
  */
 interface AddressAdditionalDataInterface extends CustomAttributesDataInterface
 {
diff --git a/app/code/Magento/Quote/Api/Data/ProductOptionInterface.php b/app/code/Magento/Quote/Api/Data/ProductOptionInterface.php
@@ -9,6 +9,7 @@
 
 /**
  * Product option interface
+ * @api
  */
 interface ProductOptionInterface extends ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Quote/Api/Data/ShippingAssignmentInterface.php b/app/code/Magento/Quote/Api/Data/ShippingAssignmentInterface.php
@@ -8,6 +8,7 @@
 
 /**
  * Interface ShippingAssignmentInterface
+ * @api
  */
 interface ShippingAssignmentInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
diff --git a/app/code/Magento/Quote/Api/Data/ShippingInterface.php b/app/code/Magento/Quote/Api/Data/ShippingInterface.php
@@ -6,6 +6,10 @@
 
 namespace Magento\Quote\Api\Data;
 
+/**
+ * Interface ShippingInterface
+ * @api
+ */
 interface ShippingInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
     /**
diff --git a/app/code/Magento/Quote/Api/Data/TotalsAdditionalDataInterface.php b/app/code/Magento/Quote/Api/Data/TotalsAdditionalDataInterface.php
@@ -9,6 +9,7 @@
 
 /**
  * Additional data for totals collection.
+ * @api
  */
 interface TotalsAdditionalDataInterface extends CustomAttributesDataInterface
 {
diff --git a/app/code/Magento/Quote/Api/GuestCartTotalManagementInterface.php b/app/code/Magento/Quote/Api/GuestCartTotalManagementInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Bundled API to collect totals for cart based on shipping/payment methods and additional data.
+ * @api
  */
 interface GuestCartTotalManagementInterface
 {
diff --git a/app/code/Magento/Sales/Api/Data/ShippingAssignmentInterface.php b/app/code/Magento/Sales/Api/Data/ShippingAssignmentInterface.php
diff --git a/app/code/Magento/Sales/Api/Data/ShippingInterface.php b/app/code/Magento/Sales/Api/Data/ShippingInterface.php
diff --git a/app/code/Magento/Sales/Api/Data/TotalInterface.php b/app/code/Magento/Sales/Api/Data/TotalInterface.php
diff --git a/app/code/Magento/Search/Api/SearchInterface.php b/app/code/Magento/Search/Api/SearchInterface.php
diff --git a/app/code/Magento/Tax/Api/Data/GrandTotalDetailsInterface.php b/app/code/Magento/Tax/Api/Data/GrandTotalDetailsInterface.php
diff --git a/app/code/Magento/Tax/Api/Data/GrandTotalRatesInterface.php b/app/code/Magento/Tax/Api/Data/GrandTotalRatesInterface.php
diff --git a/app/code/Magento/Tax/Api/Data/OrderTaxDetailsAppliedTaxInterface.php b/app/code/Magento/Tax/Api/Data/OrderTaxDetailsAppliedTaxInterface.php
diff --git a/app/code/Magento/Tax/Api/Data/OrderTaxDetailsInterface.php b/app/code/Magento/Tax/Api/Data/OrderTaxDetailsInterface.php
diff --git a/app/code/Magento/Tax/Api/Data/OrderTaxDetailsItemInterface.php b/app/code/Magento/Tax/Api/Data/OrderTaxDetailsItemInterface.php
diff --git a/app/code/Magento/Tax/Api/OrderTaxManagementInterface.php b/app/code/Magento/Tax/Api/OrderTaxManagementInterface.php
diff --git a/dev/tests/static/testsuite/Magento/Test/Integrity/ApiAnnotationTest.php b/dev/tests/static/testsuite/Magento/Test/Integrity/ApiAnnotationTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Product option interface`
	`12`	`+ * @api`
`12`	`13`	`*/`
`13`	`14`	`interface ProductOptionInterface extends ExtensibleDataInterface`
`14`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,10 @@`
`6`	`6`
`7`	`7`	`namespace Magento\Catalog\Api;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * Interface ProductWebsiteLinkRepositoryInterface`
	`11`	`+ * @api`
	`12`	`+ */`
`9`	`13`	`interface ProductWebsiteLinkRepositoryInterface`
`10`	`14`	`{`
`11`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface AgreementsValidatorInterface`
	`10`	`+ * @api`
`10`	`11`	`*/`
`11`	`12`	`interface AgreementsValidatorInterface`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface for guest quote totals calculation`
	`10`	`+ * @api`
`10`	`11`	`*/`
`11`	`12`	`interface GuestTotalsInformationManagementInterface`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface for quote totals calculation`
	`10`	`+ * @api`
`10`	`11`	`*/`
`11`	`12`	`interface TotalsInformationManagementInterface`
`12`	`13`	`{`