Browse Source

Fix style issues

shalvah 5 years ago
parent
commit
b9d62968af

+ 2 - 1
docs/plugins.md

@@ -4,6 +4,7 @@ You can use plugins to alter how the Generator fetches data about your routes. F
 ## The stages of route processing
 Route processing is performed in four stages:
 - metadata (this covers route `title`, route `description`, route `groupName`, route `groupDescription`, and authentication status (`authenticated`))
+- urlParameters
 - bodyParameters
 - queryParameters
 - responses
@@ -12,7 +13,7 @@ For each stage, the Generator attempts the specified strategies to fetch data. T
 
 There are a number of strategies inccluded with the package, so you don't have to set up anything to get it working.
 
-> Note: The included ResponseCalls strategy is designed to stop if a response has already been gotten from any other strategy.
+> Note: The included ResponseCalls strategy is designed to stop if a response with a 2xx status code has already been gotten via any other strategy.
 
 ## Strategies
 To create a strategy, create a class that extends `\Mpociot\ApiDoc\Strategies\Strategy`.

+ 3 - 3
src/Strategies/Responses/ResponseCalls.php

@@ -47,9 +47,9 @@ class ResponseCalls extends Strategy
             $response = $this->makeApiCall($request);
             $response = [
                 [
-                'status' => $response->getStatusCode(),
-                'content' => $response->getContent()
-            ]
+                    'status' => $response->getStatusCode(),
+                    'content' => $response->getContent(),
+                ],
             ];
         } catch (\Exception $e) {
             echo 'Exception thrown during response call for ['.implode(',', $route->methods)."] {$route->uri}.\n";

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

@@ -3,11 +3,11 @@
 namespace Mpociot\ApiDoc\Strategies\Responses;
 
 use Exception;
-use Illuminate\Http\Response;
 use ReflectionClass;
 use ReflectionMethod;
 use Illuminate\Support\Arr;
 use Illuminate\Http\Request;
+use Illuminate\Http\Response;
 use Illuminate\Routing\Route;
 use Mpociot\ApiDoc\Tools\Flags;
 use Mpociot\ApiDoc\Tools\Utils;
@@ -84,6 +84,7 @@ class UseApiResourceTags extends Strategy
             $response = response()->json(
                 $resource->toArray(app(Request::class))
             );
+
             return [
                 [
                     'status' => $statusCode ?: $response->getStatusCode(),

+ 1 - 1
src/Tools/Generator.php

@@ -157,7 +157,7 @@ class Generator
             $results = $strategy(...$strategyArgs);
             if (! is_null($results)) {
                 foreach ($results as $index => $item) {
-                    if ($stage == "responses") {
+                    if ($stage == 'responses') {
                         // Responses are additive
                         $context[$stage][] = $item;
                         continue;

+ 1 - 0
tests/Fixtures/TestController.php

@@ -260,6 +260,7 @@ class TestController extends Controller
     public function withResponseTag()
     {
         GeneratorTestCase::$globalValue = rand();
+
         return '';
     }
 

+ 0 - 1
tests/Unit/GeneratorTestCase.php

@@ -11,7 +11,6 @@ use Mpociot\ApiDoc\Tests\Fixtures\TestUser;
 use Mpociot\ApiDoc\Tools\DocumentationConfig;
 use Mpociot\ApiDoc\Tests\Fixtures\TestController;
 use Mpociot\ApiDoc\ApiDocGeneratorServiceProvider;
-use Mpociot\ApiDoc\Tests\Fixtures\TestResourceController;
 
 abstract class GeneratorTestCase extends TestCase
 {