Warning on referenced example. Fixes #437

Author: bnasslahsen

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

@@ -135,7 +135,13 @@ private static void setExamples(MediaType mediaType, ExampleObject[] examples) {
 		}
 		else {
 			for (ExampleObject example : examples) {
-				getExample(example).ifPresent(exampleObject -> mediaType.addExamples(example.name(), exampleObject));
+				getExample(example).ifPresent(exampleObject -> {
+							if (exampleObject.get$ref() != null)
+								//Ignore description
+								exampleObject.setDescription(null);
+							mediaType.addExamples(example.name(), exampleObject);
+						}
+				);
 			}
 		}
 	}

springdoc-openapi-data-rest/src/main/java/org/springdoc/core/SpringDocDataRestConfiguration.java

@@ -28,8 +28,8 @@
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import org.springdoc.core.converters.Pageable;
-import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.converters.RepresentationModelLinksOASMixin;
+import org.springdoc.core.customizers.OpenApiCustomiser;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

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

@@ -0,0 +1,38 @@
+/*
+ *
+ *  * Copyright 2019-2020 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.app90;
+
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping("/test")
+	@ApiResponses(value = { @ApiResponse(description = "successful operation", content = { @Content(examples = @ExampleObject(name = "500", ref = "#/components/examples/http500Example"), mediaType = "application/json", schema = @Schema(implementation = User.class)), @Content(mediaType = "application/xml", schema = @Schema(implementation = User.class)) }) })
+	public void test1(String hello) {
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app90/SpringDocApp90Test.java

@@ -0,0 +1,26 @@
+/*
+ *
+ *  * Copyright 2019-2020 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.app90;
+
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+public class SpringDocApp90Test extends AbstractSpringDocTest {
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app90/SpringDocTestApp.java

@@ -0,0 +1,73 @@
+/*
+ *
+ *  * Copyright 2019-2020 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.app90;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.io.UncheckedIOException;
+import java.util.AbstractMap;
+import java.util.Collection;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import io.swagger.v3.oas.models.examples.Example;
+import org.springdoc.core.customizers.OpenApiCustomiser;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.core.io.Resource;
+import org.springframework.util.FileCopyUtils;
+
+@SpringBootApplication
+class SpringDocTestApp {
+
+	@Value("classpath:/500-90.json")
+	private Resource http500ExampleResource;
+
+
+	@Bean
+	public OpenApiCustomiser openApiCustomiser(Collection<Entry<String, Example>> examples) {
+		return openAPI -> {
+			examples.forEach(example -> {
+				openAPI.getComponents().addExamples(example.getKey(), example.getValue());
+			});
+		};
+	}
+
+	@Bean
+	public Map.Entry<String, Example> http500Example() {
+		Example http500Example = new Example();
+		Map.Entry<String, Example> entry = new AbstractMap.SimpleEntry<String, Example>("http500Example", http500Example);
+		http500Example.setSummary("HTTP 500 JSON Body response example");
+		http500Example.setDescription(
+				"An example of HTTP response in case an error occurs on server side. instance attribute reference a traceId to ease server side analysis.");
+		http500Example.setValue(asString(http500ExampleResource));
+		return entry;
+	}
+
+	public static String asString(Resource resource) {
+		try (Reader reader = new InputStreamReader(resource.getInputStream())) {
+			return FileCopyUtils.copyToString(reader);
+		} catch (IOException e) {
+			throw new UncheckedIOException(e);
+		}
+	}
+}