|
4 | 4 |
|
5 | 5 | /* |
6 | 6 | * The output path for the generated documentation. |
| 7 | + * This path should be relative to the root of your application. |
7 | 8 | */ |
8 | 9 | 'output' => 'public/docs', |
9 | 10 |
|
|
168 | 169 | ], |
169 | 170 |
|
170 | 171 | /* |
171 | | - * Custom logo path. Will be copied during generate command. Set this to false to use the default logo. |
| 172 | + * Custom logo path. The logo will be copied from this location |
| 173 | + * during the generate process. Set this to false to use the default logo. |
172 | 174 | * |
173 | 175 | * Change to an absolute path to use your custom logo. For example: |
174 | 176 | * 'logo' => resource_path('views') . '/api/logo.png' |
175 | 177 | * |
176 | 178 | * If you want to use this, please be aware of the following rules: |
177 | | - * - size: 230 x 52 |
| 179 | + * - the image size must be 230 x 52 |
178 | 180 | */ |
179 | 181 | 'logo' => false, |
180 | 182 |
|
181 | 183 | /* |
182 | 184 | * Name for the group of routes which do not have a @group set. |
183 | 185 | */ |
184 | | - 'ungrouped_name' => 'general', |
| 186 | + 'default_group' => 'general', |
185 | 187 |
|
186 | 188 | /* |
187 | 189 | * Configure how responses are transformed using @transformer and @transformerCollection |
188 | 190 | * Requires league/fractal package: composer require league/fractal |
189 | 191 | * |
190 | | - * If you are using a custom serializer with league/fractal, |
191 | | - * you can specify it here. |
192 | | - * |
193 | | - * Serializers included with league/fractal: |
194 | | - * - \League\Fractal\Serializer\ArraySerializer::class |
195 | | - * - \League\Fractal\Serializer\DataArraySerializer::class |
196 | | - * - \League\Fractal\Serializer\JsonApiSerializer::class |
197 | | - * |
198 | | - * Leave as null to use no serializer or return a simple JSON. |
199 | 192 | */ |
200 | 193 | 'fractal' => [ |
| 194 | + /* If you are using a custom serializer with league/fractal, |
| 195 | + * you can specify it here. |
| 196 | + * |
| 197 | + * Serializers included with league/fractal: |
| 198 | + * - \League\Fractal\Serializer\ArraySerializer::class |
| 199 | + * - \League\Fractal\Serializer\DataArraySerializer::class |
| 200 | + * - \League\Fractal\Serializer\JsonApiSerializer::class |
| 201 | + * |
| 202 | + * Leave as null to use no serializer or return a simple JSON. |
| 203 | + */ |
201 | 204 | 'serializer' => null, |
202 | 205 | ], |
203 | | - |
204 | | - /* |
205 | | - * If you would like the package to generate the same example values for parameters on each run, |
206 | | - * set this to any number (eg. 1234) |
207 | | - */ |
208 | | - 'faker_seed' => null, |
209 | 206 | ]; |
0 commit comments