Merge branch '3.4' into 4.0

src/Doctrine/Common/README.md

@@ -1,7 +1,12 @@
-# API Platform - Doctrine Common
+# API Platform - Doctrine Common Support
 
-Common files used by api-platform/doctrine-orm and api-platform/doctrine-odm
-
-## Resources
+Integration for [Doctrine](https://www.doctrine-project.org) with the [API Platform](https://api-platform.com) framework.
 
+[Documentation](https://api-platform.com/docs/core/getting-started/)
 
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Doctrine/Odm/README.md

@@ -0,0 +1,12 @@
+# API Platform - Doctrine MongoDB ODM Support
+
+Integration for [Doctrine MongoDB ODM](https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/current/index.html) with the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/core/mongodb/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Doctrine/Orm/README.md

@@ -0,0 +1,12 @@
+# API Platform - Doctrine ORM Support 
+
+Integration for [Doctrine ORM](https://www.doctrine-project.org/projects/doctrine-orm/en/current/index.html) with the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/core/getting-started/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Documentation/README.md

@@ -0,0 +1,12 @@
+# API Platform - Documentation
+
+The API documentation component of the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/core/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Elasticsearch/README.md

@@ -1,7 +1,12 @@
-# API Platform - Elasticsearch
+# API Platform - Elasticsearch Support
 
-Elasticsearch Support.
-
-## Resources
+Integration for [Elasticsearch](https://www.elastic.co/elasticsearch) with the [API Platform](https://api-platform.com) framework.
 
+[Documentation](https://api-platform.com/docs/core/elasticsearch/)
 
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/GraphQl/README.md

@@ -1,3 +1,12 @@
 # API Platform - GraphQL
 
-Build GraphQL API endpoints
+The [GraphQL](https://graphql.org/) component of the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/core/graphql/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Hal/README.md

@@ -0,0 +1,12 @@
+# API Platform - HAL 
+
+The [HAL (Hypertext Application Language)](https://stateless.group/hal_specification.html) component of the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/core/content-negotiation/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/HttpCache/README.md

@@ -1,7 +1,15 @@
 # API Platform - HTTP Cache
 
-HTTP Cache support.
+The [HTTP Cache](https://httpwg.org/specs/rfc7234.html) component of the [API Platform](https://api-platform.com) framework.
 
-## Resources
+This component also provides integrations with [Varnish](https://varnish-cache.org/), [Souin](https://souin.io/)
+and other HTTP cache servers and services.
 
+[Documentation](https://api-platform.com/docs/core/performance/)
 
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Hydra/README.md

@@ -0,0 +1,14 @@
+# API Platform - Hydra
+
+The [Hydra](https://www.hydra-cg.com/) component of the [API Platform](https://api-platform.com) framework.
+
+Hydra simplifies the development of interoperable, hypermedia-driven Web APIs.
+
+[Documentation](https://api-platform.com/docs/core/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/JsonApi/README.md

@@ -0,0 +1,14 @@
+# API Platform - JSON:API
+
+The [JSON:API](https://jsonapi.org/) component of the [API Platform](https://api-platform.com) framework.
+
+JSON:API is a popular specification for building APIs in JSON.
+
+[Documentation](https://api-platform.com/docs/core/content-negotiation/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/JsonLd/README.md

@@ -0,0 +1,14 @@
+# API Platform - JSON-LD
+
+The [JSON-LD](https://json-ld.org/) component of the [API Platform](https://api-platform.com) framework.
+
+Data is messy and disconnected. JSON-LD organizes and connects it, creating a better Web.
+
+[Documentation](https://api-platform.com/docs/core/extending-jsonld-context/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/JsonSchema/README.md

@@ -1,7 +1,14 @@
 # API Platform - JSON Schema
 
-Build a JSON Schema from API Resources.
+The [JSON Schema](https://json-schema.org/) component of the [API Platform](https://api-platform.com) framework.
 
-## Resources
+Generates JSON Schema from PHP classes.
 
+[Documentation](https://api-platform.com/docs/core/json-schema/)
 
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Metadata/README.md

@@ -0,0 +1,14 @@
+# API Platform - Metadata 
+
+The Metadata component of the [API Platform](https://api-platform.com) framework.
+
+Generates abstract representation of web APIs. It's the core of the API Platform Core library.
+
+[Documentation](https://api-platform.com/docs/core/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/OpenApi/README.md

@@ -1,8 +1,14 @@
 # API Platform - OpenAPI
 
-Models to build and serialize an OpenAPI specification.
+The [OpenAPI](https://www.openapis.org) component of the [API Platform](https://api-platform.com) framework.
 
-## Resources
+Builds and serializes OpenAPI specifications. OpenAPI was formerly known as Swagger.
 
-- [Documentation](https://api-platform.com/docs)
-- [Report issues](https://github.com/api-platform/core/issues) and [send Pull Requests](https://github.com/api-platform/core/pulls) on the [main API Platform repository](https://github.com/api-platform/core)
+[Documentation](https://api-platform.com/docs/core/openapi/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/RamseyUuid/README.md

@@ -1,3 +1,12 @@
-# API Platform - RamseyUuid
+# API Platform - `ramsey/uuid 
 
-RamseyUuid component from API Platform
+Integration for [`ramsey/uuid`](https://uuid.ramsey.dev) with the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/core/identifiers/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Serializer/README.md

@@ -1,3 +1,15 @@
-# API Platform - GraphQL
+# API Platform - Serializer
 
-Build GraphQL API endpoints
+The Serializer component of the [API Platform](https://api-platform.com) framework.
+
+Serializes PHP objects in various API formats.
+Built on top of the Symfony Serializer component.
+
+[Documentation](https://api-platform.com/docs/core/serialization/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Serializer/composer.json

@@ -25,26 +25,28 @@
         "php": ">=8.2",
         "api-platform/metadata": "^3.4 || ^4.0",
         "api-platform/state": "^3.4 || ^4.0",
-        "doctrine/collections": "^2.1",
         "symfony/property-access": "^6.4 || ^7.0",
         "symfony/property-info": "^6.4 || ^7.0",
         "symfony/serializer": "^6.4 || ^7.0",
         "symfony/validator": "^6.4 || ^7.0"
     },
     "require-dev": {
-        "api-platform/openapi": "^3.4 || ^4.0",
+        "api-platform/doctrine-common": "^3.4 || ^4.0",
+        "api-platform/doctrine-odm": "^3.4 || ^4.0",
+        "api-platform/doctrine-orm": "^3.4 || ^4.0",
         "api-platform/json-schema": "^3.4 || ^4.0",
+        "api-platform/openapi": "^3.4 || ^4.0",
+        "doctrine/collections": "^2.1",
         "phpspec/prophecy-phpunit": "^2.2",
+        "phpunit/phpunit": "^11.2",
+        "sebastian/comparator": "<5.0",
         "symfony/mercure-bundle": "*",
         "symfony/var-dumper": "^6.4 || ^7.0",
-        "phpunit/phpunit": "^11.2",
-        "symfony/yaml": "^6.4 || ^7.0",
-        "api-platform/doctrine-odm": "^3.4 || ^4.0",
-        "api-platform/doctrine-orm": "^3.4 || ^4.0",
-        "api-platform/doctrine-common": "^3.4 || ^4.0"
+        "symfony/yaml": "^6.4 || ^7.0"
     },
     "suggest": {
-        "api-platform/doctrine-orm": "To support doctrine ORM state options."
+        "api-platform/doctrine-orm": "To support Doctrine ORM state options.",
+        "api-platform/doctrine-odm": "To support Doctrine MongoDB ODM state options."
     },
     "autoload": {
         "psr-4": {

src/State/README.md

@@ -0,0 +1,17 @@
+# API Platform - Serializer
+
+The State component of the [API Platform](https://api-platform.com) framework.
+
+Provides and processes API states.
+
+Documentation:
+
+* [State providers](https://api-platform.com/docs/core/state-providers/)
+* [State processors](https://api-platform.com/docs/core/state-processors/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Symfony/README.md

@@ -1,3 +1,12 @@
-# Symfony Integration of API Platform
+# API Platform for Symfony
 
-Integrates [API Platform](https://api-platform.com) into the [Symfony](https://symfony.com) framework and components.
+Integration of [Symfony](https://symfony.com) with the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/symfony/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).

src/Validator/README.md

@@ -1,3 +1,12 @@
 # API Platform - Validator
 
-Validator component from API Platform
+The Validator component of the [API Platform](https://api-platform.com) framework.
+
+[Documentation](https://api-platform.com/docs/admin/validation/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).