diff --git a/lib/internal/Magento/Framework/GraphQl/Config/ConfigElementFactoryInterface.php b/lib/internal/Magento/Framework/GraphQl/Config/ConfigElementFactoryInterface.php index 660907a33cc23..1c3b556a8811c 100644 --- 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 index 531e9bb0d5dc0..c28fae8fd6086 100644 --- 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 index 0b1b8ae3da31b..757e6c4d569ab 100644 --- 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 index a184080ff49e1..53a8c5d96c74a 100644 --- 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 index c05e801848a5e..6161c2ca83497 100644 --- 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 index 1ba796fb97bd2..08863bb62b92e 100644 --- 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 index 2d557e6dc5b84..e41c01e9934fd 100644 --- 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 index f7d6cf49e180c..de6c2c92de858 100644 --- 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 index 09fd44c19315d..572fa6969dc57 100644 --- 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 index b8e52eb394585..212cd98a6d400 100644 --- 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 index ee6eb4107e31a..2a5e892125331 100644 --- 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 index a3152496024af..19911499aebe7 100644 --- 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 index d0b4779f74b39..366645104cf40 100644 --- 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 index 887db448c039e..da7548bb1f473 100644 --- 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 index cb983e69bc638..b52962e24be2a 100644 --- 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 index 7cece8dd7e39b..b18ae5d97087f 100644 --- 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 index 943cd63417399..054fed5f1b61f 100644 --- 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 index cf5e216f5f9de..9812f1301a909 100644 --- 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 index fc078a0ab184f..dfe8f8b50949c 100644 --- 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 index 7468511ae7f7a..af6ca5a93b7ab 100644 --- 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 index c7b4c7688b9ab..758f31137dd87 100644 --- 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 index b0a70d680e86b..33b89d019065b 100644 --- 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 index bbd69fd14d03a..3b39ff7ed36e8 100644 --- 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 index a8002770f0513..062b8b08fd9a8 100644 --- 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 index 832a6177be73b..9722b90bd0539 100644 --- 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 index 7a68bd764ee0c..f6e9c93c47687 100644 --- 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 index a99237aa8843a..8b53bf9326c9c 100644 --- 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 index 561c65e4cd82a..d226702167015 100644 --- 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 index fe479c9a0bae6..19f573a3c28ae 100644 --- 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 index 3b18dc15f4811..1685ec6b9e8d0 100644 --- 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 index 3f93aa38e1b7d..0106ee009b70d 100644 --- 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 index 3a73be5fdda2e..77f492c6a64b9 100644 --- a/lib/internal/Magento/Framework/GraphQlSchemaStitching/GraphQlReader/TypeMetaReaderInterface.php +++ b/lib/internal/Magento/Framework/GraphQlSchemaStitching/GraphQlReader/TypeMetaReaderInterface.php @@ -9,6 +9,8 @@ /** * Reads and returns metadata as array for a specific type if it finds an adequate implementation for that type + * + * @api */ interface TypeMetaReaderInterface { @@ -18,5 +20,5 @@ interface TypeMetaReaderInterface * @param \GraphQL\Type\Definition\Type $typeMeta * @return array|null */ - public function read(\GraphQL\Type\Definition\Type $typeMeta) : array; + public function read(\GraphQL\Type\Definition\Type $typeMeta): array; }