Endpoint parameters are translated even if they should not. fixes #1331

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/PropertyResolverUtils.java

@@ -45,6 +45,11 @@ public class PropertyResolverUtils {
 	 */
 	private final MessageSource messageSource;
 
+	/**
+	 * The Spring doc config properties.
+	 */
+	private final SpringDocConfigProperties springDocConfigProperties;
+
 	/**
 	 * The constant LOGGER.
 	 */
@@ -55,10 +60,12 @@ public class PropertyResolverUtils {
 	 *
 	 * @param factory the factory
 	 * @param messageSource the message source
+	 * @param springDocConfigProperties the spring doc config properties
 	 */
-	public PropertyResolverUtils(ConfigurableBeanFactory factory, MessageSource messageSource) {
+	public PropertyResolverUtils(ConfigurableBeanFactory factory, MessageSource messageSource, SpringDocConfigProperties springDocConfigProperties) {
 		this.factory = factory;
 		this.messageSource = messageSource;
+		this.springDocConfigProperties = springDocConfigProperties;
 	}
 
 	/**
@@ -69,12 +76,13 @@ public PropertyResolverUtils(ConfigurableBeanFactory factory, MessageSource mess
 	 * @return the string
 	 */
 	public String resolve(String parameterProperty, Locale locale) {
-		try {
-			return messageSource.getMessage(parameterProperty, null, locale);
-		}
-		catch (NoSuchMessageException ex) {
-			LOGGER.trace(ex.getMessage());
-		}
+		if (!springDocConfigProperties.isDisableI18n())
+			try {
+				return messageSource.getMessage(parameterProperty, null, locale);
+			}
+			catch (NoSuchMessageException ex) {
+				LOGGER.trace(ex.getMessage());
+			}
 		try {
 			return factory.resolveEmbeddedValue(parameterProperty);
 		}

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -167,6 +167,11 @@ public class SpringDocConfigProperties {
 	 */
 	protected Boolean enableNativeImageSupport;
 
+	/**
+	 * The Disable i18n.
+	 */
+	private boolean disableI18n;
+
 	/**
 	 * Gets enable native image support.
 	 *
@@ -626,6 +631,24 @@ public void setPreLoadingEnabled(boolean preLoadingEnabled) {
 		this.preLoadingEnabled = preLoadingEnabled;
 	}
 
+	/**
+	 * Is disable i 18 n boolean.
+	 *
+	 * @return the boolean
+	 */
+	public boolean isDisableI18n() {
+		return disableI18n;
+	}
+
+	/**
+	 * Sets disable i 18 n.
+	 *
+	 * @param disableI18n the disable i 18 n
+	 */
+	public void setDisableI18n(boolean disableI18n) {
+		this.disableI18n = disableI18n;
+	}
+
 	/**
 	 * Is pre loading enabled boolean.
 	 *

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

@@ -253,11 +253,12 @@ OperationService operationBuilder(GenericParameterService parameterBuilder, Requ
 	 *
 	 * @param factory the factory
 	 * @param messageSource the message source
+	 * @param springDocConfigProperties the spring doc config properties
 	 * @return the property resolver utils
 	 */
 	@Bean
-	PropertyResolverUtils propertyResolverUtils(ConfigurableBeanFactory factory, MessageSource messageSource) {
-		return new PropertyResolverUtils(factory, messageSource);
+	PropertyResolverUtils propertyResolverUtils(ConfigurableBeanFactory factory, MessageSource messageSource, SpringDocConfigProperties springDocConfigProperties) {
+		return new PropertyResolverUtils(factory, messageSource,springDocConfigProperties);
 	}
 
 	/**

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app167/HelloController.java

@@ -0,0 +1,23 @@
+package test.org.springdoc.api.app167;
+
+import io.swagger.v3.oas.annotations.Parameter;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * @author bnasslahsen
+ */
+@RestController
+@RequestMapping("/api")
+public class HelloController {
+
+	@GetMapping("/sample1")
+	public ResponseEntity sample1(@Parameter(name="mySample") String mySample) {
+		throw new UnsupportedOperationException("the body is not relevant now");
+	}
+
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app167/SpringDocApp167Test.java

@@ -0,0 +1,34 @@
+/*
+ *
+ *  * Copyright 2019-2021 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app167;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+
+@TestPropertySource(properties = "springdoc.disable-i18n=true")
+public class SpringDocApp167Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/resources/messages.properties

@@ -1,4 +1,5 @@
 greeting=Hello! Welcome to our website!
 lang.change=Change the language
 lang.eng=English
-lang.fr=French
+lang.fr=French
+mySample=toto

springdoc-openapi-webmvc-core/src/test/resources/results/app167.json

@@ -0,0 +1,46 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/api/sample1": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "sample1",
+        "parameters": [
+          {
+            "name": "mySample",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}