Order of examples is (sometimes) not preserved. Fixes #3012

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/GenericParameterService.java

@@ -35,7 +35,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
@@ -452,7 +452,7 @@ else if (parameterInfo.isRequestPart() || ParameterIn.QUERY.toString().equals(pa
 	 * @param parameter    the parameter
 	 */
 	private void setExamples(io.swagger.v3.oas.annotations.Parameter parameterDoc, Parameter parameter) {
-		Map<String, Example> exampleMap = new HashMap<>();
+		Map<String, Example> exampleMap = new LinkedHashMap<>();
 		if (parameterDoc.examples().length == 1 && StringUtils.isBlank(parameterDoc.examples()[0].name())) {
 			Optional<Example> exampleOptional = AnnotationsUtils.getExample(parameterDoc.examples()[0]);
 			exampleOptional.ifPresent(parameter::setExample);

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/app244/HelloController.java

@@ -26,10 +26,13 @@
 
 package test.org.springdoc.api.v31.app244;
 
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.headers.Header;
+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 org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -48,6 +51,16 @@ public class HelloController {
 	)
 	public void uploadMultipartWithBody(){
 	}
-	
+
+	@GetMapping
+	@io.swagger.v3.oas.annotations.Parameter(
+			in = ParameterIn.HEADER,
+			name = "x-header",
+			examples = {
+					@ExampleObject(value = "AAA", name = "First"),
+					@ExampleObject(value = "BBB", name = "Second"),
+					@ExampleObject(value = "CCC", name = "Third")
+			})
+	void nope() {}
 
 }

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.1.0/app244.json

@@ -12,6 +12,37 @@
   ],
   "paths": {
     "/test": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "nope",
+        "parameters": [
+          {
+            "name": "x-header",
+            "in": "header",
+            "examples": {
+              "First": {
+                "description": "First",
+                "value": "AAA"
+              },
+              "Second": {
+                "description": "Second",
+                "value": "BBB"
+              },
+              "Third": {
+                "description": "Third",
+                "value": "CCC"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
       "post": {
         "tags": [
           "hello-controller"