Browse Source

Don't include status code in description (closes #561)

shalvah 2 years ago
parent
commit
8a90c2d1ea

+ 7 - 0
camel/Extraction/Response.php

@@ -49,4 +49,11 @@ class Response extends BaseDTO
 
         parent::__construct($parameters);
     }
+
+    public function fullDescription()
+    {
+        $description = $this->status;
+        if ($this->description) $description .= ", {$this->description}";
+        return $description;
+    }
 }

+ 1 - 1
resources/views/themes/default/endpoint.blade.php

@@ -27,7 +27,7 @@
 @if($endpoint->isGet() || $endpoint->hasResponses())
     @foreach($endpoint->responses as $response)
         <blockquote>
-            <p>Example response ({{$response->description ?: $response->status}}):</p>
+            <p>Example response ({{ $response->fullDescription() }}):</p>
         </blockquote>
         @if(count($response->headers))
         <details class="annotation">

+ 1 - 1
resources/views/themes/elements/endpoint.blade.php

@@ -194,7 +194,7 @@
                                                         aria-label="Response sample"
                                                         onchange="switchExampleResponse('{{ $endpoint->endpointId() }}', event.target.value);">
                                                     @foreach($endpoint->responses as $index => $response)
-                                                        <option value="{{ $index }}">{{ $response->description ?: $response->status }}</option>
+                                                        <option value="{{ $index }}">{{ $response->fullDescription() }}</option>
                                                     @endforeach
                                                 </select></div>
                                         </div>

+ 1 - 1
src/Extracting/Strategies/Responses/UseApiResourceTags.php

@@ -78,7 +78,7 @@ class UseApiResourceTags extends Strategy
 
         $status = $fields['status'] ?: $status;
         $apiResourceClass = $content;
-        $description = $fields['scenario'] ? "$status, {$fields['scenario']}" : "$status";
+        $description = $fields['scenario'] ?: "";
 
         $isCollection = strtolower($tag->getName()) == 'apiresourcecollection';
         return [(int)$status, $description, $apiResourceClass, $isCollection];

+ 1 - 1
src/Extracting/Strategies/Responses/UseResponseFileTag.php

@@ -38,7 +38,7 @@ class UseResponseFileTag extends Strategy
             ['fields' => $fields, 'content' => $filePath] = a::parseIntoContentAndFields($mainContent, ['status', 'scenario']);
 
             $status = $fields['status'] ?: ($status ?: 200);
-            $description = $fields['scenario'] ? "$status, {$fields['scenario']}" : "$status";
+            $description = $fields['scenario'] ?: "";
             $content = ResponseFileTools::getResponseContents($filePath, $json);
 
             return [

+ 1 - 1
src/Extracting/Strategies/Responses/UseResponseTag.php

@@ -39,7 +39,7 @@ class UseResponseTag extends Strategy
             ['fields' => $fields, 'content' => $content] = a::parseIntoContentAndFields($content, ['status', 'scenario']);
 
             $status = $fields['status'] ?: $status;
-            $description = $fields['scenario'] ? "$status, {$fields['scenario']}" : "$status";
+            $description = $fields['scenario'] ?: "";
 
             return ['content' => $content, 'status' => (int) $status, 'description' => $description];
         }, $responseTags);

+ 1 - 1
tests/Strategies/Responses/UseApiResourceTagsTest.php

@@ -144,7 +144,7 @@ class UseApiResourceTagsTest extends BaseLaravelTest
         $this->assertArraySubset([
             [
                 'status' => 202,
-                'description' => '202, Success',
+                'description' => 'Success',
                 'content' => json_encode([
                     'data' => [
                         'id' => 4,

+ 4 - 4
tests/Strategies/Responses/UseResponseFileTagTest.php

@@ -49,11 +49,11 @@ class UseResponseFileTagTest extends TestCase
                 [
                     [
                         'status' => 200,
-                        'description' => '200',
+                        'description' => '',
                     ],
                     [
                         'status' => 401,
-                        'description' => '401',
+                        'description' => '',
                     ],
                 ],
             ],
@@ -66,11 +66,11 @@ class UseResponseFileTagTest extends TestCase
                 [
                     [
                         'status' => 200,
-                        'description' => '200, success',
+                        'description' => 'success',
                     ],
                     [
                         'status' => 401,
-                        'description' => '401, auth problem',
+                        'description' => 'auth problem',
                     ],
                 ],
             ],

+ 4 - 4
tests/Strategies/Responses/UseResponseTagTest.php

@@ -47,7 +47,7 @@ class UseResponseTagTest extends TestCase
                 [
                     [
                         'status' => 200,
-                        'description' => '200',
+                        'description' => '',
                         'content' => [
                             'id' => 4,
                             'name' => 'banana',
@@ -55,7 +55,7 @@ class UseResponseTagTest extends TestCase
                     ],
                     [
                         'status' => 401,
-                        'description' => '401',
+                        'description' => '',
                         'content' => [
                             'message' => 'Unauthorized',
                         ],
@@ -71,7 +71,7 @@ class UseResponseTagTest extends TestCase
                 [
                     [
                         'status' => 200,
-                        'description' => '200, success',
+                        'description' => 'success',
                         'content' => [
                             'id' => 4,
                             'name' => 'banana',
@@ -79,7 +79,7 @@ class UseResponseTagTest extends TestCase
                     ],
                     [
                         'status' => 401,
-                        'description' => '401, auth problem',
+                        'description' => 'auth problem',
                         'content' => [
                             'message' => 'Unauthorized',
                         ],