Browse Source

Indicate that relative file paths are supported for file param examples

shalvah 4 years ago
parent
commit
742c1b1dad

+ 1 - 1
docs/documenting/documenting-endpoint-body-parameters.md

@@ -161,7 +161,7 @@ This gives:
 ## Documenting file uploads
 You can document file inputs by using `@bodyParam` or FormRequest rules with a type `file`. You can add a description and example as usual. 
 
-For files, your example should be the absolute path to a file that exists on your machine. If you don't specify an example, Scribe will generate a fake file for example requests and response calls.
+For files, your example should be the path to a file that exists on your machine. This path should be absolute or relative to your project directory. If you don't specify an example, Scribe will generate a fake file for example requests and response calls.
 
 ```php
 /**

+ 1 - 1
docs/documenting/documenting-endpoint-metadata.md

@@ -94,6 +94,6 @@ Similarly, if you have `auth.default` set to `true` in your config, your endpoin
      }
 ```
 
-A "Requires authentication" badge will be added to that route in the generated documentation. 
+A "Requires authentication" badge will be added to that endpoint in the generated documentation. 
 
 ![](../images/endpoint-auth.png)

+ 1 - 1
docs/documenting/documenting-endpoint-responses.md

@@ -135,7 +135,7 @@ The configuration for response calls is located in the `apply.response_calls` se
 .. Tip:: You can also modify the environment directly by using a :code:`.env.docs` file and running :code:`scribe:generate` with :code:`--env docs`.
 ```
 
-- By default, the package will generate dummy values for your documented query, body and file parameters and send in the request. If you specified example values using `@bodyParam` or `@queryParam`, those will be used instead. You can configure additional parameters or overwrite the existing ones for the request in the `response_calls.queryParams`, `response_calls.bodyParams`, and `response_calls.fileParams` sections. For file parameters, each value should be a valid absolute path to a file on the machine.
+- By default, the package will generate dummy values for your documented query, body and file parameters and send in the request. If you specified example values using `@bodyParam` or `@queryParam`, those will be used instead. You can configure additional parameters or overwrite the existing ones for the request in the `response_calls.queryParams`, `response_calls.bodyParams`, and `response_calls.fileParams` sections. For file parameters, each value should be a valid path (absolute or relative to your project directory) to a file on the machine.
 
 ```eval_rst
 .. Note:: If you specified :code:`No-example` for a parameter earlier, it won't be included when making a response call.