From 028706625dd7974af50fe010879267a8fb4a304c Mon Sep 17 00:00:00 2001 From: chris cnizzardini Date: Thu, 10 Sep 2020 17:49:14 -0400 Subject: [PATCH] config instruction improvements --- assets/swagger_bake.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/assets/swagger_bake.php b/assets/swagger_bake.php index eaf5de1e..225263d6 100644 --- a/assets/swagger_bake.php +++ b/assets/swagger_bake.php @@ -4,13 +4,13 @@ * # REQUIRED SETTINGS: * ################################ * - * @var string $prefix: The relative path that SwaggerBake will scan for your APIs routes (e.g. `/api/`) + * @var string $prefix: The route scope that SwaggerBake will scan for your APIs routes (e.g. `/api/`) * * @var string $yml: A base Swagger YML file, see example in assets (e.g. `/config/swagger.yml`). * - * @var string $json: JSON file loaded by the Swagger UI client (e.g. `/webroot/swagger.json`). + * @var string $json: Web accessible file path the JSON file is written to (e.g. `/webroot/swagger.json`). * - * @var string $webPath: The path browsers will use to access the JSON file (e.g. `/swagger.json`). + * @var string $webPath: The URL browsers will use to access the JSON file (e.g. `/swagger.json`). * * ################################ * # RECOMMENDED SETTINGS: