Skip to content

fix: arrays of objects support in OpenAPI response generation #1021

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 2 commits into from
Oct 20, 2025
+66 −0
Merged

fix: arrays of objects support in OpenAPI response generation #1021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b98229
Add support for arrays of objects in OpenAPI response generation
s-shiryaev Aug 25, 2025
624ad6f
Merge branch 'v5' into OpenAPI-response-array-of-objects-fix
shalvah Oct 20, 2025
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
20 changes: 20 additions & 0 deletions src/Writing/OpenApiSpecGenerators/BaseGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,26 @@ protected function generateResponseContentSpec(?string $responseContent, OutputE
}

// Non-empty array
if (is_object($decoded[0])) {
// If the first item is an object, we assume it's an array of objects'
$properties = collect($decoded[0])->mapWithKeys(function ($value, $key) use ($endpoint) {
return [$key => $this->generateSchemaForResponseValue($value, $endpoint, $key)];
})->toArray();

return [
'application/json' => [
'schema' => [
'type' => 'array',
'items' => [
'type' => $this->convertScribeOrPHPTypeToOpenAPIType(gettype($decoded[0])),
'properties' => $this->objectIfEmpty($properties),
],
'example' => $decoded,
],
],
];
}

return [
'application/json' => [
'schema' => [
Expand Down
46 changes: 46 additions & 0 deletions tests/Unit/OpenAPISpecWriterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,6 +680,52 @@ public function adds_responses_correctly_as_responses_on_operation_object()
], $results['paths']['/path2']['put']['responses']);
}

/** @test */
public function adds_responses_correctly_as_array_of_objects()
{
$endpointData1 = $this->createMockEndpointData([
'httpMethods' => ['GET'],
'uri' => '/path1',
'responses' => [
[
'status' => 200,
'description' => 'Successfully.',
'content' => '[{"id": 1, "name": "John"}, {"id": 2, "name": "Jane"}]',
],
],
]);
$groups = [$this->createGroup([$endpointData1])];

$results = $this->generate($groups);

$this->assertCount(1, $results['paths']['/path1']['get']['responses']);
$this->assertArraySubset([
'200' => [
'description' => 'Successfully.',
'content' => [
'application/json' => [
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => [
'type' => 'integer',
'example' => 1,
],
'name' => [
'type' => 'string',
'example' => 'John',
],
]
],
],
],
],
],
], $results['paths']['/path1']['get']['responses']);
}

/** @test */
public function adds_required_fields_on_array_of_objects()
{
Expand Down