Why is TimeUnit rendered wrong?

[cristalp]

We have some REST endpoints that use a java.util.concurrent.TimeUnit as path parameter.

This is how enums are normally generated, in this case Format:

    "/api/image/{hash}/{format}" : {
      "get" : {
        "parameters" : [ {
          "name" : "format",
          "in" : "path",
          "required" : true,
          "schema" : {
            "$ref" : "#/components/schemas/Format"
          },
          "allowEmptyValue" : false
        }
      }
    }

  "components" : {
    "schemas" : {
      "Format" : {
        "enum" : [ "PRINT", "SCREEN", "THUMBNAIL" ],
        "type" : "string"
      }
    }
  }

However, with TimeUnit, I get the following:

    "/api/changed/last/{n}/{timeunit}" : {
      "get" : {
        "parameters" : [ {
          "name" : "timeunit",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "object"
          },
          "allowEmptyValue" : false
        } ]
      }
    }

So I don't get the nice drop-down with the enum values, but just a generic text box for JSON.

Is this a specific problem for TimeUnit or is the problem that it's a path parameter?

[MikeEdgar]

@cristalp I think this is because it's a JDK class and the Maven plugin doesn't include those classes in the index that is scanned. Thus, it ends up being a "black box" to the scanner.

Perhaps there could be an option to index the JDK classes (disabled by default) or something similar. You could also specify the TimeUnit schema in configuration and use a ref on the method parameter to point to it.

[MikeEdgar]

Did you add the <systemPropertyVariables> to the <configuration> of the Maven plugin or somewhere else? It should be on the plugin itself.

[cristalp]

Having an option to index the JDK classes would be great, but I think one should be able to configure what classes should be indexed. Otherwise the scanning process would probably take a lot of time...

[cristalp]

Here's my plugin configuration (the version is defined elsewhere):

          <plugin>
            <groupId>io.smallrye</groupId>
            <artifactId>smallrye-open-api-maven-plugin</artifactId>
            <configuration>
              <skip>${maven.openapi.generator.skip}</skip>
              <outputDirectory>${openapi.target.directory}</outputDirectory>
              <schemaFilename>openapi</schemaFilename>
              <outputFileTypeFilter>ALL</outputFileTypeFilter>
              <encoding>UTF-8</encoding>
              <attachArtifacts>true</attachArtifacts>
              <infoTitle>${openapi.title}</infoTitle>
              <infoDescription>${openapi.description}</infoDescription>
              <infoVersion>${openapi.version}</infoVersion>
              <includeDependenciesScopes>
                <includeDependenciesScope>compile</includeDependenciesScope>
                <includeDependenciesScope>runtime</includeDependenciesScope>
                <includeDependenciesScope>system</includeDependenciesScope>
              </includeDependenciesScopes>
              <includeDependenciesTypes>
                <includeDependenciesType>jar</includeDependenciesType>
                <includeDependenciesType>ejb</includeDependenciesType>
              </includeDependenciesTypes>
              <scanPackages>${group.id.my.package}</scanPackages>
              <scanExcludePackages>${openapi.exclude.packages}</scanExcludePackages>
              <scanExcludeClasses>${openapi.exclude.classes}</scanExcludeClasses>
              <systemPropertyVariables>
                <mp.openapi.extensions.smallrye.private-properties.enable>false</mp.openapi.extensions.smallrye.private-properties.enable>
                <mp.openapi.extensions.java.util.concurrent.TimeUnit>
                  {
                    "name": "TimeUnit",
                    "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ]
                  }
                </mp.openapi.extensions.java.util.concurrent.TimeUnit>
              </systemPropertyVariables>
              <servers>${webservices.context.root}</servers>
            </configuration>

[MikeEdgar]

Oops, sorry I copied the wrong configuration name... it should be this:

mp.openapi.schema.java.util.concurrent.TimeUnit

[cristalp]

Ah, much better :-)

Well... how should we continue on this? I think configuring each and every enum/class of the JDK by hand is a bit cumbersome. Should I write an enhancement issue for scanning JDK classes?

[MikeEdgar]

Yes, please open an issue for that part. I've done some experimentation and it should be feasible to add this.

[cristalp]

Done: #1999 Thanks!