Skip to content

Commit 28ca3cc

Browse files
authored
Multi-Line comment formatting. (#615)
1 parent 76ce7aa commit 28ca3cc

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

config/l5-swagger.php

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,55 +11,54 @@
1111
'routes' => [
1212
/*
1313
* Route for accessing api documentation interface
14-
*/
14+
*/
1515
'api' => 'api/documentation',
1616
],
1717
'paths' => [
1818
/*
1919
* Edit to include full URL in ui for assets
20-
*/
20+
*/
2121
'use_absolute_path' => env('L5_SWAGGER_USE_ABSOLUTE_PATH', true),
2222

2323
/*
2424
* File name of the generated json documentation file
25-
*/
25+
*/
2626
'docs_json' => 'api-docs.json',
2727

2828
/*
2929
* File name of the generated YAML documentation file
30-
*/
30+
*/
3131
'docs_yaml' => 'api-docs.yaml',
3232

3333
/*
34-
* Set this to `json` or `yaml` to determine which documentation file to use in UI
35-
*/
34+
* Set this to `json` or `yaml` to determine which documentation file to use in UI
35+
*/
3636
'format_to_use_for_docs' => env('L5_FORMAT_TO_USE_FOR_DOCS', 'json'),
3737

3838
/*
3939
* Absolute paths to directory containing the swagger annotations are stored.
40-
*/
40+
*/
4141
'annotations' => [
4242
base_path('app'),
4343
],
44-
4544
],
4645
],
4746
],
4847
'defaults' => [
4948
'routes' => [
5049
/*
5150
* Route for accessing parsed swagger annotations.
52-
*/
51+
*/
5352
'docs' => 'docs',
5453

5554
/*
5655
* Route for Oauth2 authentication callback.
57-
*/
56+
*/
5857
'oauth2_callback' => 'api/oauth2-callback',
5958

6059
/*
6160
* Middleware allows to prevent unexpected access to API documentation
62-
*/
61+
*/
6362
'middleware' => [
6463
'api' => [],
6564
'asset' => [],
@@ -69,36 +68,36 @@
6968

7069
/*
7170
* Route Group options
72-
*/
71+
*/
7372
'group_options' => [],
7473
],
7574

7675
'paths' => [
7776
/*
7877
* Absolute path to location where parsed annotations will be stored
79-
*/
78+
*/
8079
'docs' => storage_path('api-docs'),
8180

8281
/*
8382
* Absolute path to directory where to export views
84-
*/
83+
*/
8584
'views' => base_path('resources/views/vendor/l5-swagger'),
8685

8786
/*
8887
* Edit to set the api's base path
89-
*/
88+
*/
9089
'base' => env('L5_SWAGGER_BASE_PATH', null),
9190

9291
/*
9392
* Edit to set path where swagger ui assets should be stored
94-
*/
93+
*/
9594
'swagger_ui_assets_path' => env('L5_SWAGGER_UI_ASSETS_PATH', 'vendor/swagger-api/swagger-ui/dist/'),
9695

9796
/*
9897
* Absolute path to directories that should be excluded from scanning
9998
* @deprecated Please use `scanOptions.exclude`
10099
* `scanOptions.exclude` overwrites this
101-
*/
100+
*/
102101
'excludes' => [],
103102
],
104103

@@ -138,7 +137,7 @@
138137
* Absolute path to directories that should be excluded from scanning
139138
* @note This option overwrites `paths.excludes`
140139
* @see \OpenApi\scan
141-
*/
140+
*/
142141
'exclude' => [],
143142

144143
/*
@@ -155,7 +154,7 @@
155154
'securitySchemes' => [
156155
/*
157156
* Examples of Security schemes
158-
*/
157+
*/
159158
/*
160159
'api_key_security_example' => [ // Unique name of security
161160
'type' => 'apiKey', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
@@ -202,7 +201,7 @@
202201
'security' => [
203202
/*
204203
* Examples of Securities
205-
*/
204+
*/
206205
[
207206
/*
208207
'oauth2_security_example' => [
@@ -219,42 +218,42 @@
219218
/*
220219
* Set this to `true` in development mode so that docs would be regenerated on each request
221220
* Set this to `false` to disable swagger generation on production
222-
*/
221+
*/
223222
'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),
224223

225224
/*
226225
* Set this to `true` to generate a copy of documentation in yaml format
227-
*/
226+
*/
228227
'generate_yaml_copy' => env('L5_SWAGGER_GENERATE_YAML_COPY', false),
229228

230229
/*
231230
* Edit to trust the proxy's ip address - needed for AWS Load Balancer
232231
* string[]
233-
*/
232+
*/
234233
'proxy' => false,
235234

236235
/*
237236
* Configs plugin allows to fetch external configs instead of passing them to SwaggerUIBundle.
238237
* See more at: https://github.com/swagger-api/swagger-ui#configs-plugin
239-
*/
238+
*/
240239
'additional_config_url' => null,
241240

242241
/*
243242
* Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically),
244243
* 'method' (sort by HTTP method).
245244
* Default is the order returned by the server unchanged.
246-
*/
245+
*/
247246
'operations_sort' => env('L5_SWAGGER_OPERATIONS_SORT', null),
248247

249248
/*
250249
* Pass the validatorUrl parameter to SwaggerUi init on the JS side.
251250
* A null value here disables validation.
252-
*/
251+
*/
253252
'validator_url' => null,
254253

255254
/*
256255
* Swagger UI configuration parameters
257-
*/
256+
*/
258257
'ui' => [
259258
'display' => [
260259
/*
@@ -284,8 +283,8 @@
284283

285284
'oauth2' => [
286285
/*
287-
* If set to true, adds PKCE to AuthorizationCodeGrant flow
288-
*/
286+
* If set to true, adds PKCE to AuthorizationCodeGrant flow
287+
*/
289288
'use_pkce_with_authorization_code_grant' => false,
290289
],
291290
],

0 commit comments

Comments
 (0)