Skip to content

[PHP] Support map/object format for x-enum-varnames and x-enum-descriptions #23540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Apr 21, 2026
+98 −16
Merged

[PHP] Support map/object format for x-enum-varnames and x-enum-descriptions #23540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7028,17 +7028,31 @@ private String getUniqueEnumName(String name, List<Map<String, Object>> enumVars

protected void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String dataType) {
if (vendorExtensions != null) {
updateEnumVarsWithExtensions(enumVars, vendorExtensions, "x-enum-varnames", "name");
updateEnumVarsWithExtensions(enumVars, vendorExtensions, "x-enum-descriptions", "enumDescription");
updateEnumVarsWithExtensions(enumVars, vendorExtensions, "x-enum-varnames", "name", dataType);
updateEnumVarsWithExtensions(enumVars, vendorExtensions, "x-enum-descriptions", "enumDescription", dataType);
}
}

private void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String extensionKey, String key) {
private void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String extensionKey, String key, String dataType) {
if (vendorExtensions.containsKey(extensionKey)) {
List<String> values = (List<String>) vendorExtensions.get(extensionKey);
int size = Math.min(enumVars.size(), values.size());
for (int i = 0; i < size; i++) {
enumVars.get(i).put(key, values.get(i));
Object extensionValue = vendorExtensions.get(extensionKey);
if (extensionValue instanceof List) {
List<String> values = (List<String>) extensionValue;
int size = Math.min(enumVars.size(), values.size());
for (int i = 0; i < size; i++) {
enumVars.get(i).put(key, values.get(i));
}
} else if (extensionValue instanceof Map) {
Map<String, String> valueMap = (Map<String, String>) extensionValue;
for (Map<String, Object> enumVar : enumVars) {
String enumValue = (String) enumVar.get("value");
for (Map.Entry<String, String> entry : valueMap.entrySet()) {
if (toEnumValue(entry.getKey(), dataType).equals(enumValue)) {
enumVar.put(key, entry.getValue());
break;
}
}
}
}
}
}
Expand Down
45 changes: 36 additions & 9 deletions ...penapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,19 +711,46 @@ public void setParameterExampleValue(CodegenParameter p) {
protected void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String dataType) {
if (vendorExtensions != null) {
if (vendorExtensions.containsKey("x-enum-varnames")) {
List<String> values = (List<String>) vendorExtensions.get("x-enum-varnames");
int size = Math.min(enumVars.size(), values.size());

for (int i = 0; i < size; i++) {
enumVars.get(i).put("name", toEnumVarName(values.get(i), dataType));
Object extensionValue = vendorExtensions.get("x-enum-varnames");
if (extensionValue instanceof List) {
List<String> values = (List<String>) extensionValue;
int size = Math.min(enumVars.size(), values.size());
for (int i = 0; i < size; i++) {
enumVars.get(i).put("name", toEnumVarName(values.get(i), dataType));
}
} else if (extensionValue instanceof Map) {
Map<String, String> valueMap = (Map<String, String>) extensionValue;
for (Map<String, Object> enumVar : enumVars) {
String enumValue = (String) enumVar.get("value");
for (Map.Entry<String, String> entry : valueMap.entrySet()) {
if (toEnumValue(entry.getKey(), dataType).equals(enumValue)) {
enumVar.put("name", toEnumVarName(entry.getValue(), dataType));
break;
}
}
}
}
}

if (vendorExtensions.containsKey("x-enum-descriptions")) {
List<String> values = (List<String>) vendorExtensions.get("x-enum-descriptions");
int size = Math.min(enumVars.size(), values.size());
for (int i = 0; i < size; i++) {
enumVars.get(i).put("enumDescription", values.get(i));
Object extensionValue = vendorExtensions.get("x-enum-descriptions");
if (extensionValue instanceof List) {
List<String> values = (List<String>) extensionValue;
int size = Math.min(enumVars.size(), values.size());
for (int i = 0; i < size; i++) {
enumVars.get(i).put("enumDescription", values.get(i));
}
} else if (extensionValue instanceof Map) {
Map<String, String> valueMap = (Map<String, String>) extensionValue;
for (Map<String, Object> enumVar : enumVars) {
String enumValue = (String) enumVar.get("value");
for (Map.Entry<String, String> entry : valueMap.entrySet()) {
if (toEnumValue(entry.getKey(), dataType).equals(enumValue)) {
enumVar.put("enumDescription", entry.getValue());
break;
}
}
}
}
}
}
Expand Down
41 changes: 41 additions & 0 deletions modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -995,6 +995,26 @@ public void postProcessModelsEnumWithExtension() {
assertEquals("This is a cat", enumVars.get(1).getOrDefault("enumDescription", ""));
}

@Test
public void postProcessModelsEnumWithMapExtension() {
final DefaultCodegen codegen = new DefaultCodegen();
ModelsMap objs = codegenModelWithXEnumVarNameAsMap();
CodegenModel cm = objs.getModels().get(0).getModel();

codegen.postProcessModelsEnum(objs);

List<Map<String, Object>> enumVars = (List<Map<String, Object>>) cm.getAllowableValues().get("enumVars");
Assertions.assertNotNull(enumVars);
Assertions.assertNotNull(enumVars.get(0));
assertEquals("DOGVAR", enumVars.get(0).getOrDefault("name", ""));
assertEquals("\"dog\"", enumVars.get(0).getOrDefault("value", ""));
assertEquals("This is a dog", enumVars.get(0).getOrDefault("enumDescription", ""));
Assertions.assertNotNull(enumVars.get(1));
assertEquals("CATVAR", enumVars.get(1).getOrDefault("name", ""));
assertEquals("\"cat\"", enumVars.get(1).getOrDefault("value", ""));
assertEquals("This is a cat", enumVars.get(1).getOrDefault("enumDescription", ""));
}

@Test
public void testExample1() {
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/examples.yaml");
Expand Down Expand Up @@ -2314,6 +2334,27 @@ private ModelsMap codegenModelWithXEnumVarName() {
return TestUtils.createCodegenModelWrapper(cm);
}

private ModelsMap codegenModelWithXEnumVarNameAsMap() {
final CodegenModel cm = new CodegenModel();
cm.isEnum = true;
final HashMap<String, Object> allowableValues = new HashMap<>();
allowableValues.put("values", Arrays.asList("dog", "cat"));
cm.setAllowableValues(allowableValues);
cm.dataType = "String";
Map<String, String> aliases = new LinkedHashMap<>();
aliases.put("dog", "DOGVAR");
aliases.put("cat", "CATVAR");
Map<String, String> descriptions = new LinkedHashMap<>();
descriptions.put("dog", "This is a dog");
descriptions.put("cat", "This is a cat");
Map<String, Object> extensions = new HashMap<>();
extensions.put("x-enum-varnames", aliases);
extensions.put("x-enum-descriptions", descriptions);
cm.setVendorExtensions(extensions);
cm.setVars(Collections.emptyList());
return TestUtils.createCodegenModelWrapper(cm);
}

@Test
public void objectQueryParamIdentifyAsObject() {
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/objectQueryParam.yaml");
Expand Down
Loading