Skip to content

Update Hydra JsonSchema context property possible types #4223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alanpoulain merged 4 commits into from
Apr 27, 2021
Merged

Update Hydra JsonSchema context property possible types #4223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
726db81
Update Hydra JsonSchema context property possible types
llupa Apr 15, 2021
33cc964
Merge branch '2.6' into 2.5
llupa Apr 21, 2021
47866d9
Merge branch '2.6' into 2.5
llupa Apr 27, 2021
c0a5840
test: add an integration test
alanpoulain Apr 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## 2.6.5

* JsonSchema: Update Hydra `@context` property possible types
* Filter validation: Fix issue in Required filter validator with dot notation (#4221)
* OpenAPI: Fix notice/warning for `response` without `content` in the `openapi_context` (#4210)
* OpenAPI: Do not use output for request body (#4213)
Expand Down
22 changes: 21 additions & 1 deletion src/Hydra/JsonSchema/SchemaFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace ApiPlatform\Core\Hydra\JsonSchema;

use ApiPlatform\Core\JsonLd\ContextBuilder;
use ApiPlatform\Core\JsonSchema\Schema;
use ApiPlatform\Core\JsonSchema\SchemaFactory as BaseSchemaFactory;
use ApiPlatform\Core\JsonSchema\SchemaFactoryInterface;
Expand All @@ -35,7 +36,26 @@ final class SchemaFactory implements SchemaFactoryInterface
'@type' => self::BASE_PROP,
];
private const BASE_ROOT_PROPS = [
'@context' => self::BASE_PROP,
'@context' => [
'readOnly' => true,
'oneOf' => [
['type' => 'string'],
[
'type' => 'object',
'properties' => [
'@vocab' => [
'type' => 'string',
],
'hydra' => [
'type' => 'string',
'enum' => [ContextBuilder::HYDRA_NS],
],
],
'required' => ['@vocab', 'hydra'],
'additionalProperties' => true,
],
],
],
] + self::BASE_PROPS;

private $schemaFactory;
Expand Down
42 changes: 31 additions & 11 deletions tests/Bridge/Symfony/Bundle/Test/ApiTestCaseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Dummy as DummyDocument;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoInputOutput;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Model\ResourceInterface;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Tools\SchemaTool;
Expand Down Expand Up @@ -137,6 +138,21 @@ public function testAssertMatchesResourceItemJsonSchema(): void
$this->assertMatchesResourceItemJsonSchema(ResourceInterface::class);
}

public function testAssertMatchesResourceItemJsonSchemaOutput(): void
{
$this->recreateSchema();

/** @var EntityManagerInterface $manager */
$manager = self::$container->get('doctrine')->getManager();
$dummyDtoInputOutput = new DummyDtoInputOutput();
$dummyDtoInputOutput->str = 'lorem';
$dummyDtoInputOutput->num = 54;
$manager->persist($dummyDtoInputOutput);
$manager->flush();
self::createClient()->request('GET', '/dummy_dto_input_outputs/1');
$this->assertMatchesResourceItemJsonSchema(DummyDtoInputOutput::class);
}

// Next tests have been imported from dms/phpunit-arraysubset-asserts, because the original constraint has been deprecated.

public function testAssertArraySubsetPassesStrictConfig(): void
Expand All @@ -160,17 +176,7 @@ public function testAssertArraySubsetDoesNothingForValidScenario(): void

public function testFindIriBy(): void
{
self::bootKernel();
/**
* @var EntityManagerInterface
*/
$manager = self::$container->get('doctrine')->getManager();
/** @var \Doctrine\ORM\Mapping\ClassMetadata[] $classes */
$classes = $manager->getMetadataFactory()->getAllMetadata();
$schemaTool = new SchemaTool($manager);

$schemaTool->dropSchema($classes);
$schemaTool->createSchema($classes);
$this->recreateSchema();

self::createClient()->request('POST', '/dummies', [
'headers' => [
Expand All @@ -185,4 +191,18 @@ public function testFindIriBy(): void
$this->assertMatchesRegularExpression('~^/dummies/\d+~', self::findIriBy($resource, ['name' => 'Kevin']));
$this->assertNull(self::findIriBy($resource, ['name' => 'not-exist']));
}

private function recreateSchema(): void
{
self::bootKernel();

/** @var EntityManagerInterface $manager */
$manager = self::$container->get('doctrine')->getManager();
/** @var \Doctrine\ORM\Mapping\ClassMetadata[] $classes */
$classes = $manager->getMetadataFactory()->getAllMetadata();
$schemaTool = new SchemaTool($manager);

$schemaTool->dropSchema($classes);
$schemaTool->createSchema($classes);
}
}
24 changes: 24 additions & 0 deletions tests/Hydra/JsonSchema/SchemaFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Hydra\JsonSchema\SchemaFactory;
use ApiPlatform\Core\JsonLd\ContextBuilder;
use ApiPlatform\Core\JsonSchema\Schema;
use ApiPlatform\Core\JsonSchema\SchemaFactory as BaseSchemaFactory;
use ApiPlatform\Core\JsonSchema\TypeFactoryInterface;
Expand Down Expand Up @@ -79,6 +80,29 @@ public function testHasRootDefinitionKeyBuildSchema(): void
$this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
$properties = $resultSchema['definitions'][$rootDefinitionKey]['properties'];
$this->assertArrayHasKey('@context', $properties);
$this->assertSame(
[
'readOnly' => true,
'oneOf' => [
['type' => 'string'],
[
'type' => 'object',
'properties' => [
'@vocab' => [
'type' => 'string',
],
'hydra' => [
'type' => 'string',
'enum' => [ContextBuilder::HYDRA_NS],
],
],
'required' => ['@vocab', 'hydra'],
'additionalProperties' => true,
],
],
],
$properties['@context']
);
$this->assertArrayHasKey('@type', $properties);
$this->assertArrayHasKey('@id', $properties);
}
Expand Down