Skip to content

Commit db13fcc

Browse files
authored
Use operation output class name instead Resource short name in operation summary (api-platform#3741)
1 parent 8a62553 commit db13fcc

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/Swagger/Serializer/DocumentationNormalizer.php

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -323,9 +323,10 @@ private function updateGetOperation(bool $v3, \ArrayObject $pathOperation, array
323323
}
324324

325325
if (OperationType::COLLECTION === $operationType) {
326-
$pathOperation['summary'] ?? $pathOperation['summary'] = sprintf('Retrieves the collection of %s resources.', $resourceShortName);
326+
$outputResourseShortName = $resourceMetadata->getCollectionOperations()[$operationName]['output']['name'] ?? $resourceShortName;
327+
$pathOperation['summary'] ?? $pathOperation['summary'] = sprintf('Retrieves the collection of %s resources.', $outputResourseShortName);
327328

328-
$successResponse = ['description' => sprintf('%s collection response', $resourceShortName)];
329+
$successResponse = ['description' => sprintf('%s collection response', $outputResourseShortName)];
329330
[$successResponse] = $this->addSchemas($v3, $successResponse, $definitions, $resourceClass, $operationType, $operationName, $mimeTypes);
330331

331332
$pathOperation['responses'] ?? $pathOperation['responses'] = [$successStatus => $successResponse];
@@ -336,11 +337,12 @@ private function updateGetOperation(bool $v3, \ArrayObject $pathOperation, array
336337
return $pathOperation;
337338
}
338339

339-
$pathOperation['summary'] ?? $pathOperation['summary'] = sprintf('Retrieves a %s resource.', $resourceShortName);
340+
$outputResourseShortName = $resourceMetadata->getItemOperations()[$operationName]['output']['name'] ?? $resourceShortName;
341+
$pathOperation['summary'] ?? $pathOperation['summary'] = sprintf('Retrieves a %s resource.', $outputResourseShortName);
340342

341343
$pathOperation = $this->addItemOperationParameters($v3, $pathOperation);
342344

343-
$successResponse = ['description' => sprintf('%s resource response', $resourceShortName)];
345+
$successResponse = ['description' => sprintf('%s resource response', $outputResourseShortName)];
344346
[$successResponse] = $this->addSchemas($v3, $successResponse, $definitions, $resourceClass, $operationType, $operationName, $mimeTypes);
345347

346348
$pathOperation['responses'] ?? $pathOperation['responses'] = [

0 commit comments

Comments
 (0)