Pārlūkot izejas kodu

Rename bash to curl

shalvah 5 gadi atpakaļ
vecāks
revīzija
42ffbc9cb2

+ 2 - 2
config/scribe.php

@@ -75,14 +75,14 @@ INTRO
 
     /*
      * Example requests for each endpoint will be shown in each of these languages.
-     * Supported options are: bash, javascript, php, python
+     * Supported options are: curl, javascript, php, python
      * You can add a language of your own, but you must publish the package's views
      * and define a corresponding view for it in the partials/example-requests directory.
      * See https://scribe.readthedocs.io/en/latest/generating-documentation.html
      *
      */
     'example_languages' => [
-        'bash',
+        'curl',
         'javascript',
     ],
 

+ 1 - 1
docs/config.md

@@ -53,7 +53,7 @@ If you want to use this, please note that the image size must be 230 x 52.
 When [documenting your api](documenting.md), you use `@group` annotations to group API endpoints. Endpoints which do not have a group annotation will be grouped under the `default_group`. Defaults to **"general"**.
 
 ## `example_languages`
-For each endpoint, an example request is shown in each of the languages specified in this array. Currently only `bash`, `javascript`, `php` and `python` are supported. You can add your own language, but you must also define the corresponding view (see [Specifying languages for examples](generating-documentation.html#specifying-language-for-examples)). Default: `["bash", "javascript"]` 
+For each endpoint, an example request is shown in each of the languages specified in this array. Currently only `curl`, `javascript`, `php` and `python` are supported. You can add your own language, but you must also define the corresponding view (see [Specifying languages for examples](generating-documentation.html#specifying-language-for-examples)). Default: `["curl", "javascript"]` 
  
 ##  `faker_seed`
 When generating example requests, this package uses fzanninoto/faker to generate random values. If you would like the package to generate the same example values for parameters on each run, set this to any number (eg. 1234). (Note: alternatively, you can set example values for parameters when [documenting them.](documenting.html#specifying-request-parameters))

+ 1 - 0
docs/migrating.md

@@ -33,6 +33,7 @@ _After you've done all of the above_, delete your `resources/docs/` and `public/
 
 ## Key changes
 ### High impact
+- If you're using `bash` as one of your example_languages, you should rename it to `curl`. If you've published the vendor views, rename the corresponding Blade file (should be `resources/views/vendor/scribe/partials/example-requests/bash.blade.php`).
 - The `laravel.autoload` key is now `laravel.add_routes`, and is `true` by default.
 - The `laravel.docs_url` key is now `/docs` by default (no longer `/doc`). This means if you're using `laravel` docs type, your docs will be at <your-app>/docs and <your-app>/docs.json.
 - The Markdown output is now a set of files, located in `resources/docs`. The route files are located in `resources/docs/groups` and are split by groups (1 group per file).

+ 0 - 0
resources/views/partials/example-requests/bash.blade.php → resources/views/partials/example-requests/curl.blade.php