Skip to content

[JSON Schema] Add additionalProperties (false) to the generated JSON schema #3804

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
merged 1 commit into from
Nov 2, 2020
Merged

[JSON Schema] Add additionalProperties (false) to the generated JSON schema #3804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions phpstan.neon.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,7 @@ parameters:
path: tests/GraphQl/Type/TypesContainerTest.php
# https://github.com/phpstan/phpstan/issues/2999
-
message: '#ArrayObject<string, string> does not accept true\.#'
path: src/JsonSchema/SchemaFactory.php
-
message: '#ArrayObject<string, string> does not accept array<string, mixed>\.#'
path: src/JsonSchema/SchemaFactory.php
-
message: '#Cannot assign new offset to string\.#'
message: '#ArrayObject<string, bool\|string> does not accept array<string, mixed>\.#'
path: src/JsonSchema/SchemaFactory.php

# Expected, due to optional interfaces
Expand Down
2 changes: 1 addition & 1 deletion src/JsonSchema/SchemaFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public function buildSchema(string $className, string $format = 'json', string $
return $schema;
}

$definition = new \ArrayObject(['type' => 'object']);
$definition = new \ArrayObject(['type' => 'object', 'additionalProperties' => false]);
$definitions[$definitionName] = $definition;
if (null !== $resourceMetadata && null !== $description = $resourceMetadata->getDescription()) {
$definition['description'] = $description;
Expand Down
2 changes: 2 additions & 0 deletions tests/JsonSchema/SchemaFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ public function testBuildSchemaForNonResourceClass(): void
$this->assertArrayHasKey($rootDefinitionKey, $definitions);
$this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
$this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
$this->assertFalse($definitions[$rootDefinitionKey]['additionalProperties']);
$this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
$this->assertArrayHasKey('foo', $definitions[$rootDefinitionKey]['properties']);
$this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['foo']);
Expand Down Expand Up @@ -136,6 +137,7 @@ public function testBuildSchemaForOperationWithOverriddenSerializerGroups(): voi
$this->assertArrayHasKey($rootDefinitionKey, $definitions);
$this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]);
$this->assertSame('object', $definitions[$rootDefinitionKey]['type']);
$this->assertFalse($definitions[$rootDefinitionKey]['additionalProperties']);
$this->assertArrayHasKey('properties', $definitions[$rootDefinitionKey]);
$this->assertArrayHasKey('alias', $definitions[$rootDefinitionKey]['properties']);
$this->assertArrayHasKey('type', $definitions[$rootDefinitionKey]['properties']['alias']);
Expand Down
24 changes: 24 additions & 0 deletions tests/Swagger/Serializer/DocumentationNormalizerV2Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ private function doTestNormalize(OperationMethodResolverInterface $operationMeth
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -461,6 +462,7 @@ private function doTestNormalizeWithNameConverter(bool $legacy = false): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'properties' => [
'name' => new \ArrayObject([
Expand Down Expand Up @@ -573,6 +575,7 @@ public function testNormalizeWithApiKeysEnabled(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'properties' => [
'name' => new \ArrayObject([
Expand Down Expand Up @@ -765,6 +768,7 @@ public function testNormalizeWithOnlyNormalizationGroups(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand All @@ -776,6 +780,7 @@ public function testNormalizeWithOnlyNormalizationGroups(): void
]),
$ref => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -963,6 +968,7 @@ public function testNormalizeNotAddExtraBodyParameters(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand All @@ -974,6 +980,7 @@ public function testNormalizeNotAddExtraBodyParameters(): void
]),
$ref => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -1062,6 +1069,7 @@ public function testNormalizeWithSwaggerDefinitionName(): void
'definitions' => new \ArrayObject([
'Dummy-Read' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -1235,6 +1243,7 @@ public function testNormalizeWithOnlyDenormalizationGroups(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand All @@ -1246,6 +1255,7 @@ public function testNormalizeWithOnlyDenormalizationGroups(): void
]),
'Dummy-dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -1421,6 +1431,7 @@ public function testNormalizeWithNormalizationAndDenormalizationGroups(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand All @@ -1432,6 +1443,7 @@ public function testNormalizeWithNormalizationAndDenormalizationGroups(): void
]),
'Dummy-dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -1608,6 +1620,7 @@ public function testNormalizeSkipsNotReadableAndNotWritableProperties(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -2001,6 +2014,7 @@ public function testNormalizeWithNestedNormalizationGroups(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand All @@ -2012,6 +2026,7 @@ public function testNormalizeWithNestedNormalizationGroups(): void
]),
$ref => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand All @@ -2027,6 +2042,7 @@ public function testNormalizeWithNestedNormalizationGroups(): void
]),
$relatedDummyRef => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a related dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/RelatedDummy'],
'properties' => [
Expand Down Expand Up @@ -2136,6 +2152,7 @@ private function doTestNormalizeWithFilters($filterLocator): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'properties' => [
'name' => new \ArrayObject([
Expand Down Expand Up @@ -2295,6 +2312,7 @@ private function doTestNormalizeWithSubResource(OperationAwareFormatsProviderInt
'definitions' => new \ArrayObject([
'Question' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a question.',
'externalDocs' => ['url' => 'http://schema.example.com/Question'],
'properties' => [
Expand All @@ -2307,6 +2325,7 @@ private function doTestNormalizeWithSubResource(OperationAwareFormatsProviderInt
]),
'Answer' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is an answer.',
'externalDocs' => ['url' => 'http://schema.example.com/Answer'],
'properties' => [
Expand Down Expand Up @@ -2390,6 +2409,7 @@ public function testNormalizeWithPropertySwaggerContext(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -2490,6 +2510,7 @@ public function testNormalizeWithPaginationClientEnabled(): void
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -2685,6 +2706,7 @@ private function doTestNormalizeWithCustomFormatsDefinedAtOperationLevel(Operati
'definitions' => new \ArrayObject([
'Dummy' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => ['url' => 'http://schema.example.com/Dummy'],
'properties' => [
Expand Down Expand Up @@ -2893,6 +2915,7 @@ private function doTestNormalizeWithInputAndOutputClass(): void
'definitions' => new \ArrayObject([
'Dummy:300dcd476cef011532fb0ca7683395d7' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => [
'url' => 'http://schema.example.com/Dummy',
Expand All @@ -2911,6 +2934,7 @@ private function doTestNormalizeWithInputAndOutputClass(): void
]),
'Dummy:b4f76c1a44965bd401aa23bb37618acc' => new \ArrayObject([
'type' => 'object',
'additionalProperties' => false,
'description' => 'This is a dummy.',
'externalDocs' => [
'url' => 'http://schema.example.com/Dummy',
Expand Down
Loading