Forráskód Böngészése

Standardise old config file

Shalvah 3 hónapja
szülő
commit
b62479015f
2 módosított fájl, 6 hozzáadás és 6 törlés
  1. 1 1
      config/scribe.php
  2. 5 5
      config/scribe_old.php

+ 1 - 1
config/scribe.php

@@ -66,7 +66,7 @@ return Config\Factory::make(
         title: config('app.name').' API Documentation',
         description: '',
         baseUrls: [
-            "production" => config("app.base_url"),
+            "production" => config("app.url"),
         ],
         exampleLanguages: ['bash', 'javascript'],
         logo: false,

+ 5 - 5
config/scribe_old.php

@@ -4,14 +4,14 @@ use Knuckles\Scribe\Extracting\Strategies;
 
 return [
     // The HTML <title> for the generated documentation. If this is empty, Scribe will infer it from config('app.name').
-    'title' => null,
+    'title' => config('app.name').' API Documentation',
 
     // A short description of your API. Will be included in the docs webpage, Postman collection and OpenAPI spec.
     'description' => '',
 
     // The base URL displayed in the docs. If this is empty, Scribe will use the value of config('app.url') at generation time.
     // If you're using `laravel` type, you can set this to a dynamic string, like '{{ config("app.tenant_url") }}' to get a dynamic base URL.
-    'base_url' => null,
+    'base_url' => config("app.url"),
 
     'routes' => [
         [
@@ -41,10 +41,10 @@ return [
     // - "laravel" will generate the documentation as a Blade view, so you can add routing and authentication.
     // - "external_static" and "external_laravel" do the same as above, but generate a basic template,
     // passing the OpenAPI spec as a URL, allowing you to easily use the docs with an external generator
-    'type' => 'static',
+    'type' => 'external_laravel',
 
     // See https://scribe.knuckles.wtf/laravel/reference/config#theme for supported options
-    'theme' => 'default',
+    'theme' => 'scalar',
 
     'static' => [
         // HTML documentation, assets and Postman collection will be generated to this folder.
@@ -80,7 +80,7 @@ return [
         'enabled' => true,
 
         // The base URL for the API tester to use (for example, you can set this to your staging URL).
-        // Leave as null to use the current app URL when generating (config("app.url")).
+        // Leave as null to be the same as the displayed URL (config("scribe.base_url")).
         'base_url' => null,
 
         // [Laravel Sanctum] Fetch a CSRF token before each request, and add it as an X-XSRF-TOKEN header.