Skip to content

Commit

Permalink
fix: multiple responses with the same status code (#863)
Browse files Browse the repository at this point in the history 
Co-authored-by: Giovani Müller <[email protected]>
  • Loading branch information
@giovanivrech
giovanivrech and Giovani Müller authored Jul 11, 2024
1 parent 4dddeb4 commit 87c2dbd
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/Writing/OpenAPISpecWriter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,17 +275,18 @@ protected function generateEndpointResponsesSpec(OutputEndpointData $endpoint)
$content = $this->generateResponseContentSpec($response->content, $endpoint);
$contentType = array_keys($content)[0];
if (isset($responses[$response->status]['content'][$contentType])) {
$newResponseExample = array_replace([
'description' => $this->getResponseDescription($response),
], $content[$contentType]['schema']);

// If we've already created the oneOf object, add this response
if (isset($responses[$response->status]['content'][$contentType]['schema']['oneOf'])) {
$responses[$response->status]['content'][$contentType]['schema']['oneOf'][] = $content[$contentType];
$responses[$response->status]['content'][$contentType]['schema']['oneOf'][] = $newResponseExample;
} else {
// Create the oneOf object
$existingResponseExample = array_replace([
'description' => $responses[$response->status]['description'],
], $responses[$response->status]['content'][$contentType]['schema']);
$newResponseExample = array_replace([
'description' => $this->getResponseDescription($response),
], $content[$contentType]['schema']);

$responses[$response->status]['description'] = '';
$responses[$response->status]['content'][$contentType]['schema'] = [
Expand Down
94 changes: 94 additions & 0 deletions tests/Unit/OpenAPISpecWriterTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,100 @@ public function adds_multiple_responses_correctly_using_oneOf()
], $results['paths']['/path1']['post']['responses']);
}

/** @test */
public function adds_more_than_two_answers_correctly_using_oneOf()
{
$endpointData1 = $this->createMockEndpointData([
'httpMethods' => ['POST'],
'uri' => '/path1',
'responses' => [
[
'status' => 201,
'description' => 'This one',
'content' => '{"this": "one"}',
],
[
'status' => 201,
'description' => 'No, that one.',
'content' => '{"that": "one"}',
],
[
'status' => 201,
'description' => 'No, another one.',
'content' => '{"another": "one"}',
],
[
'status' => 200,
'description' => 'A separate one',
'content' => '{"the other": "one"}',
],
],
]);
$groups = [$this->createGroup([$endpointData1])];

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

$this->assertArraySubset([
'200' => [
'description' => 'A separate one',
'content' => [
'application/json' => [
'schema' => [
'type' => 'object',
'properties' => [
'the other' => [
'example' => "one",
'type' => 'string',
],
],
],
],
],
],
'201' => [
'description' => '',
'content' => [
'application/json' => [
'schema' => [
'oneOf' => [
[
'type' => 'object',
'description' => 'This one',
'properties' => [
'this' => [
'example' => "one",
'type' => 'string',
],
],
],
[
'type' => 'object',
'description' => 'No, that one.',
'properties' => [
'that' => [
'example' => "one",
'type' => 'string',
],
],
],
[
'type' => 'object',
'description' => 'No, another one.',
'properties' => [
'another' => [
'example' => "one",
'type' => 'string',
],
],
],
],
],
],
],
],
], $results['paths']['/path1']['post']['responses']);
}

protected function createMockEndpointData(array $custom = []): OutputEndpointData
{
$faker = Factory::create();
Expand Down

0 comments on commit 87c2dbd

Please sign in to comment.