Mark Framework GraphQL interfaces as API

mrtuvn · mrtuvn · commit 3ec2374d50b0 · 2021-04-22T19:02:10.000+07:00
update


update


update


update


update


Update TypeMetaReaderInterface.php

Revert change the return type of this function
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/ConfigElementFactoryInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/ConfigElementFactoryInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Responsible for translating data produced by configuration readers to config objects
+ *
+ * @api
  */
 interface ConfigElementFactoryInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/ConfigElementInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/ConfigElementInterface.php
@@ -9,16 +9,18 @@
 
 /**
  * GraphQL config element.
+ *
+ * @api
  */
 interface ConfigElementInterface
 {
     /**
      * @return string
      */
-    public function getName() : string;
+    public function getName(): string;
 
     /**
      * @return string
      */
-    public function getDescription() : string;
+    public function getDescription(): string;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/Field.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/Field.php
@@ -11,6 +11,8 @@
  * Class representing 'field' GraphQL config element.
  *
  * Fields are used to describe possible values for a type/interface.
+ *
+ * @api
  */
 class Field implements OutputFieldInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/FieldInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/FieldInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Defines contract for fields data as GraphQL objects.
+ *
+ * @api
  */
 interface FieldInterface extends ConfigElementInterface
 {
@@ -19,7 +21,7 @@ interface FieldInterface extends ConfigElementInterface
      *
      * @return string
      */
-    public function getTypeName() : string;
+    public function getTypeName(): string;
 
     /**
      * Return true if argument is a list of input items, otherwise false if it is a single object/scalar.
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/OutputFieldInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/OutputFieldInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Defines contract for output fields data as GraphQL objects.
+ *
+ * @api
  */
 interface OutputFieldInterface extends FieldInterface
 {
@@ -17,12 +19,12 @@ interface OutputFieldInterface extends FieldInterface
      *
      * @return string
      */
-    public function getResolver() : string;
+    public function getResolver(): string;
 
     /**
      * Get the list of arguments configured for the field. Return an empty array if no arguments are configured.
      *
      * @return Argument[]
      */
-    public function getArguments() : array;
+    public function getArguments(): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/TypeInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/TypeInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Defines contracts for return type data as GraphQL objects.
+ *
+ * @api
  */
 interface TypeInterface extends ConfigElementInterface
 {
@@ -19,5 +21,5 @@ interface TypeInterface extends ConfigElementInterface
      *
      * @return Field[]
      */
-    public function getFields() : array;
+    public function getFields(): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/UnionInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/UnionInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Defines the contract for the union configuration data type.
+ *
+ * @api
  */
 interface UnionInterface extends ConfigElementInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/ConfigInterface.php b/lib/internal/Magento/Framework/GraphQl/ConfigInterface.php
@@ -11,8 +11,9 @@
 
 /**
  * Access all GraphQL type information declared in the schema's configuration.
- *
  * Data includes types, interfaces they implement, their arguments, and fields.
+ *
+ * @api
  */
 interface ConfigInterface
 {
@@ -22,7 +23,7 @@ interface ConfigInterface
      * @param string $configElementName
      * @return ConfigElementInterface
      */
-    public function getConfigElement(string $configElementName) : ConfigElementInterface;
+    public function getConfigElement(string $configElementName): ConfigElementInterface;
 
     /**
      * Return all type names declared in a GraphQL schema's configuration and their type.
@@ -31,5 +32,5 @@ public function getConfigElement(string $configElementName) : ConfigElementInter
      *
      * @return array $types
      */
-    public function getDeclaredTypes() : array;
+    public function getDeclaredTypes(): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/ErrorHandlerInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/ErrorHandlerInterface.php
@@ -14,6 +14,7 @@
  *
  * GraphQL error handler
  *
+ * @api
  * @see \Magento\Framework\GraphQl\Query\QueryProcessor
  */
 interface ErrorHandlerInterface
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/Argument/FieldEntityAttributesInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/Argument/FieldEntityAttributesInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Contract for the classes that retrieve attributes for a given entity configured in @see FieldEntityAttributesPool.
+ *
+ * @api
  */
 interface FieldEntityAttributesInterface
 {
@@ -17,5 +19,5 @@ interface FieldEntityAttributesInterface
      *
      * @return array
      */
-    public function getEntityAttributes() : array;
+    public function getEntityAttributes(): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/Argument/SearchCriteria/ArgumentApplierInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/Argument/SearchCriteria/ArgumentApplierInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Interface used to apply each argument to a search criteria
+ *
+ * @api
  */
 interface ArgumentApplierInterface
 {
@@ -28,5 +30,5 @@ public function applyArgument(
         string $fieldName,
         string $argumentName,
         array $argument
-    ) : SearchCriteriaInterface;
+    ): SearchCriteriaInterface;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchRequestItemInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchRequestItemInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * One of requests for a batch resolver to process.
+ *
+ * @api
  */
 interface BatchRequestItemInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchResolverInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchResolverInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Resolve multiple requests of the same field gathered by GraphQL.
+ *
+ * @api
  */
 interface BatchResolverInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchResponse.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchResponse.php
@@ -9,6 +9,8 @@
 
 /**
  * Contains responses for batch requests.
+ *
+ * @api
  */
 class BatchResponse
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchServiceContractResolverInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/BatchServiceContractResolverInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Resolve multiple brunches/leaves by executing a batch service contract.
+ *
+ * @api
  */
 interface BatchServiceContractResolverInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/ContextInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/ContextInterface.php
@@ -14,6 +14,8 @@
  *
  * GraphQL will pass the same instance of this interface to each field resolver, so these resolvers could have
  * shared access to the same data for ease of implementation purposes.
+ *
+ * @api
  */
 interface ContextInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/IdentityInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/IdentityInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * IdentityInterface is responsible for generating the proper tags from a cache tag and resolved data.
+ *
+ * @api
  */
 interface IdentityInterface
 {
@@ -21,5 +23,5 @@ interface IdentityInterface
      * @param array $resolvedData
      * @return string[]
      */
-    public function getIdentities(array $resolvedData) : array;
+    public function getIdentities(array $resolvedData): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/ResolveRequestInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/ResolveRequestInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Request for a resolver.
+ *
+ * @api
  */
 interface ResolveRequestInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/TypeResolverInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/TypeResolverInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Determines a concrete GraphQL type for data returned that implements an interface type.
+ *
+ * @api
  */
 interface TypeResolverInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Resolver/Value.php b/lib/internal/Magento/Framework/GraphQl/Query/Resolver/Value.php
@@ -11,6 +11,8 @@
 
 /**
  * Return value for @see ResolverInterface
+ *
+ * @api
  */
 class Value extends \GraphQL\Deferred
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/ResolverInterface.php b/lib/internal/Magento/Framework/GraphQl/Query/ResolverInterface.php
@@ -14,6 +14,8 @@
 
 /**
  * Resolver fetches the data and formats it according to the GraphQL schema.
+ *
+ * @api
  */
 interface ResolverInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema.php b/lib/internal/Magento/Framework/GraphQl/Schema.php
@@ -9,6 +9,8 @@
 
 /**
  * Schema object for a GraphQL endpoint describing queries and types for a client to consume.
+ *
+ * @api
  */
 class Schema extends \GraphQL\Type\Schema
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/SchemaGeneratorInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/SchemaGeneratorInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * GraphQL schema generator interface.
+ *
+ * @api
  */
 interface SchemaGeneratorInterface
 {
@@ -19,5 +21,5 @@ interface SchemaGeneratorInterface
      *
      * @return Schema
      */
-    public function generate() : Schema;
+    public function generate(): Schema;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/Entity/MapperInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/Entity/MapperInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Produces mapped GraphQL type names to their respective entity models.
+ *
+ * @api
  */
 interface MapperInterface
 {
@@ -18,5 +20,5 @@ interface MapperInterface
      * @param string $entityName
      * @return string[]
      */
-    public function getMappedTypes(string $entityName) : array;
+    public function getMappedTypes(string $entityName): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/Enum/DataMapperInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/Enum/DataMapperInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Produces mapped name to values for the Enum types to be map them against the data that comes from a database.
+ *
+ * @api
  */
 interface DataMapperInterface
 {
@@ -18,5 +20,5 @@ interface DataMapperInterface
      * @param string $enumName
      * @return string[]
      */
-    public function getMappedEnums(string $enumName) : array;
+    public function getMappedEnums(string $enumName): array;
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/InputTypeInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/InputTypeInterface.php
@@ -11,8 +11,9 @@
 
 /**
  * Interface for GraphQl InputType only used for input
+ *
+ * @api
  */
 interface InputTypeInterface extends \GraphQL\Type\Definition\InputType, TypeInterface
 {
-
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/Output/ElementMapper/FormatterInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/Output/ElementMapper/FormatterInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Converter of GraphQL config elements to the objects compatible with GraphQL schema generator.
+ *
+ * @api
  */
 interface FormatterInterface
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/OutputTypeInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/OutputTypeInterface.php
@@ -11,8 +11,9 @@
 
 /**
  * Interface for GraphQl OutputType only used for output
+ *
+ * @api
  */
 interface OutputTypeInterface extends \GraphQL\Type\Definition\OutputType, TypeInterface
 {
-
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/ResolveInfo.php
@@ -9,6 +9,8 @@
 
 /**
  * Wrapper for GraphQl ResolveInfo
+ *
+ * @api
  */
 class ResolveInfo extends \GraphQL\Type\Definition\ResolveInfo
 {
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/WrappedTypeInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/WrappedTypeInterface.php
@@ -11,8 +11,9 @@
 
 /**
  * Interface for GraphQl WrappedType used to wrap other types like array or not null
+ *
+ * @api
  */
 interface WrappedTypeInterface extends \GraphQL\Type\Definition\WrappingType, TypeInterface
 {
-
 }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/TypeInterface.php b/lib/internal/Magento/Framework/GraphQl/Schema/TypeInterface.php
@@ -9,8 +9,9 @@
 
 /**
  * Marker interface for all types compatible with GraphQL schema generator.
+ *
+ * @api
  */
 interface TypeInterface
 {
-
 }
diff --git a/lib/internal/Magento/Framework/GraphQlSchemaStitching/GraphQlReader/TypeMetaReaderInterface.php b/lib/internal/Magento/Framework/GraphQlSchemaStitching/GraphQlReader/TypeMetaReaderInterface.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Responsible for translating data produced by configuration readers to config objects`
	`12`	`+ *`
	`13`	`+ * @api`
`12`	`14`	`*/`
`13`	`15`	`interface ConfigElementFactoryInterface`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`* Class representing 'field' GraphQL config element.`
`12`	`12`	`*`
`13`	`13`	`* Fields are used to describe possible values for a type/interface.`
	`14`	`+ *`
	`15`	`+ * @api`
`14`	`16`	`*/`
`15`	`17`	`class Field implements OutputFieldInterface`
`16`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`*`
`15`	`15`	`* GraphQL error handler`
`16`	`16`	`*`
	`17`	`+ * @api`
`17`	`18`	`* @see \Magento\Framework\GraphQl\Query\QueryProcessor`
`18`	`19`	`*/`
`19`	`20`	`interface ErrorHandlerInterface`