Skip to content

Commit

Permalink
Fix Swagger generation for array parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@ossinkine
ossinkine committed Jul 25, 2018
1 parent 8f70ce3 commit 92ad5a8
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/Api/FilterInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ interface FilterInterface
* - type: the type of the filter
* - required: if this filter is required
* - strategy: the used strategy
* - is_collection (optional): is this filter is collection
* - swagger (optional): additional parameters for the path operation,
* e.g. 'swagger' => [
* 'description' => 'My Description',
Expand Down
2 changes: 2 additions & 0 deletions src/Bridge/Doctrine/Orm/Filter/SearchFilter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ public function getDescription(string $resourceClass): array
'type' => $typeOfField,
'required' => false,
'strategy' => $strategy,
'is_collection' => '[]' === substr($filterParameterName, -2),
];
}
} elseif ($metadata->hasAssociation($field)) {
Expand All @@ -126,6 +127,7 @@ public function getDescription(string $resourceClass): array
'type' => 'string',
'required' => false,
'strategy' => self::STRATEGY_EXACT,
'is_collection' => '[]' === substr($filterParameterName, -2),
];
}
}
Expand Down
6 changes: 5 additions & 1 deletion src/Swagger/Serializer/DocumentationNormalizer.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,11 @@ private function getFiltersParameters(string $resourceClass, string $operationNa
'in' => 'query',
'required' => $data['required'],
];
$parameter += $this->getType($data['type'], false, null, null, $definitions, $serializerContext);
$parameter += $this->getType($data['type'], $data['is_collection'] ?? false, null, null, $definitions, $serializerContext);

if ('array' === $parameter['type']) {
$parameter['collectionFormat'] = \in_array($data['type'], [Type::BUILTIN_TYPE_ARRAY, Type::BUILTIN_TYPE_OBJECT], true) ? 'csv' : 'multi';
}

if (isset($data['swagger'])) {
$parameter = $data['swagger'] + $parameter;
Expand Down
44 changes: 44 additions & 0 deletions tests/Bridge/Doctrine/Orm/Filter/SearchFilterTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,144 +65,168 @@ public function testGetDescription()
'type' => 'int',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'id[]' => [
'property' => 'id',
'type' => 'int',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'name' => [
'property' => 'name',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'name[]' => [
'property' => 'name',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'alias' => [
'property' => 'alias',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'alias[]' => [
'property' => 'alias',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'description' => [
'property' => 'description',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'description[]' => [
'property' => 'description',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummy' => [
'property' => 'dummy',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummy[]' => [
'property' => 'dummy',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummyDate' => [
'property' => 'dummyDate',
'type' => 'DateTimeInterface',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummyDate[]' => [
'property' => 'dummyDate',
'type' => 'DateTimeInterface',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummyFloat' => [
'property' => 'dummyFloat',
'type' => 'float',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummyFloat[]' => [
'property' => 'dummyFloat',
'type' => 'float',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummyPrice' => [
'property' => 'dummyPrice',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummyPrice[]' => [
'property' => 'dummyPrice',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'jsonData' => [
'property' => 'jsonData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'jsonData[]' => [
'property' => 'jsonData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'arrayData' => [
'property' => 'arrayData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'arrayData[]' => [
'property' => 'arrayData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'nameConverted' => [
'property' => 'nameConverted',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'nameConverted[]' => [
'property' => 'nameConverted',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummyBoolean' => [
'property' => 'dummyBoolean',
'type' => 'bool',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummyBoolean[]' => [
'property' => 'dummyBoolean',
'type' => 'bool',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
], $filter->getDescription($this->resourceClass));

Expand All @@ -226,120 +250,140 @@ public function testGetDescription()
'type' => 'int',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'id[]' => [
'property' => 'id',
'type' => 'int',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'name' => [
'property' => 'name',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'name[]' => [
'property' => 'name',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'alias' => [
'property' => 'alias',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'alias[]' => [
'property' => 'alias',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummy' => [
'property' => 'dummy',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummy[]' => [
'property' => 'dummy',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'dummyDate' => [
'property' => 'dummyDate',
'type' => 'DateTimeInterface',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'dummyDate[]' => [
'property' => 'dummyDate',
'type' => 'DateTimeInterface',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'jsonData' => [
'property' => 'jsonData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'jsonData[]' => [
'property' => 'jsonData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'arrayData' => [
'property' => 'arrayData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'arrayData[]' => [
'property' => 'arrayData',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'nameConverted' => [
'property' => 'nameConverted',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'nameConverted[]' => [
'property' => 'nameConverted',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'relatedDummies.dummyDate' => [
'property' => 'relatedDummies.dummyDate',
'type' => 'DateTimeInterface',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'relatedDummies.dummyDate[]' => [
'property' => 'relatedDummies.dummyDate',
'type' => 'DateTimeInterface',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
'relatedDummy' => [
'property' => 'relatedDummy',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => false,
],
'relatedDummy[]' => [
'property' => 'relatedDummy',
'type' => 'string',
'required' => false,
'strategy' => 'exact',
'is_collection' => true,
],
], $filter->getDescription($this->resourceClass));
}
Expand Down

0 comments on commit 92ad5a8

Please sign in to comment.