diff --git a/openapi-security/src/main/resources/config/security.yml b/openapi-security/src/main/resources/config/security.yml index 79927cdb..4bd61a29 100644 --- a/openapi-security/src/main/resources/config/security.yml +++ b/openapi-security/src/main/resources/config/security.yml @@ -1,6 +1,9 @@ -# Security configuration in light framework. This is a generic security config -# for all frameworks. In most cases, you should just use this file if you have -# only one framework in your server instance. +# This is a generic security config for all frameworks. You should use the +# openapi-security.yml which is specific for OpenAPI 3.0 framework. The +# openapi-security.yml is introduced to support multiple frameworks in the +# same server instance and it is recommended. The security.yml will be loaded +# if openapi-security.yml cannot be found for backward compatibility and it +# might be removed in the next major release. --- # Enable JWT verification flag. enableVerifyJwt: true diff --git a/openapi-security/src/test/resources/config/openapi-security.yml b/openapi-security/src/test/resources/config/openapi-security.yml index f227d4d9..78def547 100644 --- a/openapi-security/src/test/resources/config/openapi-security.yml +++ b/openapi-security/src/test/resources/config/openapi-security.yml @@ -1,7 +1,7 @@ # Security configuration for openapi-security in light-rest-4j. It is a specific config -# for OpenAPI framework and it can be used if you have other frameworks running in the -# same server instance and their security configurations are different then the OpenAPI. -# If this file cannot be found, the generic security.yml will be loaded as a fallback. +# for OpenAPI framework security. It is introduced to support multiple frameworks in the +# same server instance. If this file cannot be found, the generic security.yml will be +# loaded for backward compatibility. --- # Enable JWT verification flag. enableVerifyJwt: true diff --git a/openapi-validator/src/main/resources/config/validator.yml b/openapi-validator/src/main/resources/config/validator.yml index cf9c995f..0fb4398d 100644 --- a/openapi-validator/src/main/resources/config/validator.yml +++ b/openapi-validator/src/main/resources/config/validator.yml @@ -1,5 +1,7 @@ -# A generic light-4j framework validator configuration. If multiple frameworks are used in the -# same server instance and they have different configurations. You can use openapi-validator.yml +# A generic light-4j framework validator configuration. There is another openapi-validator.yml which +# is introduced to support multiple frameworks in the same server instance and it is recommended. The +# validator.yml will be loaded if openapi-validator.yml cannot be found for backward compatibility +# and it might be removed in the next major release. --- # Enable request validation. Response validation is not done on the server but client. enabled: true diff --git a/openapi-validator/src/test/resources/config/openapi-validator.yml b/openapi-validator/src/test/resources/config/openapi-validator.yml index 961040c8..a37638ab 100644 --- a/openapi-validator/src/test/resources/config/openapi-validator.yml +++ b/openapi-validator/src/test/resources/config/openapi-validator.yml @@ -1,6 +1,6 @@ -# This is specific OpenAPI validator configuration file. It should be used if you have multiple -# frameworks implemented in the same server instance and they all need to have different validator -# configurations. If they share the same validator.yml then you can still use that one. +# This is specific OpenAPI validator configuration file. It is introduced to support multiple +# frameworks in the same server instance and it is recommended. If this file cannot be found, +# the generic validator.yml will be loaded as a fallback. --- # Enable request validation. Response validation is not done on the server but client. enabled: true diff --git a/swagger-security/src/main/resources/config/security.yml b/swagger-security/src/main/resources/config/security.yml index 79927cdb..58449042 100644 --- a/swagger-security/src/main/resources/config/security.yml +++ b/swagger-security/src/main/resources/config/security.yml @@ -1,6 +1,9 @@ -# Security configuration in light framework. This is a generic security config -# for all frameworks. In most cases, you should just use this file if you have -# only one framework in your server instance. +# This is a generic security config for all frameworks. You should use the +# swagger-security.yml which is specific for Swagger 2.0 framework. The +# swagger-security.yml is introduced to support multiple frameworks in the +# same server instance and it is recommended. The security.yml will be loaded +# if swagger-security.yml cannot be found for backward compatibility and it +# might be removed in the next major release. --- # Enable JWT verification flag. enableVerifyJwt: true diff --git a/swagger-security/src/test/resources/config/swagger-security.yml b/swagger-security/src/test/resources/config/swagger-security.yml index d808d1db..71e0beb3 100644 --- a/swagger-security/src/test/resources/config/swagger-security.yml +++ b/swagger-security/src/test/resources/config/swagger-security.yml @@ -1,7 +1,7 @@ # Security configuration for swagger-security in light-rest-4j. It is a specific config -# for Swagger framework and it can be used if you have other frameworks running in the -# same server instance and their security configurations are different then the Swagger. -# If this file cannot be found, the generic security.yml will be loaded as a fallback. +# for Swagger framework security. It is introduced to support multiple frameworks in the +# same server instance. If this file cannot be found, the generic security.yml will be +# loaded for backward compatibility. --- # Enable JWT verification flag. enableVerifyJwt: true diff --git a/swagger-validator/src/main/resources/config/validator.yml b/swagger-validator/src/main/resources/config/validator.yml index 3ada0a38..4e110623 100644 --- a/swagger-validator/src/main/resources/config/validator.yml +++ b/swagger-validator/src/main/resources/config/validator.yml @@ -1,5 +1,7 @@ -# A generic light-4j framework validator configuration. If multiple frameworks are used in the -# same server instance and they have different configurations. You can use swagger-validator.yml +# A generic light-4j framework validator configuration. There is another swagger-validator.yml which +# is introduced to support multiple frameworks in the same server instance and it is recommended. The +# validator.yml will be loaded if swagger-validator.yml cannot be found for backward compatibility +# and it might be removed in the next major release. --- # Enable request validation. Response validation is not done on the server but client. enabled: true diff --git a/swagger-validator/src/test/resources/config/swagger-validator.yml b/swagger-validator/src/test/resources/config/swagger-validator.yml index 8ddafd79..78db16de 100644 --- a/swagger-validator/src/test/resources/config/swagger-validator.yml +++ b/swagger-validator/src/test/resources/config/swagger-validator.yml @@ -1,6 +1,6 @@ -# This is specific Swagger validator configuration file. It should be used if you have multiple -# frameworks implemented in the same server instance and they all need to have different validator -# configurations. If they share the same validator.yml then you can still use that one. +# This is specific Swagger validator configuration file. It is introduced to support multiple +# frameworks in the same server instance and it is recommended. If this file cannot be found, +# the generic validator.yml will be loaded as a fallback. --- # Enable request validation. Response validation is not done on the server but client. enabled: true