Fixes for php-ze-ph generator (#340)

* Fixes for ze-ph:
- fixed gathering of required properties for query data model
- fixed setting of internal vendor extensions for query data model detection
- fixed small typo in generated README

* Updated samples for ze-ph fixes
This commit is contained in:
Arthur Mogliev
2018-05-07 06:22:08 +04:00
committed by William Cheng
parent e45b3784f1
commit d30fcbabba
5 changed files with 35 additions and 17 deletions

View File

@@ -174,24 +174,30 @@ public class PhpZendExpressivePathHandlerServerCodegen extends AbstractPhpCodege
continue;
}
List<String> requiredProperties = new ArrayList<>();
for (Parameter parameter : operation.getParameters()) {
Schema schema = convertParameterToSchema(parameter);
if (schema != null) {
schemas.put(schema.getName(), schema);
if (Boolean.TRUE.equals(parameter.getRequired())) {
requiredProperties.add(schema.getName());
}
}
}
if (!schemas.isEmpty()) {
Schema model = new Schema();
ObjectSchema model = new ObjectSchema();
String operationId = getOrGenerateOperationId(operation, pathname, method.name());
model.setDescription("Query parameters for " + operationId);
model.setProperties(schemas);
model.addExtension(VEN_FROM_QUERY, Boolean.TRUE);
model.setRequired(requiredProperties);
//Add internal extension directly, because addExtension filters extension names
addInternalExtensionToSchema(model, VEN_FROM_QUERY, Boolean.TRUE);
String definitionName = generateUniqueDefinitionName(operationId + "QueryData", openAPI);
openAPI.getComponents().addSchemas(definitionName, model);
String definitionModel = "\\" + modelPackage + "\\" + toModelName(definitionName);
operation.addExtension(VEN_QUERY_DATA_TYPE, definitionModel);
operation.addExtension(VEN_HAS_QUERY_DATA, Boolean.TRUE);
addInternalExtensionToOperation(operation, VEN_QUERY_DATA_TYPE, definitionModel);
addInternalExtensionToOperation(operation, VEN_HAS_QUERY_DATA, Boolean.TRUE);
}
}
}
@@ -214,7 +220,7 @@ public class PhpZendExpressivePathHandlerServerCodegen extends AbstractPhpCodege
if (collectionFormat == null) {
collectionFormat = "csv";
}
arraySchema.addExtension(VEN_COLLECTION_FORMAT, collectionFormat);
addInternalExtensionToSchema(arraySchema, VEN_COLLECTION_FORMAT, collectionFormat);
property = arraySchema;
} else { // non-array e.g. string, integer
switch (queryParameter.getSchema().getType()) {
@@ -252,17 +258,28 @@ public class PhpZendExpressivePathHandlerServerCodegen extends AbstractPhpCodege
if (property != null) {
property.setName(queryParameter.getName());
property.setDescription(queryParameter.getDescription());
if (Boolean.TRUE.equals(queryParameter.getRequired())) {
List<String> required = new ArrayList<String>();
required.add(queryParameter.getName());
}
property.addExtension(VEN_FROM_QUERY, Boolean.TRUE);
addInternalExtensionToSchema(property, VEN_FROM_QUERY, Boolean.TRUE);
}
}
return property;
}
protected void addInternalExtensionToSchema(Schema schema, String name, Object value) {
//Add internal extension directly, because addExtension filters extension names
if (schema.getExtensions() == null) {
schema.setExtensions(new HashMap<>());
}
schema.getExtensions().put(name, value);
}
protected void addInternalExtensionToOperation(Operation operation, String name, Object value) {
//Add internal extension directly, because addExtension filters extension names
if (operation.getExtensions() == null) {
operation.setExtensions(new HashMap<>());
}
operation.getExtensions().put(name, value);
}
protected String generateUniqueDefinitionName(String name, OpenAPI openAPI) {
String result = name;
if (openAPI.getComponents().getSchemas() != null) {