Fix JSON:API collection included schema

[Will-thom]

Fixes #7956.

Preserves the JSON:API included schema when building OpenAPI schemas for collection responses and adds a functional regression test.

Tests:

• php -l src/JsonApi/JsonSchema/SchemaFactory.php
• php -l tests/Functional/OpenApiTest.php
• vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testJsonApiCollectionSchemaDocumentsIncludedResources
• vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testRetrieveTheOpenApiDocumentation
• vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testHasSchemasForMultipleFormats
• vendor/bin/phpunit tests/Functional/PaginationDisabledTest.php --filter testSchemaCollectionJsonApi

[soyuka]

Could be simpler by mutating $properties['data'] in place instead of introducing a $collectionProperties intermediate. That way included (and any future top-level key returned by buildDefinitionPropertiesSchema) flows through automatically:

$properties['data'] = [
    'type' => 'array',
    'items' => $properties['data'],
];

$schema['description'] = "$definitionName collection.";
$schema['allOf'] = [
    ['$ref' => $prefix.(false === $operation->getPaginationEnabled() ? self::COLLECTION_BASE_SCHEMA_NAME_NO_PAGINATION : self::COLLECTION_BASE_SCHEMA_NAME)],
    ['type' => 'object', 'properties' => $properties],
];

Removes the explicit isset($properties['included']) branch and keeps the wrapper shape consistent with the item schema.

[soyuka]

Nit: buildDefinitionPropertiesSchema returns 'included' => [...] only when relationships exist (see L357-376), so it can never be null here — isset() is safe. If the suggestion above is applied this branch goes away anyway.

[Will-thom]

Addressed the review suggestion in the latest commit (f37dde8b8): the collection schema now wraps $properties['data'] in place and passes $properties through directly, so included and any future top-level keys flow through without a separate branch.

Validation was run in an ephemeral Composer/PHP container:

• php -l src/JsonApi/JsonSchema/SchemaFactory.php
• php -l tests/Functional/OpenApiTest.php
• vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testJsonApiCollectionSchemaDocumentsIncludedResources — OK (1 test, 6 assertions)
• vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testRetrieveTheOpenApiDocumentation — OK (7 tests, 119 assertions)
• vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testHasSchemasForMultipleFormats — OK (1 test, 2 assertions)
• vendor/bin/phpunit tests/Functional/PaginationDisabledTest.php --filter testSchemaCollectionJsonApi — OK (1 test, 8 assertions)
• git diff --check

[Will-thom]

I rebased the branch on the current main and squashed the PR changes into a conventional commit (ix(jsonapi): include collection schema data properties) so commitlint should pass now.

I also re-ran the relevant functional coverage locally in a Composer/PHP container:

• �endor/bin/phpunit tests/Functional/OpenApiTest.php --filter testJsonApiCollectionSchemaDocumentsIncludedResources -> OK (1 test, 6 assertions)
• �endor/bin/phpunit tests/Functional/OpenApiTest.php -> OK (20 tests, 210 assertions)

The previous Doctrine/Laravel failures were coming from new main changes (
epositoryMethod / withCredentials) not present on the older branch base, so the rebase should address those as well.

[Will-thom]

Reworked the branch onto the correct 4.3 base and force-pushed the same scoped JSON:API/OpenAPI patch. The previous doctrine-orm / doctrine-odm minimal-changes failures came from accidentally rebasing on main, which pulled newer internal APIs that are not compatible with the 4.3 dependency matrix.

Local validation passed in an isolated container:

vendor/bin/phpunit tests/Functional/OpenApiTest.php --filter testJsonApiCollectionSchemaDocumentsIncludedResources
vendor/bin/phpunit tests/Functional/OpenApiTest.php

Results: focused test OK with 1 test / 6 assertions; full OpenApiTest OK with 20 tests / 210 assertions. The refreshed CI run is now green as well.

[Will-thom]

The branch is now on the correct 4.3 base and the refreshed CI run is green. Please let me know if anything else is needed from my side.