Mark Framework interfaces as API part 1

mrtuvn · mrtuvn · commit 61f8d7ea1050 · 2021-04-03T09:04:34.000+07:00
update
diff --git a/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php b/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Exchange binding installer.
+ *
+ * @api
  */
 interface BindingInstallerInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php b/lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php
@@ -7,8 +7,9 @@
 namespace Magento\Framework\Api;
 
 /**
- * Interface \Magento\Framework\Api\AttributeTypeResolverInterface
+ * Interface Attribute Type Resolver
  *
+ * @api
  */
 interface AttributeTypeResolverInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/CriteriaInterface.php b/lib/internal/Magento/Framework/Api/CriteriaInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface CriteriaInterface
+ *
+ * @api
  */
 interface CriteriaInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php b/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php
@@ -6,7 +6,9 @@
 namespace Magento\Framework\Api\Search;
 
 /**
- * Faceted data
+ * Interface Aggregation fo get faceted data
+ *
+ * @api
  */
 interface AggregationInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php b/lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php
@@ -6,8 +6,9 @@
 namespace Magento\Framework\Api\Search;
 
 /**
- * Interface \Magento\Framework\Api\Search\AggregationValueInterface
+ * Interface Aggregation Value
  *
+ * @api
  */
 interface AggregationValueInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/Search/BucketInterface.php b/lib/internal/Magento/Framework/Api/Search/BucketInterface.php
@@ -6,7 +6,9 @@
 namespace Magento\Framework\Api\Search;
 
 /**
- * Facet Bucket
+ * Interface for facet Bucket
+ *
+ * @api
  */
 interface BucketInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/Search/DocumentInterface.php b/lib/internal/Magento/Framework/Api/Search/DocumentInterface.php
@@ -8,8 +8,9 @@
 use Magento\Framework\Api\CustomAttributesDataInterface;
 
 /**
- * Interface \Magento\Framework\Api\Search\DocumentInterface
+ * Interface Search Document
  *
+ * @api
  */
 interface DocumentInterface extends CustomAttributesDataInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/Search/ReportingInterface.php b/lib/internal/Magento/Framework/Api/Search/ReportingInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface ReportingInterface
+ *
+ * @api
  */
 interface ReportingInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php b/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php
@@ -23,6 +23,7 @@
  *          AND
  *          (CustomCondition_2 OR CustomCondition_3)
  *
+ * @api
  */
 interface CustomConditionInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php b/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php
@@ -15,6 +15,8 @@
  *
  * Used to store processors as mapping attributeName => CustomConditionInterface
  * You can use di.xml to configure with any custom conditions you need
+ *
+ * @api
  */
 interface CustomConditionProviderInterface
 {
diff --git a/lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php b/lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Base Builder interface for simple data Objects
+ *
+ * @api
  */
 interface SimpleBuilderInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing CONNECT requests.
+ *
+ * @api
  */
 interface HttpConnectActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing DELETE requests.
+ *
+ * @api
  */
 interface HttpDeleteActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Marker for actions processing GET requests.
+ *
+ * @api
  */
 interface HttpGetActionInterface extends HttpHeadActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing OPTIONS requests.
+ *
+ * @api
  */
 interface HttpOptionsActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing PATCH requests.
+ *
+ * @api
  */
 interface HttpPatchActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing POST requests.
+ *
+ * @api
  */
 interface HttpPostActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing PROPFIND requests.
+ *
+ * @api
  */
 interface HttpPropfindActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing PUT requests.
+ *
+ * @api
  */
 interface HttpPutActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Marker for actions processing TRACE requests.
+ *
+ * @api
  */
 interface HttpTraceActionInterface extends ActionInterface
 {
diff --git a/lib/internal/Magento/Framework/App/AreaInterface.php b/lib/internal/Magento/Framework/App/AreaInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Interface AreaInterface
+ *
+ * @api
  */
 interface AreaInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/CommentInterface.php b/lib/internal/Magento/Framework/App/Config/CommentInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface CommentInterface
+ *
+ * @api
  */
 interface CommentInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php b/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface for parsing comments in the configuration file.
+ *
+ * @api
  */
 interface CommentParserInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php b/lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Resource for storing store configuration values
+ *
+ * @api
  */
 interface ConfigInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php b/lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface ConfigSourceInterface
+ *
+ * @api
  */
 interface ConfigSourceInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php b/lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface ConfigTypeInterface
+ *
+ * @api
  */
 interface ConfigTypeInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php b/lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php
@@ -9,6 +9,7 @@
  * Provide access to data. Each Source can be responsible for each storage, where config data can be placed
  *
  * @package Magento\Framework\App\Config\Reader\Source
+ * @api
  */
 interface SourceInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php b/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php
@@ -10,6 +10,7 @@
 /**
  * Interface \Magento\Framework\App\Config\Scope\ReaderInterface
  *
+ * @api
  */
 interface ReaderInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php b/lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php
@@ -14,6 +14,7 @@
  * @see SourceInterface
  * @see ConfigTypeInterface
  * @package Magento\Framework\App\Config\Spi
+ * @api
  */
 interface PostProcessorInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php b/lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Allows to use custom callbacks and functions before applying fallback
+ *
+ * @api
  */
 interface PreProcessorInterface
 {
diff --git a/lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php b/lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Instances of this interface represent config binging items declared in etc/queue_topology.xsd
+ *
+ * @api
  */
 interface BindingInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Exchange binding installer.`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`interface BindingInstallerInterface`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,9 @@`
`7`	`7`	`namespace Magento\Framework\Api;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * Interface \Magento\Framework\Api\AttributeTypeResolverInterface`
	`10`	`+ * Interface Attribute Type Resolver`
`11`	`11`	`*`
	`12`	`+ * @api`
`12`	`13`	`*/`
`13`	`14`	`interface AttributeTypeResolverInterface`
`14`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface CriteriaInterface`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`interface CriteriaInterface`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,9 @@`
`6`	`6`	`namespace Magento\Framework\Api\Search;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * Interface \Magento\Framework\Api\Search\AggregationValueInterface`
	`9`	`+ * Interface Aggregation Value`
`10`	`10`	`*`
	`11`	`+ * @api`
`11`	`12`	`*/`
`12`	`13`	`interface AggregationValueInterface`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,9 @@`
`8`	`8`	`use Magento\Framework\Api\CustomAttributesDataInterface;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Interface \Magento\Framework\Api\Search\DocumentInterface`
	`11`	`+ * Interface Search Document`
`12`	`12`	`*`
	`13`	`+ * @api`
`13`	`14`	`*/`
`14`	`15`	`interface DocumentInterface extends CustomAttributesDataInterface`
`15`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface ReportingInterface`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`interface ReportingInterface`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`* AND`
`24`	`24`	`* (CustomCondition_2 OR CustomCondition_3)`
`25`	`25`	`*`
	`26`	`+ * @api`
`26`	`27`	`*/`
`27`	`28`	`interface CustomConditionInterface`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`*`
`16`	`16`	`* Used to store processors as mapping attributeName => CustomConditionInterface`
`17`	`17`	`* You can use di.xml to configure with any custom conditions you need`
	`18`	`+ *`
	`19`	`+ * @api`
`18`	`20`	`*/`
`19`	`21`	`interface CustomConditionProviderInterface`
`20`	`22`	`{`