Fix generated openapi.json parameter names (#600)

rbygrave · web-flow · commit c25de392f0d3 · 2025-04-30T00:17:38.000+12:00
* Fix generated openapi.json parameter names

* Fix generated openapi.json parameter names
diff --git a/http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/MethodParamDocBuilder.java b/http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/MethodParamDocBuilder.java
@@ -51,7 +51,7 @@ public void build() {
 
     } else {
       Parameter param = new Parameter();
-      param.setName(varName);
+      param.setName(paramName);
       param.setDescription(javadoc.getParams().get(paramName));
 
       Schema<?> schema = ctx.toSchema(rawType, element);
diff --git a/tests/test-javalin-jsonb/src/main/resources/public/openapi.json b/tests/test-javalin-jsonb/src/main/resources/public/openapi.json
@@ -393,7 +393,7 @@
 						}
 					},
 					{
-						"name" : "myParam",
+						"name" : "my-param",
 						"in" : "query",
 						"schema" : {
 							"type" : "string"
@@ -779,7 +779,7 @@
 						}
 					},
 					{
-						"name" : "head",
+						"name" : "Head",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
@@ -994,21 +994,21 @@
 						}
 					},
 					{
-						"name" : "param2",
+						"name" : "q-2",
 						"in" : "query",
 						"schema" : {
 							"type" : "string"
 						}
 					},
 					{
-						"name" : "contentLength",
+						"name" : "Content-Length",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
 						}
 					},
 					{
-						"name" : "otherHeader",
+						"name" : "x-oh",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
@@ -1746,7 +1746,7 @@
 				"description" : "",
 				"parameters" : [
 					{
-						"name" : "head",
+						"name" : "Head",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
diff --git a/tests/test-javalin-jsonb/src/test/resources/expectedOpenApi.json b/tests/test-javalin-jsonb/src/test/resources/expectedOpenApi.json
@@ -42,21 +42,21 @@
             }
           },
           {
-            "name" : "param2",
+            "name" : "q-2",
             "in" : "query",
             "schema" : {
               "type" : "string"
             }
           },
           {
-            "name" : "contentLength",
+            "name" : "Content-Length",
             "in" : "header",
             "schema" : {
               "type" : "string"
             }
           },
           {
-            "name" : "otherHeader",
+            "name" : "x-oh",
             "in" : "header",
             "schema" : {
               "type" : "string"
diff --git a/tests/test-javalin/src/main/resources/public/openapi.json b/tests/test-javalin/src/main/resources/public/openapi.json
@@ -363,7 +363,7 @@
 						}
 					},
 					{
-						"name" : "myParam",
+						"name" : "my-param",
 						"in" : "query",
 						"schema" : {
 							"type" : "string"
diff --git a/tests/test-jex/src/main/resources/public/openapi.json b/tests/test-jex/src/main/resources/public/openapi.json
@@ -432,7 +432,7 @@
 						}
 					},
 					{
-						"name" : "myParam",
+						"name" : "my-param",
 						"in" : "query",
 						"schema" : {
 							"type" : "string"
@@ -908,7 +908,7 @@
 						}
 					},
 					{
-						"name" : "head",
+						"name" : "Head",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
diff --git a/tests/test-nima-jsonb/src/test/resources/expectedOpenApi.json b/tests/test-nima-jsonb/src/test/resources/expectedOpenApi.json
@@ -21,7 +21,7 @@
 		"/openapi/delete/{type}" : {
 			"delete" : {
 				"tags" : [
-					
+
 				],
 				"summary" : "",
 				"description" : "",
@@ -42,7 +42,7 @@
 						}
 					},
 					{
-						"name" : "header",
+						"name" : "Header",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
@@ -66,7 +66,7 @@
 		"/openapi/get" : {
 			"get" : {
 				"tags" : [
-					
+
 				],
 				"summary" : "Example of Open API Get (up to the first period is the summary)",
 				"description" : "When using Javalin Context only This Javadoc description is added to the generated openapi.json",
@@ -142,7 +142,7 @@
 		"/openapi/post1" : {
 			"post" : {
 				"tags" : [
-					
+
 				],
 				"summary" : "Standard Post",
 				"description" : "The Deprecated annotation adds \"deprecacted:true\" to the generated json",
@@ -191,7 +191,7 @@
 		"/openapi/put" : {
 			"put" : {
 				"tags" : [
-					
+
 				],
 				"summary" : "",
 				"description" : "",
@@ -256,4 +256,4 @@
 			}
 		}
 	}
-}
+}
diff --git a/tests/test-sigma/src/main/resources/public/openapi.json b/tests/test-sigma/src/main/resources/public/openapi.json
@@ -393,7 +393,7 @@
 						}
 					},
 					{
-						"name" : "myParam",
+						"name" : "my-param",
 						"in" : "query",
 						"schema" : {
 							"type" : "string"
@@ -779,7 +779,7 @@
 						}
 					},
 					{
-						"name" : "head",
+						"name" : "Head",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"
@@ -1584,7 +1584,7 @@
 				"description" : "",
 				"parameters" : [
 					{
-						"name" : "head",
+						"name" : "Head",
 						"in" : "header",
 						"schema" : {
 							"type" : "string"

Original file line number	Diff line number	Diff line change
`@@ -393,7 +393,7 @@`
`393`	`393`	`}`
`394`	`394`	`},`
`395`	`395`	`{`
`396`		`- "name" : "myParam",`
	`396`	`+ "name" : "my-param",`
`397`	`397`	`"in" : "query",`
`398`	`398`	`"schema" : {`
`399`	`399`	`"type" : "string"`
`@@ -779,7 +779,7 @@`
`779`	`779`	`}`
`780`	`780`	`},`
`781`	`781`	`{`
`782`		`- "name" : "head",`
	`782`	`+ "name" : "Head",`
`783`	`783`	`"in" : "header",`
`784`	`784`	`"schema" : {`
`785`	`785`	`"type" : "string"`
`@@ -994,21 +994,21 @@`
`994`	`994`	`}`
`995`	`995`	`},`
`996`	`996`	`{`
`997`		`- "name" : "param2",`
	`997`	`+ "name" : "q-2",`
`998`	`998`	`"in" : "query",`
`999`	`999`	`"schema" : {`
`1000`	`1000`	`"type" : "string"`
`1001`	`1001`	`}`
`1002`	`1002`	`},`
`1003`	`1003`	`{`
`1004`		`- "name" : "contentLength",`
	`1004`	`+ "name" : "Content-Length",`
`1005`	`1005`	`"in" : "header",`
`1006`	`1006`	`"schema" : {`
`1007`	`1007`	`"type" : "string"`
`1008`	`1008`	`}`
`1009`	`1009`	`},`
`1010`	`1010`	`{`
`1011`		`- "name" : "otherHeader",`
	`1011`	`+ "name" : "x-oh",`
`1012`	`1012`	`"in" : "header",`
`1013`	`1013`	`"schema" : {`
`1014`	`1014`	`"type" : "string"`
`@@ -1746,7 +1746,7 @@`
`1746`	`1746`	`"description" : "",`
`1747`	`1747`	`"parameters" : [`
`1748`	`1748`	`{`
`1749`		`- "name" : "head",`
	`1749`	`+ "name" : "Head",`
`1750`	`1750`	`"in" : "header",`
`1751`	`1751`	`"schema" : {`
`1752`	`1752`	`"type" : "string"`
Original file line number	Diff line number	Diff line change
`@@ -42,21 +42,21 @@`
`42`	`42`	`}`
`43`	`43`	`},`
`44`	`44`	`{`
`45`		`- "name" : "param2",`
	`45`	`+ "name" : "q-2",`
`46`	`46`	`"in" : "query",`
`47`	`47`	`"schema" : {`
`48`	`48`	`"type" : "string"`
`49`	`49`	`}`
`50`	`50`	`},`
`51`	`51`	`{`
`52`		`- "name" : "contentLength",`
	`52`	`+ "name" : "Content-Length",`
`53`	`53`	`"in" : "header",`
`54`	`54`	`"schema" : {`
`55`	`55`	`"type" : "string"`
`56`	`56`	`}`
`57`	`57`	`},`
`58`	`58`	`{`
`59`		`- "name" : "otherHeader",`
	`59`	`+ "name" : "x-oh",`
`60`	`60`	`"in" : "header",`
`61`	`61`	`"schema" : {`
`62`	`62`	`"type" : "string"`
Original file line number	Diff line number	Diff line change
`@@ -363,7 +363,7 @@`
`363`	`363`	`}`
`364`	`364`	`},`
`365`	`365`	`{`
`366`		`- "name" : "myParam",`
	`366`	`+ "name" : "my-param",`
`367`	`367`	`"in" : "query",`
`368`	`368`	`"schema" : {`
`369`	`369`	`"type" : "string"`
Original file line number	Diff line number	Diff line change
`@@ -432,7 +432,7 @@`
`432`	`432`	`}`
`433`	`433`	`},`
`434`	`434`	`{`
`435`		`- "name" : "myParam",`
	`435`	`+ "name" : "my-param",`
`436`	`436`	`"in" : "query",`
`437`	`437`	`"schema" : {`
`438`	`438`	`"type" : "string"`
`@@ -908,7 +908,7 @@`
`908`	`908`	`}`
`909`	`909`	`},`
`910`	`910`	`{`
`911`		`- "name" : "head",`
	`911`	`+ "name" : "Head",`
`912`	`912`	`"in" : "header",`
`913`	`913`	`"schema" : {`
`914`	`914`	`"type" : "string"`