Skip to content

Commit

Permalink
Multi-Line comment formatting. (#615)
Browse files Browse the repository at this point in the history
  • Loading branch information
aolives authored Aug 9, 2024
1 parent 76ce7aa commit 28ca3cc
Showing 1 changed file with 28 additions and 29 deletions.
57 changes: 28 additions & 29 deletions config/l5-swagger.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,55 +11,54 @@
'routes' => [
/*
* Route for accessing api documentation interface
*/
*/
'api' => 'api/documentation',
],
'paths' => [
/*
* Edit to include full URL in ui for assets
*/
*/
'use_absolute_path' => env('L5_SWAGGER_USE_ABSOLUTE_PATH', true),

/*
* File name of the generated json documentation file
*/
*/
'docs_json' => 'api-docs.json',

/*
* File name of the generated YAML documentation file
*/
*/
'docs_yaml' => 'api-docs.yaml',

/*
* Set this to `json` or `yaml` to determine which documentation file to use in UI
*/
* Set this to `json` or `yaml` to determine which documentation file to use in UI
*/
'format_to_use_for_docs' => env('L5_FORMAT_TO_USE_FOR_DOCS', 'json'),

/*
* Absolute paths to directory containing the swagger annotations are stored.
*/
*/
'annotations' => [
base_path('app'),
],

],
],
],
'defaults' => [
'routes' => [
/*
* Route for accessing parsed swagger annotations.
*/
*/
'docs' => 'docs',

/*
* Route for Oauth2 authentication callback.
*/
*/
'oauth2_callback' => 'api/oauth2-callback',

/*
* Middleware allows to prevent unexpected access to API documentation
*/
*/
'middleware' => [
'api' => [],
'asset' => [],
Expand All @@ -69,36 +68,36 @@

/*
* Route Group options
*/
*/
'group_options' => [],
],

'paths' => [
/*
* Absolute path to location where parsed annotations will be stored
*/
*/
'docs' => storage_path('api-docs'),

/*
* Absolute path to directory where to export views
*/
*/
'views' => base_path('resources/views/vendor/l5-swagger'),

/*
* Edit to set the api's base path
*/
*/
'base' => env('L5_SWAGGER_BASE_PATH', null),

/*
* Edit to set path where swagger ui assets should be stored
*/
*/
'swagger_ui_assets_path' => env('L5_SWAGGER_UI_ASSETS_PATH', 'vendor/swagger-api/swagger-ui/dist/'),

/*
* Absolute path to directories that should be excluded from scanning
* @deprecated Please use `scanOptions.exclude`
* `scanOptions.exclude` overwrites this
*/
*/
'excludes' => [],
],

Expand Down Expand Up @@ -138,7 +137,7 @@
* Absolute path to directories that should be excluded from scanning
* @note This option overwrites `paths.excludes`
* @see \OpenApi\scan
*/
*/
'exclude' => [],

/*
Expand All @@ -155,7 +154,7 @@
'securitySchemes' => [
/*
* Examples of Security schemes
*/
*/
/*
'api_key_security_example' => [ // Unique name of security
'type' => 'apiKey', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
Expand Down Expand Up @@ -202,7 +201,7 @@
'security' => [
/*
* Examples of Securities
*/
*/
[
/*
'oauth2_security_example' => [
Expand All @@ -219,42 +218,42 @@
/*
* Set this to `true` in development mode so that docs would be regenerated on each request
* Set this to `false` to disable swagger generation on production
*/
*/
'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),

/*
* Set this to `true` to generate a copy of documentation in yaml format
*/
*/
'generate_yaml_copy' => env('L5_SWAGGER_GENERATE_YAML_COPY', false),

/*
* Edit to trust the proxy's ip address - needed for AWS Load Balancer
* string[]
*/
*/
'proxy' => false,

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

/*
* Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically),
* 'method' (sort by HTTP method).
* Default is the order returned by the server unchanged.
*/
*/
'operations_sort' => env('L5_SWAGGER_OPERATIONS_SORT', null),

/*
* Pass the validatorUrl parameter to SwaggerUi init on the JS side.
* A null value here disables validation.
*/
*/
'validator_url' => null,

/*
* Swagger UI configuration parameters
*/
*/
'ui' => [
'display' => [
/*
Expand Down Expand Up @@ -284,8 +283,8 @@

'oauth2' => [
/*
* If set to true, adds PKCE to AuthorizationCodeGrant flow
*/
* If set to true, adds PKCE to AuthorizationCodeGrant flow
*/
'use_pkce_with_authorization_code_grant' => false,
],
],
Expand Down

0 comments on commit 28ca3cc

Please sign in to comment.