Add support for the URI format (#3023)

* Add support for URI formats

* Set URI type for all generators

Author: eriktim

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java

@@ -33,7 +33,7 @@ public class CodegenParameter {
     public String example; // example value (x-example)
     public String jsonSchema;
     public boolean isString, isNumeric, isInteger, isLong, isNumber, isFloat, isDouble, isByteArray, isBinary,
-            isBoolean, isDate, isDateTime, isUuid, isEmail, isFreeFormObject;
+            isBoolean, isDate, isDateTime, isUuid, isUri, isEmail, isFreeFormObject;
     public boolean isListContainer, isMapContainer;
     public boolean isFile;
     public boolean isEnum;
@@ -168,6 +168,7 @@ public CodegenParameter copy() {
         output.isDate = this.isDate;
         output.isDateTime = this.isDateTime;
         output.isUuid = this.isUuid;
+        output.isUri = this.isUri;
         output.isEmail = this.isEmail;
         output.isFreeFormObject = this.isFreeFormObject;
         output.isListContainer = this.isListContainer;
@@ -222,6 +223,7 @@ public boolean equals(Object o) {
             Objects.equals(isDate, that.isDate) &&
             Objects.equals(isDateTime, that.isDateTime) &&
             Objects.equals(isUuid, that.isUuid) &&
+            Objects.equals(isUri, that.isUri) &&
             Objects.equals(isEmail, that.isEmail) &&
             Objects.equals(isFreeFormObject, that.isFreeFormObject) &&
             Objects.equals(isListContainer, that.isListContainer) &&
@@ -289,6 +291,7 @@ public int hashCode() {
             isDate,
             isDateTime,
             isUuid,
+            isUri,
             isEmail,
             isFreeFormObject,
             isListContainer,
@@ -357,6 +360,7 @@ public java.lang.String toString() {
                 ", isDate=" + isDate +
                 ", isDateTime=" + isDateTime +
                 ", isUuid=" + isUuid +
+                ", isUri=" + isUri +
                 ", isEmail=" + isEmail +
                 ", isFreeFormObject=" + isFreeFormObject +
                 ", isListContainer=" + isListContainer +

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java

@@ -55,7 +55,7 @@ public class CodegenProperty implements Cloneable {
     public boolean hasMoreNonReadOnly; // for model constructor, true if next property is not readonly
     public boolean isPrimitiveType, isModel, isContainer;
     public boolean isString, isNumeric, isInteger, isLong, isNumber, isFloat, isDouble, isByteArray, isBinary, isFile,
-            isBoolean, isDate, isDateTime, isUuid, isEmail, isFreeFormObject;
+            isBoolean, isDate, isDateTime, isUuid, isUri, isEmail, isFreeFormObject;
     public boolean isListContainer, isMapContainer;
     public boolean isEnum;
     public boolean isReadOnly;
@@ -472,6 +472,7 @@ public int hashCode() {
             isDate,
             isDateTime,
             isUuid,
+            isUri,
             isEmail,
             isFreeFormObject,
             isMapContainer,
@@ -552,6 +553,7 @@ public boolean equals(Object obj) {
             Objects.equals(isDate, other.isDate) &&
             Objects.equals(isDateTime, other.isDateTime) &&
             Objects.equals(isUuid, other.isUuid) &&
+            Objects.equals(isUri, other.isUri) &&
             Objects.equals(isEmail, other.isEmail) &&
             Objects.equals(isFreeFormObject, other.isFreeFormObject) &&
             Objects.equals(isBinary, other.isBinary) &&
@@ -649,6 +651,7 @@ public java.lang.String toString() {
                 ", isDate=" + isDate +
                 ", isDateTime=" + isDateTime +
                 ", isUuid=" + isUuid +
+                ", isUri=" + isUri +
                 ", isEmail=" + isEmail +
                 ", isFreeFormObject=" + isFreeFormObject +
                 ", isListContainer=" + isListContainer +

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -1015,6 +1015,7 @@ public DefaultCodegen() {
         typeMapping.put("binary", "File");
         typeMapping.put("file", "File");
         typeMapping.put("UUID", "UUID");
+        typeMapping.put("URI", "URI");
         //typeMapping.put("BigDecimal", "BigDecimal"); //TODO need the mapping?
 
 
@@ -1025,6 +1026,7 @@ public DefaultCodegen() {
         importMapping = new HashMap<String, String>();
         importMapping.put("BigDecimal", "java.math.BigDecimal");
         importMapping.put("UUID", "java.util.UUID");
+        importMapping.put("URI", "java.net.URI");
         importMapping.put("File", "java.io.File");
         importMapping.put("Date", "java.util.Date");
         importMapping.put("Timestamp", "java.sql.Timestamp");
@@ -1233,6 +1235,8 @@ public void setParameterExampleValue(CodegenParameter codegenParameter) {
             codegenParameter.example = "2013-10-20T19:20:30+01:00";
         } else if (Boolean.TRUE.equals(codegenParameter.isUuid)) {
             codegenParameter.example = "38400000-8cf0-11bd-b23e-10b96e4ef00d";
+        } else if (Boolean.TRUE.equals(codegenParameter.isUri)) {
+            codegenParameter.example = "https://openapi-generator.tech";
         } else if (Boolean.TRUE.equals(codegenParameter.isString)) {
             codegenParameter.example = codegenParameter.paramName + "_example";
         } else if (Boolean.TRUE.equals(codegenParameter.isFreeFormObject)) {
@@ -1512,6 +1516,8 @@ private static String getPrimitiveType(Schema schema) {
             return "array";
         } else if (ModelUtils.isUUIDSchema(schema)) {
             return "UUID";
+        } else if (ModelUtils.isURISchema(schema)) {
+            return "URI";
         } else if (ModelUtils.isStringSchema(schema)) {
             return "string";
         } else if (ModelUtils.isFreeFormObject(schema)) {
@@ -2038,6 +2044,9 @@ public CodegenProperty fromProperty(String name, Schema p) {
                 // keep isString to true to make it backward compatible
                 property.isString = true;
                 property.isUuid = true;
+            } else if (ModelUtils.isURISchema(p)) {
+                property.isString = true; // for backward compatibility
+                property.isUri = true;
             } else if (ModelUtils.isEmailSchema(p)) {
                 property.isString = true;
                 property.isEmail = true;

modules/openapi-generator/src/main/java/org/openapitools/codegen/examples/ExampleGenerator.java

@@ -277,6 +277,8 @@ private Object resolvePropertyToExample(String propertyName, String mediaType, S
             return mp;
         } else if (ModelUtils.isUUIDSchema(property)) {
             return "046b6c7f-0b8a-43b9-b35d-6489e6daee91";
+        } else if (ModelUtils.isURISchema(property)) {
+            return "https://openapi-generator.tech";
         } else if (ModelUtils.isStringSchema(property)) {
             LOGGER.debug("String property");
             String defaultValue = (String) property.getDefault();

modules/openapi-generator/src/main/java/org/openapitools/codegen/examples/XmlExampleGenerator.java

@@ -193,6 +193,8 @@ protected String getExample(Schema schema) {
             return "********";
         } else if (ModelUtils.isUUIDSchema(schema)) {
             return "046b6c7f-0b8a-43b9-b35d-6489e6daee91";
+        } else if (ModelUtils.isURISchema(schema)) {
+            return "https://openapi-generator.tech";
             // do these last in case the specific types above are derived from these classes
         } else if (ModelUtils.isStringSchema(schema)) {
             return "aeiou";

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractAdaCodegen.java

@@ -140,6 +140,7 @@ public AbstractAdaCodegen() {
         typeMapping.put("object", "Swagger.Object");
         typeMapping.put("number", "Swagger.Number");
         typeMapping.put("UUID", "Swagger.UString");
+        typeMapping.put("URI", "Swagger.UString");
         typeMapping.put("file", "Swagger.Http_Content_Type");
         typeMapping.put("binary", "Swagger.Binary");
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractCSharpCodegen.java

@@ -185,6 +185,7 @@ public AbstractCSharpCodegen() {
         typeMapping.put("map", "Dictionary");
         typeMapping.put("object", "Object");
         typeMapping.put("UUID", "Guid?");
+        typeMapping.put("URI", "string");
 
         // nullable type
         nullableType = new HashSet<String>(
@@ -1087,6 +1088,8 @@ public void setParameterExampleValue(CodegenParameter codegenParameter) {
             codegenParameter.example = "2013-10-20T19:20:30+01:00";
         } else if (Boolean.TRUE.equals(codegenParameter.isUuid)) {
             codegenParameter.example = "38400000-8cf0-11bd-b23e-10b96e4ef00d";
+        } else if (Boolean.TRUE.equals(codegenParameter.isUri)) {
+            codegenParameter.example = "https://openapi-generator.tech";
         } else if (Boolean.TRUE.equals(codegenParameter.isString)) {
             codegenParameter.example = codegenParameter.paramName + "_example";
         }

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractEiffelCodegen.java

@@ -71,6 +71,7 @@ public AbstractEiffelCodegen() {
         typeMapping.put("boolean", "BOOLEAN");
         typeMapping.put("string", "STRING_32");
         typeMapping.put("UUID", "UUID"); //
+        typeMapping.put("URI", "STRING"); //
         typeMapping.put("date", "DATE");
         typeMapping.put("DateTime", "DATE_TIME");
         typeMapping.put("date-time", "DATE_TIME");

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractFSharpCodegen.java

@@ -171,6 +171,7 @@ public AbstractFSharpCodegen() {
         typeMapping.put("map", "IDictionary");
         typeMapping.put("object", "obj");
         typeMapping.put("UUID", "Guid");
+        typeMapping.put("URI", "string");
 
         // nullable type
         nullableType = new HashSet<String>(

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractGoCodegen.java

@@ -98,6 +98,7 @@ public AbstractGoCodegen() {
         typeMapping.put("boolean", "bool");
         typeMapping.put("string", "string");
         typeMapping.put("UUID", "string");
+        typeMapping.put("URI", "string");
         typeMapping.put("date", "string");
         typeMapping.put("DateTime", "time.Time");
         typeMapping.put("password", "string");

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractGraphQLCodegen.java

@@ -82,6 +82,7 @@ public AbstractGraphQLCodegen() {
         typeMapping.put("boolean", "Boolean");
         typeMapping.put("string", "String");
         typeMapping.put("UUID", "ID");
+        typeMapping.put("URI", "String");
         typeMapping.put("date", "String");
         typeMapping.put("DateTime", "String");
         typeMapping.put("password", "String");
@@ -463,4 +464,4 @@ public String tographQlInputsName(String name) {
 
         return camelize(name) + "Input";
     }
-}
+}

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractKotlinCodegen.java

@@ -184,6 +184,7 @@ public AbstractKotlinCodegen() {
         importMapping = new HashMap<String, String>();
         importMapping.put("BigDecimal", "java.math.BigDecimal");
         importMapping.put("UUID", "java.util.UUID");
+        importMapping.put("URI", "java.net.URI");
         importMapping.put("File", "java.io.File");
         importMapping.put("Date", "java.util.Date");
         importMapping.put("Timestamp", "java.sql.Timestamp");

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java

@@ -125,6 +125,7 @@ public AbstractPhpCodegen() {
         typeMapping.put("binary", "string");
         typeMapping.put("ByteArray", "string");
         typeMapping.put("UUID", "string");
+        typeMapping.put("URI", "string");
 
         cliOptions.add(new CliOption(CodegenConstants.MODEL_PACKAGE, CodegenConstants.MODEL_PACKAGE_DESC));
         cliOptions.add(new CliOption(CodegenConstants.API_PACKAGE, CodegenConstants.API_PACKAGE_DESC));

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractRubyCodegen.java

@@ -81,6 +81,7 @@ public AbstractRubyCodegen() {
         typeMapping.put("binary", "String");
         typeMapping.put("ByteArray", "String");
         typeMapping.put("UUID", "String");
+        typeMapping.put("URI", "String");
     }
 
     @Override

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

@@ -123,6 +123,7 @@ public AbstractTypeScriptClientCodegen() {
         typeMapping.put("File", "any");
         typeMapping.put("ByteArray", "string");
         typeMapping.put("UUID", "string");
+        typeMapping.put("URI", "string");
         typeMapping.put("Error", "Error");
 
         cliOptions.add(new CliOption(CodegenConstants.MODEL_PROPERTY_NAMING, CodegenConstants.MODEL_PROPERTY_NAMING_DESC).defaultValue(this.modelPropertyNaming));

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ApexClientCodegen.java

@@ -94,6 +94,7 @@ public ApexClientCodegen() {
         typeMapping.put("number", "Double");
         typeMapping.put("short", "Integer");
         typeMapping.put("UUID", "String");
+        typeMapping.put("URI", "String");
 
         // https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_reserved_words.htm
         setReservedWordsLowerCase(

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AspNetCoreServerCodegen.java

@@ -100,6 +100,7 @@ public AspNetCoreServerCodegen() {
         typeMapping.put("DateTime", "DateTime");
         typeMapping.put("date", "DateTime");
         typeMapping.put("UUID", "Guid");
+        typeMapping.put("URI", "string");
 
         setSupportNullable(Boolean.TRUE);
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/BashClientCodegen.java

@@ -199,6 +199,7 @@ public BashClientCodegen() {
         typeMapping.put("file", "binary");
         typeMapping.put("binary", "binary");
         typeMapping.put("UUID", "string");
+        typeMapping.put("URI", "string");
 
         /**
          * Additional Properties.  These values can be passed to the templates and

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CLibcurlClientCodegen.java

@@ -152,6 +152,7 @@ public CLibcurlClientCodegen() {
         typeMapping.put("binary", "binary_t*");
         typeMapping.put("ByteArray", "char");
         typeMapping.put("UUID", "char");
+        typeMapping.put("URI", "char");
         typeMapping.put("array", "list");
         typeMapping.put("map", "list_t*");
         typeMapping.put("date-time", "char");

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CSharpClientCodegen.java

@@ -95,6 +95,7 @@ public CSharpClientCodegen() {
         typeMapping.put("DateTime", "DateTime");
         typeMapping.put("date", "DateTime");
         typeMapping.put("UUID", "Guid");
+        typeMapping.put("URI", "string");
 
         setSupportNullable(Boolean.TRUE);
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CSharpNetCoreClientCodegen.java

@@ -100,6 +100,7 @@ public CSharpNetCoreClientCodegen() {
         typeMapping.put("map", "Dictionary");
         typeMapping.put("object", "Object");
         typeMapping.put("UUID", "Guid");
+        typeMapping.put("URI", "string");
 
         setSupportNullable(Boolean.TRUE);
         hideGenerationTimestamp = Boolean.TRUE;

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ClojureClientCodegen.java

@@ -93,6 +93,7 @@ public ClojureClientCodegen() {
         typeMapping.put("date", "inst?");
         typeMapping.put("DateTime", "inst?");
         typeMapping.put("UUID", "uuid?");
+        typeMapping.put("URI", "string?");
 
         // But some type mappings are not really worth/meaningful to check for:
         typeMapping.put("object", "any?"); // Like, everything is an object.

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppPistacheServerCodegen.java

@@ -107,6 +107,7 @@ public CppPistacheServerCodegen() {
         typeMapping.put("binary", "std::string");
         typeMapping.put("number", "double");
         typeMapping.put("UUID", "std::string");
+        typeMapping.put("URI", "std::string");
         typeMapping.put("ByteArray", "std::string");
 
         super.importMapping = new HashMap<String, String>();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppQt5AbstractCodegen.java

@@ -88,6 +88,7 @@ public CppQt5AbstractCodegen() {
         //   come out of the box and will need to be sorted out (at least imply
         //   modifications on multiple templates)
         typeMapping.put("UUID", "QString");
+        typeMapping.put("URI", "QString");
         typeMapping.put("file", "QIODevice");
         typeMapping.put("binary", "QIODevice");
         importMapping = new HashMap<String, String>();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppRestSdkClientCodegen.java

@@ -146,6 +146,7 @@ public CppRestSdkClientCodegen() {
         typeMapping.put("binary", "utility::string_t");
         typeMapping.put("number", "double");
         typeMapping.put("UUID", "utility::string_t");
+        typeMapping.put("URI", "utility::string_t");
         typeMapping.put("ByteArray", "utility::string_t");
 
         super.importMapping = new HashMap<String, String>();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppRestbedServerCodegen.java

@@ -89,6 +89,7 @@ public CppRestbedServerCodegen() {
         typeMapping.put("binary", "restbed::Bytes");
         typeMapping.put("number", "double");
         typeMapping.put("UUID", "std::string");
+        typeMapping.put("URI", "std::string");
         typeMapping.put("ByteArray", "std::string");
 
         super.importMapping = new HashMap<String, String>();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppTizenClientCodegen.java

@@ -102,6 +102,7 @@ public CppTizenClientCodegen() {
         typeMapping.put("DateTime", "std::string");
         typeMapping.put("Date", "std::string");
         typeMapping.put("UUID", "std::string");
+        typeMapping.put("URI", "std::string");
 
         importMapping = new HashMap<String, String>();
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartClientCodegen.java

@@ -115,6 +115,7 @@ public DartClientCodegen() {
         typeMapping.put("File", "MultipartFile");
         typeMapping.put("binary", "MultipartFile");
         typeMapping.put("UUID", "String");
+        typeMapping.put("URI", "String");
         typeMapping.put("ByteArray", "String");
 
         cliOptions.add(new CliOption(BROWSER_CLIENT, "Is the client browser based"));

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartJaguarClientCodegen.java

@@ -87,6 +87,7 @@ public DartJaguarClientCodegen() {
         protoTypeMapping.put("file", "bytes");
         protoTypeMapping.put("binary", "bytes");
         protoTypeMapping.put("UUID", "string");
+        protoTypeMapping.put("URI", "string");
         protoTypeMapping.put("ByteArray", "bytes");
 
     }

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ElixirClientCodegen.java

@@ -175,6 +175,7 @@ public ElixirClientCodegen() {
         typeMapping.put("binary", "String");
         typeMapping.put("ByteArray", "String");
         typeMapping.put("UUID", "String");
+        typeMapping.put("URI", "String");
 
         cliOptions.add(new CliOption(CodegenConstants.INVOKER_PACKAGE, "The main namespace to use for all classes. e.g. Yay.Pets"));
         cliOptions.add(new CliOption("licenseHeader", "The license header to prepend to the top of all source files."));

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ElmClientCodegen.java

@@ -138,6 +138,7 @@ public ElmClientCodegen() {
         typeMapping.put("file", "String");
         typeMapping.put("binary", "String");
         typeMapping.put("UUID", "Uuid");
+        typeMapping.put("URI", "String");
 
         importMapping.clear();
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ErlangClientCodegen.java

@@ -95,6 +95,7 @@ public ErlangClientCodegen() {
         typeMapping.put("bytearray", "binary()");
         typeMapping.put("byte", "binary()");
         typeMapping.put("uuid", "binary()");
+        typeMapping.put("uri", "binary()");
         typeMapping.put("password", "binary()");
 
         cliOptions.clear();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ErlangProperCodegen.java

@@ -98,6 +98,7 @@ public ErlangProperCodegen() {
         typeMapping.put("bytearray", "binary()");
         typeMapping.put("byte", "binary()");
         typeMapping.put("uuid", "binary()");
+        typeMapping.put("uri", "binary()");
         typeMapping.put("password", "binary()");
 
         cliOptions.clear();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/ErlangServerCodegen.java

@@ -102,6 +102,7 @@ public ErlangServerCodegen() {
         typeMapping.put("bytearray", "binary");
         typeMapping.put("byte", "binary");
         typeMapping.put("uuid", "binary");
+        typeMapping.put("uri", "binary");
         typeMapping.put("password", "binary");
 
         cliOptions.clear();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/FlashClientCodegen.java

@@ -74,6 +74,7 @@ public FlashClientCodegen() {
         typeMapping.put("object", "Object");
         typeMapping.put("file", "File");
         typeMapping.put("UUID", "String");
+        typeMapping.put("URI", "String");
         typeMapping.put("binary", "File");
 
         importMapping = new HashMap<String, String>();

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/HaskellHttpClientCodegen.java

@@ -227,6 +227,7 @@ public HaskellHttpClientCodegen() {
         // lib
         typeMapping.put("string", "Text");
         typeMapping.put("UUID", "Text");
+        typeMapping.put("URI", "Text");
         typeMapping.put("any", "A.Value");
         typeMapping.put("set", "Set.Set");
         // newtype