OpenAPI documents support enumeration types

kevin70 · kevin70 · commit 486590240287 · 2023-03-09T11:27:19.000+08:00
diff --git a/http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/OpenAPISerializer.java b/http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/OpenAPISerializer.java
@@ -81,7 +81,7 @@ static String serialize(Object obj) throws IllegalAccessException {
               sb.append(",");
             }
             sb.append("\"");
-            sb.append(field.getName());
+            sb.append(field.getName().replace("_enum", "enum"));
             sb.append("\" : ");
             write(sb, value);
             firstField = false;
diff --git a/tests/test-javalin-jsonb/src/main/resources/public/openapi.json b/tests/test-javalin-jsonb/src/main/resources/public/openapi.json
@@ -1,18 +1,18 @@
 {
 	"openapi" : "3.0.1",
 	"info" : {
-		"title" : "Example service showing off the Path extension method of controller",
+		"title" : "Example service",
 		"description" : "Example Javalin controllers with Java and Maven",
 		"version" : ""
 	},
 	"tags" : [
 		{
 			"name" : "tag1",
-			"description" : "this is added to openapi tags"
+			"description" : "it's somethin"
 		},
 		{
 			"name" : "tag1",
-			"description" : "it's somethin"
+			"description" : "this is added to openapi tags"
 		}
 	],
 	"paths" : {
@@ -1156,7 +1156,12 @@
 										"type" : "string"
 									},
 									"type" : {
-										"$ref" : "#/components/schemas/ServerType"
+										"type" : "string",
+										"enum" : [
+											"PROXY",
+											"HIDE_N_SEEK",
+											"FFA"
+										]
 									}
 								}
 							}
@@ -1195,7 +1200,12 @@
 										"type" : "string"
 									},
 									"type" : {
-										"$ref" : "#/components/schemas/ServerType"
+										"type" : "string",
+										"enum" : [
+											"PROXY",
+											"HIDE_N_SEEK",
+											"FFA"
+										]
 									}
 								}
 							}
@@ -1229,7 +1239,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -1261,7 +1276,12 @@
 						"schema" : {
 							"type" : "array",
 							"items" : {
-								"$ref" : "#/components/schemas/ServerType"
+								"type" : "string",
+								"enum" : [
+									"PROXY",
+									"HIDE_N_SEEK",
+									"FFA"
+								]
 							}
 						}
 					}
@@ -1299,7 +1319,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -1903,9 +1928,6 @@
 					}
 				}
 			},
-			"ServerType" : {
-				"type" : "object"
-			},
 			"byte" : {
 				"type" : "object"
 			}
diff --git a/tests/test-jex/src/main/resources/public/openapi.json b/tests/test-jex/src/main/resources/public/openapi.json
@@ -190,7 +190,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -222,7 +227,12 @@
 						"schema" : {
 							"type" : "array",
 							"items" : {
-								"$ref" : "#/components/schemas/ServerType"
+								"type" : "string",
+								"enum" : [
+									"PROXY",
+									"HIDE_N_SEEK",
+									"FFA"
+								]
 							}
 						}
 					}
@@ -260,7 +270,12 @@
 						"name" : "type",
 						"in" : "query",
 						"schema" : {
-							"$ref" : "#/components/schemas/ServerType"
+							"type" : "string",
+							"enum" : [
+								"PROXY",
+								"HIDE_N_SEEK",
+								"FFA"
+							]
 						}
 					}
 				],
@@ -363,11 +378,16 @@
 					"name" : {
 						"type" : "string",
 						"nullable" : false
+					},
+					"serverType" : {
+						"type" : "string",
+						"enum" : [
+							"PROXY",
+							"HIDE_N_SEEK",
+							"FFA"
+						]
 					}
 				}
-			},
-			"ServerType" : {
-				"type" : "object"
 			}
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ static String serialize(Object obj) throws IllegalAccessException {`
`81`	`81`	`sb.append(",");`
`82`	`82`	`}`
`83`	`83`	`sb.append("\"");`
`84`		`- sb.append(field.getName());`
	`84`	`+ sb.append(field.getName().replace("_enum", "enum"));`
`85`	`85`	`sb.append("\" : ");`
`86`	`86`	`write(sb, value);`
`87`	`87`	`firstField = false;`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`	`1`	`{`
`2`	`2`	`"openapi" : "3.0.1",`
`3`	`3`	`"info" : {`
`4`		`- "title" : "Example service showing off the Path extension method of controller",`
	`4`	`+ "title" : "Example service",`
`5`	`5`	`"description" : "Example Javalin controllers with Java and Maven",`
`6`	`6`	`"version" : ""`
`7`	`7`	`},`
`8`	`8`	`"tags" : [`
`9`	`9`	`{`
`10`	`10`	`"name" : "tag1",`
`11`		`- "description" : "this is added to openapi tags"`
	`11`	`+ "description" : "it's somethin"`
`12`	`12`	`},`
`13`	`13`	`{`
`14`	`14`	`"name" : "tag1",`
`15`		`- "description" : "it's somethin"`
	`15`	`+ "description" : "this is added to openapi tags"`
`16`	`16`	`}`
`17`	`17`	`],`
`18`	`18`	`"paths" : {`
`@@ -1156,7 +1156,12 @@`
`1156`	`1156`	`"type" : "string"`
`1157`	`1157`	`},`
`1158`	`1158`	`"type" : {`
`1159`		`- "$ref" : "#/components/schemas/ServerType"`
	`1159`	`+ "type" : "string",`
	`1160`	`+ "enum" : [`
	`1161`	`+ "PROXY",`
	`1162`	`+ "HIDE_N_SEEK",`
	`1163`	`+ "FFA"`
	`1164`	`+ ]`
`1160`	`1165`	`}`
`1161`	`1166`	`}`
`1162`	`1167`	`}`
`@@ -1195,7 +1200,12 @@`
`1195`	`1200`	`"type" : "string"`
`1196`	`1201`	`},`
`1197`	`1202`	`"type" : {`
`1198`		`- "$ref" : "#/components/schemas/ServerType"`
	`1203`	`+ "type" : "string",`
	`1204`	`+ "enum" : [`
	`1205`	`+ "PROXY",`
	`1206`	`+ "HIDE_N_SEEK",`
	`1207`	`+ "FFA"`
	`1208`	`+ ]`
`1199`	`1209`	`}`
`1200`	`1210`	`}`
`1201`	`1211`	`}`
`@@ -1229,7 +1239,12 @@`
`1229`	`1239`	`"name" : "type",`
`1230`	`1240`	`"in" : "query",`
`1231`	`1241`	`"schema" : {`
`1232`		`- "$ref" : "#/components/schemas/ServerType"`
	`1242`	`+ "type" : "string",`
	`1243`	`+ "enum" : [`
	`1244`	`+ "PROXY",`
	`1245`	`+ "HIDE_N_SEEK",`
	`1246`	`+ "FFA"`
	`1247`	`+ ]`
`1233`	`1248`	`}`
`1234`	`1249`	`}`
`1235`	`1250`	`],`
`@@ -1261,7 +1276,12 @@`
`1261`	`1276`	`"schema" : {`
`1262`	`1277`	`"type" : "array",`
`1263`	`1278`	`"items" : {`
`1264`		`- "$ref" : "#/components/schemas/ServerType"`
	`1279`	`+ "type" : "string",`
	`1280`	`+ "enum" : [`
	`1281`	`+ "PROXY",`
	`1282`	`+ "HIDE_N_SEEK",`
	`1283`	`+ "FFA"`
	`1284`	`+ ]`
`1265`	`1285`	`}`
`1266`	`1286`	`}`
`1267`	`1287`	`}`
`@@ -1299,7 +1319,12 @@`
`1299`	`1319`	`"name" : "type",`
`1300`	`1320`	`"in" : "query",`
`1301`	`1321`	`"schema" : {`
`1302`		`- "$ref" : "#/components/schemas/ServerType"`
	`1322`	`+ "type" : "string",`
	`1323`	`+ "enum" : [`
	`1324`	`+ "PROXY",`
	`1325`	`+ "HIDE_N_SEEK",`
	`1326`	`+ "FFA"`
	`1327`	`+ ]`
`1303`	`1328`	`}`
`1304`	`1329`	`}`
`1305`	`1330`	`],`
`@@ -1903,9 +1928,6 @@`
`1903`	`1928`	`}`
`1904`	`1929`	`}`
`1905`	`1930`	`},`
`1906`		`- "ServerType" : {`
`1907`		`- "type" : "object"`
`1908`		`- },`
`1909`	`1931`	`"byte" : {`
`1910`	`1932`	`"type" : "object"`
`1911`	`1933`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,12 @@`
`190`	`190`	`"name" : "type",`
`191`	`191`	`"in" : "query",`
`192`	`192`	`"schema" : {`
`193`		`- "$ref" : "#/components/schemas/ServerType"`
	`193`	`+ "type" : "string",`
	`194`	`+ "enum" : [`
	`195`	`+ "PROXY",`
	`196`	`+ "HIDE_N_SEEK",`
	`197`	`+ "FFA"`
	`198`	`+ ]`
`194`	`199`	`}`
`195`	`200`	`}`
`196`	`201`	`],`
`@@ -222,7 +227,12 @@`
`222`	`227`	`"schema" : {`
`223`	`228`	`"type" : "array",`
`224`	`229`	`"items" : {`
`225`		`- "$ref" : "#/components/schemas/ServerType"`
	`230`	`+ "type" : "string",`
	`231`	`+ "enum" : [`
	`232`	`+ "PROXY",`
	`233`	`+ "HIDE_N_SEEK",`
	`234`	`+ "FFA"`
	`235`	`+ ]`
`226`	`236`	`}`
`227`	`237`	`}`
`228`	`238`	`}`
`@@ -260,7 +270,12 @@`
`260`	`270`	`"name" : "type",`
`261`	`271`	`"in" : "query",`
`262`	`272`	`"schema" : {`
`263`		`- "$ref" : "#/components/schemas/ServerType"`
	`273`	`+ "type" : "string",`
	`274`	`+ "enum" : [`
	`275`	`+ "PROXY",`
	`276`	`+ "HIDE_N_SEEK",`
	`277`	`+ "FFA"`
	`278`	`+ ]`
`264`	`279`	`}`
`265`	`280`	`}`
`266`	`281`	`],`
`@@ -363,11 +378,16 @@`
`363`	`378`	`"name" : {`
`364`	`379`	`"type" : "string",`
`365`	`380`	`"nullable" : false`
	`381`	`+ },`
	`382`	`+ "serverType" : {`
	`383`	`+ "type" : "string",`
	`384`	`+ "enum" : [`
	`385`	`+ "PROXY",`
	`386`	`+ "HIDE_N_SEEK",`
	`387`	`+ "FFA"`
	`388`	`+ ]`
`366`	`389`	`}`
`367`	`390`	`}`
`368`		`- },`
`369`		`- "ServerType" : {`
`370`		`- "type" : "object"`
`371`	`391`	`}`
`372`	`392`	`}`
`373`	`393`	`}`