Merge pull request #73 from swagindustries/fix/wrong-error-message

swagindustries · Sep 3, 2023 · 8bafe10 · 8bafe10
2 parents 370a666 + e51be63
commit 8bafe10
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -129,10 +129,10 @@ melodiia:
 
 ```yaml
 # The documentation should be available only in dev environment in some cases
-# /config/routing_dev.yaml
-documentation:
-    path: /documentation
-    controller: 'melodiia.documentation'
+when@dev:
+    documentation:
+        path: /api/v1/documentation
+        controller: 'melodiia.documentation'
 ```
 
 ⚠️ The render of the documentation cannot work without Twig. Be sure Twig is installed.

diff --git a/src/Documentation/Controller/SwaggerUiController.php b/src/Documentation/Controller/SwaggerUiController.php
@@ -47,7 +47,7 @@ public function __invoke(Request $request)
         }
 
         if (null === $path) {
-            throw new MelodiiaLogicException(sprintf('The option %s is missing on the documentation route', self::PATH_TO_OPEN_API_FILE_OPTION));
+            throw new MelodiiaLogicException(sprintf('Either you forgot to specify the option %s on your API endpoint configuration or this route is not under the path of you configuration', MelodiiaConfiguration::CONFIGURATION_OPENAPI_PATH));
         }
 
         if (!file_exists($path)) {