chore: subtree component descriptions

soyuka · soyuka · commit 32242a216f76 · 2023-09-13T16:23:41.000+02:00
diff --git a/src/Action/ExceptionAction.php b/src/Action/ExceptionAction.php
@@ -16,9 +16,9 @@
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
-use ApiPlatform\Util\ErrorFormatGuesser;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
+use ApiPlatform\Util\ErrorFormatGuesser;
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
diff --git a/src/Api/QueryParameterValidator/Validator/Required.php b/src/Api/QueryParameterValidator/Validator/Required.php
@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Api\QueryParameterValidator\Validator;
 
-use ApiPlatform\Util\RequestParser;
+use ApiPlatform\State\Util\RequestParser;
 
 final class Required implements ValidatorInterface
 {
diff --git a/src/Elasticsearch/composer.json b/src/Elasticsearch/composer.json
@@ -1,10 +1,11 @@
 {
     "name": "api-platform/elasticseach",
-    "description": "Elasticsearch support",
+    "description": "API Platform Elasticsearch bridge",
     "type": "library",
     "keywords": [
         "Filter",
-        "Elasticsearch"
+        "Elasticsearch",
+        "search"
     ],
     "homepage": "https://api-platform.com",
     "license": "MIT",
diff --git a/src/HttpCache/composer.json b/src/HttpCache/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "api-platform/http-cache",
-  "description": "HttpCache support",
+  "description": "API Platform HttpCache component",
   "type": "library",
   "keywords": [
     "Cache",
diff --git a/src/Hydra/EventListener/AddLinkHeaderListener.php b/src/Hydra/EventListener/AddLinkHeaderListener.php
@@ -15,7 +15,7 @@
 
 use ApiPlatform\Api\UrlGeneratorInterface;
 use ApiPlatform\JsonLd\ContextBuilder;
-use ApiPlatform\Util\CorsTrait;
+use ApiPlatform\State\Util\CorsTrait;
 use Psr\Link\EvolvableLinkProviderInterface;
 use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\WebLink\GenericLinkProvider;
diff --git a/src/RamseyUuid/composer.json b/src/RamseyUuid/composer.json
@@ -1,9 +1,9 @@
 {
     "name": "api-platform/ramsey-uuid",
-    "description": "API Platform RamseyUuid support",
+    "description": "API Platform RamseyUuid bridge",
     "type": "library",
     "keywords": [
-        "UUid",
+        "UUID",
         "API"
     ],
     "homepage": "https://api-platform.com",
diff --git a/src/Serializer/composer.json b/src/Serializer/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "api-platform/serializer",
-    "description": "Build GraphQL API endpoints",
+    "description": "API Platform core Serializer",
     "type": "library",
     "keywords": [
         "Serializer",
diff --git a/src/State/Processor/RespondProcessor.php b/src/State/Processor/RespondProcessor.php
@@ -13,15 +13,15 @@
 
 namespace ApiPlatform\State\Processor;
 
-use ApiPlatform\Metadata\IriConverterInterface;
-use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Metadata\HttpOperation;
+use ApiPlatform\Metadata\IriConverterInterface;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Put;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
+use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
-use ApiPlatform\State\ProcessorInterface;
 use ApiPlatform\Metadata\Util\CloneTrait;
+use ApiPlatform\State\ProcessorInterface;
 use Symfony\Component\HttpFoundation\Response;
 
 /**
diff --git a/src/State/Provider/ReadProvider.php b/src/State/Provider/ReadProvider.php
@@ -16,11 +16,11 @@
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Put;
+use ApiPlatform\Metadata\Util\CloneTrait;
 use ApiPlatform\Serializer\SerializerContextBuilderInterface;
 use ApiPlatform\State\Exception\ProviderNotFoundException;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\UriVariablesResolverTrait;
-use ApiPlatform\Metadata\Util\CloneTrait;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\State\Util\RequestParser;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
diff --git a/src/State/Tests/CallableProcessorTest.php b/src/State/Tests/CallableProcessorTest.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
 namespace ApiPlatform\State\Tests;
 
 use ApiPlatform\Metadata\Exception\RuntimeException;
diff --git a/src/State/Tests/CallableProviderTest.php b/src/State/Tests/CallableProviderTest.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
 namespace ApiPlatform\State\Tests;
 
 use ApiPlatform\Metadata\Get;
diff --git a/src/State/Tests/Util/RequestParserTest.php b/src/State/Tests/Util/RequestParserTest.php
@@ -11,9 +11,9 @@
 
 declare(strict_types=1);
 
-namespace ApiPlatform\Tests\Util;
+namespace ApiPlatform\State\Tests\Util;
 
-use ApiPlatform\Util\RequestParser;
+use ApiPlatform\State\Util\RequestParser;
 use PHPUnit\Framework\TestCase;
 
 /**
diff --git a/src/State/composer.json b/src/State/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "api-platform/state",
-    "description": "API Platform state interfaces",
+    "description": "API Platform State component ",
     "type": "library",
     "keywords": ["REST", "GraphQL", "API", "JSON-LD", "Hydra", "JSONAPI", "OpenAPI", "HAL", "Swagger"],
     "homepage": "https://api-platform.com",
diff --git a/src/Symfony/EventListener/DenyAccessListener.php b/src/Symfony/EventListener/DenyAccessListener.php
@@ -14,8 +14,8 @@
 namespace ApiPlatform\Symfony\EventListener;
 
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
-use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
+use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
 use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
diff --git a/src/Symfony/EventListener/DeserializeListener.php b/src/Symfony/EventListener/DeserializeListener.php
@@ -16,9 +16,9 @@
 use ApiPlatform\Api\FormatMatcher;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Serializer\SerializerContextBuilderInterface;
-use ApiPlatform\Symfony\Validator\Exception\ValidationException;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
+use ApiPlatform\Symfony\Validator\Exception\ValidationException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
diff --git a/src/Symfony/EventListener/ErrorListener.php b/src/Symfony/EventListener/ErrorListener.php
@@ -20,9 +20,9 @@
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\Util\ContentNegotiationTrait;
+use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
 use ApiPlatform\Symfony\Validator\Exception\ConstraintViolationListAwareExceptionInterface;
-use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Validator\Exception\ValidationException;
 use Negotiation\Negotiator;
 use Psr\Log\LoggerInterface;
diff --git a/src/Symfony/EventListener/QueryParameterValidateListener.php b/src/Symfony/EventListener/QueryParameterValidateListener.php
@@ -19,8 +19,8 @@
 use ApiPlatform\Metadata\CollectionOperationInterface;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
-use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
 use ApiPlatform\State\Util\RequestParser;
+use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 /**
diff --git a/src/Symfony/EventListener/ReadListener.php b/src/Symfony/EventListener/ReadListener.php
@@ -18,14 +18,14 @@
 use ApiPlatform\Exception\InvalidUriVariableException;
 use ApiPlatform\Metadata\Put;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\Util\CloneTrait;
 use ApiPlatform\Serializer\SerializerContextBuilderInterface;
 use ApiPlatform\State\Exception\ProviderNotFoundException;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\UriVariablesResolverTrait;
-use ApiPlatform\Metadata\Util\CloneTrait;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
+use ApiPlatform\State\Util\RequestParser;
 use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
-use ApiPlatform\Util\RequestParser;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
diff --git a/src/Symfony/EventListener/SerializeListener.php b/src/Symfony/EventListener/SerializeListener.php
@@ -19,9 +19,9 @@
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Serializer\ResourceList;
 use ApiPlatform\Serializer\SerializerContextBuilderInterface;
-use ApiPlatform\Util\ErrorFormatGuesser;
 use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
 use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
+use ApiPlatform\Util\ErrorFormatGuesser;
 use ApiPlatform\Validator\Exception\ValidationException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
diff --git a/src/Symfony/EventListener/WriteListener.php b/src/Symfony/EventListener/WriteListener.php
@@ -13,11 +13,11 @@
 
 namespace ApiPlatform\Symfony\EventListener;
 
+use ApiPlatform\Exception\InvalidIdentifierException;
 use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UriVariablesConverterInterface;
-use ApiPlatform\Exception\InvalidIdentifierException;
-use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
 use ApiPlatform\State\ProcessorInterface;
 use ApiPlatform\State\UriVariablesResolverTrait;
diff --git a/src/Symfony/Validator/State/QueryParameterValidateProvider.php b/src/Symfony/Validator/State/QueryParameterValidateProvider.php
@@ -19,7 +19,7 @@
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
-use ApiPlatform\Util\RequestParser;
+use ApiPlatform\State\Util\RequestParser;
 
 final class QueryParameterValidateProvider implements ProviderInterface
 {
diff --git a/src/Util/IriHelper.php b/src/Util/IriHelper.php
@@ -13,8 +13,9 @@
 
 namespace ApiPlatform\Util;
 
-use ApiPlatform\Api\UrlGeneratorInterface;
 use ApiPlatform\Exception\InvalidArgumentException;
+use ApiPlatform\Metadata\UrlGeneratorInterface;
+use ApiPlatform\State\Util\RequestParser;
 
 /**
  * Parses and creates IRIs.

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`namespace ApiPlatform\Api\QueryParameterValidator\Validator;`
`15`	`15`
`16`		`-use ApiPlatform\Util\RequestParser;`
	`16`	`+use ApiPlatform\State\Util\RequestParser;`
`17`	`17`
`18`	`18`	`final class Required implements ValidatorInterface`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "api-platform/http-cache",`
`3`		`- "description": "HttpCache support",`
	`3`	`+ "description": "API Platform HttpCache component",`
`4`	`4`	`"type": "library",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"Cache",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "api-platform/serializer",`
`3`		`- "description": "Build GraphQL API endpoints",`
	`3`	`+ "description": "API Platform core Serializer",`
`4`	`4`	`"type": "library",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"Serializer",`