Unable to load mode documentation 1.3.0-Snaphost

[PedroAlvarado]

There is probably an issue with dealing with WildCardTypes in the ApiPropertiesReader class. I'm on the 1.3.0 branch. Any ideas how to solve this problem. Let me know any information you need.

Unable to load model documentation for com.something.somethingDTO
java.lang.ClassCastException: sun.reflect.generics.reflectiveObjects.WildcardTypeImpl cannot be cast to java.lang.Class
    at com.wordnik.swagger.core.ApiPropertiesReader$.getDataType(ApiPropertiesReader.scala:105)
    at com.wordnik.swagger.core.ApiPropertiesReader$.getDataType(ApiPropertiesReader.scala:94)
    at com.wordnik.swagger.jsonschema.ApiModelParser.parsePropertyAnnotations(SwaggerJsonSchemaProvider.scala:151)
    at com.wordnik.swagger.jsonschema.ApiModelParser.com$wordnik$swagger$jsonschema$ApiModelParser$$parseMethod(SwaggerJsonSchemaProvider.scala:95)
    at com.wordnik.swagger.jsonschema.ApiModelParser$$anonfun$parseRecursive$1.apply(SwaggerJsonSchemaProvider.scala:78)
    at com.wordnik.swagger.jsonschema.ApiModelParser$$anonfun$parseRecursive$1.apply(SwaggerJsonSchemaProvider.scala:76)
    at scala.collection.IndexedSeqOptimized$class.foreach(IndexedSeqOptimized.scala:33)
    at scala.collection.mutable.ArrayOps$ofRef.foreach(ArrayOps.scala:105)
    at com.wordnik.swagger.jsonschema.ApiModelParser.parseRecursive(SwaggerJsonSchemaProvider.scala:76)
    at com.wordnik.swagger.jsonschema.ApiModelParser.parse(SwaggerJsonSchemaProvider.scala:67)
    at com.wordnik.swagger.jsonschema.SwaggerJsonSchemaProvider.read(SwaggerJsonSchemaProvider.scala:25)
    at com.wordnik.swagger.core.ApiPropertiesReader$$anonfun$read$1.apply(ApiPropertiesReader.scala:67)
    at com.wordnik.swagger.core.ApiPropertiesReader$$anonfun$read$1.apply(ApiPropertiesReader.scala:66)
    at scala.collection.MapLike$class.getOrElse(MapLike.scala:128)
    at scala.collection.AbstractMap.getOrElse(Map.scala:58)
    at com.wordnik.swagger.core.ApiPropertiesReader$.read(ApiPropertiesReader.scala:65)
    at com.wordnik.swagger.core.ApiPropertiesReader$.read(ApiPropertiesReader.scala:61)
    at com.wordnik.swagger.jaxrs.HelpApi$$anonfun$loadModels$1.apply(HelpApi.scala:88)
    at com.wordnik.swagger.jaxrs.HelpApi$$anonfun$loadModels$1.apply(HelpApi.scala:86)
    at scala.collection.immutable.Set$Set3.foreach(Set.scala:115)
    at com.wordnik.swagger.jaxrs.HelpApi.loadModels(HelpApi.scala:86)
    at com.wordnik.swagger.jaxrs.HelpApi.filterDocs(HelpApi.scala:77)
    at com.wordnik.swagger.jaxrs.listing.ApiListing.docForRoute(ApiListing.scala:124)
    at com.wordnik.swagger.jaxrs.listing.ApiListing$$anonfun$3.apply(ApiListing.scala:68)
    at com.wordnik.swagger.jaxrs.listing.ApiListing$$anonfun$3.apply(ApiListing.scala:67)
    at scala.collection.TraversableLike$$anonfun$map$1.apply(TraversableLike.scala:244)
    at scala.collection.TraversableLike$$anonfun$map$1.apply(TraversableLike.scala:244)
    at scala.collection.mutable.ResizableArray$class.foreach(ResizableArray.scala:59)
    at scala.collection.mutable.ArrayBuffer.foreach(ArrayBuffer.scala:47)
    at scala.collection.TraversableLike$class.map(TraversableLike.scala:244)
    at scala.collection.AbstractTraversable.map(Traversable.scala:105)
    at com.wordnik.swagger.jaxrs.listing.ApiListing.resourceListing(ApiListing.scala:67)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:601)

[fehguy]

Can you please share what your somethingDTO looks like so it can be covered in the unit tests?

[estelle-peterson]

https://gist.github.com/dopeymac/5904302

[PedroAlvarado]

@fehguy Let me know if you need anything else. We have a number of services we can't document due to this problem. Thanks for looking into this.

[fehguy]

@PedroAlvarado you and @Dopeymac are on the same team? I ran the models in the gist through our model conversion process and got this:

[
  {
    "id": "studentPerformanceMetric",
    "name": "studentPerformanceMetric",
    "properties": {
      "metricName": {
        "type": "string",
        "required": false
      },
      "metricCount": {
        "type": "long",
        "required": false
      },
      "metricRate": {
        "type": "double",
        "required": false
      }
    }
  },
  {
    "id": "studentPerformance",
    "name": "studentPerformance",
    "properties": {
      "studentName": {
        "type": "string",
        "required": false
      },
      "studentPerformanceMetrics": {
        "type": "List",
        "required": false,
        "items": {
          "$ref": "studentPerformanceMetric"
        }
      }
    }
  },
  {
    "id": "school",
    "name": "school",
    "properties": {
      "passRate": {
        "type": "double",
        "required": false
      },
      "endDate": {
        "type": "date",
        "required": false
      },
      "studentPerformanceList": {
        "type": "List",
        "required": false,
        "items": {
          "$ref": "studentPerformance"
        }
      },
      "totalStudents": {
        "type": "long",
        "required": false
      },
      "totalTeachers": {
        "type": "long",
        "required": false
      },
      "totalSchoolEvents": {
        "type": "long",
        "required": false
      },
      "failRate": {
        "type": "double",
        "required": false
      },
      "startDate": {
        "type": "date",
        "required": false
      }
    }
  }
]

[fehguy]

Furthermore, the following resource:

@Path("/wildcard")
@Api(value = "/wildcard", description = "Wildcard test resource")
class WildcardResource {
  @GET
  @Path("/{id}")
  @ApiOperation(value = "Get object by ID",
    notes = "No details provided",
    response = classOf[School],
    position = 0)
  @ApiResponses(Array(
    new ApiResponse(code = 400, message = "Invalid ID", response = classOf[NotFoundModel]),
    new ApiResponse(code = 404, message = "object not found")))
  def getTest(
    @ApiParam(value = "sample param data", required = true, allowableValues = "range[0,10]")@QueryParam("id") id: String) = {
    val out = new Sample
    out.name = "foo"
    out.value = "bar"
    Response.ok.entity(out).build
  }
}

is correctly read as such:

{
  "apiVersion": null,
  "swaggerVersion": null,
  "basePath": null,
  "resourcePath": "/wildcard",
  "apis": [
    {
      "path": "/wildcard/{id}",
      "operations": [
        {
          "method": "GET",
          "summary": "Get object by ID",
          "notes": "No details provided",
          "responseClass": "school",
          "nickname": "getTest",
          "parameters": [
            {
              "name": "id",
              "description": "sample param data",
              "required": true,
              "allowMultiple": false,
              "dataType": "string",
              "allowableValues": {
                "valueType": "RANGE",
                "min": "0.0",
                "max": "10.0"
              },
              "paramType": "query"
            }
          ],
          "responseMessages": [
            {
              "code": 400,
              "message": "Invalid ID",
              "responseModel": "NotFoundModel"
            },
            {
              "code": 404,
              "message": "object not found"
            }
          ]
        }
      ]
    }
  ],
  "models": {
    "school": {
      "id": "school",
      "name": "school",
      "properties": {
        "passRate": {
          "type": "double",
          "required": false
        },
        "endDate": {
          "type": "date",
          "required": false
        },
        "studentPerformanceList": {
          "type": "List",
          "required": false,
          "items": {
            "$ref": "studentPerformance"
          }
        },
        "totalStudents": {
          "type": "long",
          "required": false
        },
        "totalTeachers": {
          "type": "long",
          "required": false
        },
        "totalSchoolEvents": {
          "type": "long",
          "required": false
        },
        "failRate": {
          "type": "double",
          "required": false
        },
        "startDate": {
          "type": "date",
          "required": false
        }
      }
    },
    "studentPerformanceMetric": {
      "id": "studentPerformanceMetric",
      "name": "studentPerformanceMetric",
      "properties": {
        "metricName": {
          "type": "string",
          "required": false
        },
        "metricCount": {
          "type": "long",
          "required": false
        },
        "metricRate": {
          "type": "double",
          "required": false
        }
      }
    },
    "studentPerformance": {
      "id": "studentPerformance",
      "name": "studentPerformance",
      "properties": {
        "studentName": {
          "type": "string",
          "required": false
        },
        "studentPerformanceMetrics": {
          "type": "List",
          "required": false,
          "items": {
            "$ref": "studentPerformanceMetric"
          }
        }
      }
    },
    "NotFoundModel": {
      "id": "NotFoundModel",
      "name": "NotFoundModel",
      "properties": {
        "message": {
          "type": "string",
          "required": false
        },
        "code": {
          "type": "int",
          "required": false
        }
      },
      "description": "error response model",
      "extends": "java.lang.Void",
      "discriminator": ""
    }
  }
}

Let me know what's missing here.

[PedroAlvarado]

Its unfortunate you can't reproduce with the DTO provided. Potentially, there is another factor at play here. Best thing we can do is to provide a project based on the jaxrs-cxf(java-based) example that reproduces the issue we are seeing. We'll get back to you some time Tomorrow. Also, yes, dopeymac and myself are teammates.

FYI, our dependencies look like:

    <dependency>
        <groupId>com.wordnik</groupId>
        <artifactId>swagger-core_2.9.1</artifactId>
        <version>1.3.0-SNAPSHOT</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>com.wordnik</groupId>
        <artifactId>swagger-jaxrs_2.9.1</artifactId>
        <version>1.3.0-SNAPSHOT</version>
        <scope>compile</scope>
    </dependency>

[fehguy]

Can you look at the sample resource I provided and see if you are referencing the model in the same way? Note the response type is School, perhaps you have it as an input param?

[PedroAlvarado]

Our code looks something along the line of:

   @GET
   @Produces("application/json")
   @Path("/school/{id}")
   @ApiOperation(value="Return a list of schools",
                notes="Input parameter takes a school Id",
                response=School.class,
                responseContainer = "List")
   List<School> getSimilarSchools(
      @ApiParam(value="School ID", required=true)
      @PathParam("id")
      String id);

[fehguy]

Hi, I took your code verbatim got the expected, except I did make the method public. Source:

@Path("/wildcard")
@Api(value = "/wildcard", description = "Wildcard test resource")
class SchoolResource {
  @GET
  @Produces("application/json")
  @Path("/school/{id}")
  @ApiOperation(value="Return a list of schools",
                notes="Input parameter takes a school Id",
                response=School.class,
                responseContainer = "List")
  public List<School> getSimilarSchools(
      @ApiParam(value="School ID", required=true)
      @PathParam("id")
      String id) {
    return null;
   }
}

output:

{
  "apiVersion": null,
  "swaggerVersion": null,
  "basePath": null,
  "resourcePath": "/wildcard",
  "apis": [
    {
      "path": "/wildcard/school/{id}",
      "operations": [
        {
          "method": "GET",
          "summary": "Return a list of schools",
          "notes": "Input parameter takes a school Id",
          "responseClass": "List[school]",
          "nickname": "getSimilarSchools",
          "produces": [
            "application/json"
          ],
          "parameters": [
            {
              "name": "id",
              "description": "School ID",
              "required": true,
              "allowMultiple": false,
              "dataType": "string",
              "paramType": "path"
            }
          ]
        }
      ]
    }
  ],
  "models": {
    "school": {
      "id": "school",
      "name": "school",
      "properties": {
        "passRate": {
          "type": "double",
          "required": false
        },
        "endDate": {
          "type": "date",
          "required": false
        },
        "studentPerformanceList": {
          "type": "List",
          "required": false,
          "items": {
            "$ref": "studentPerformance"
          }
        },
        "totalStudents": {
          "type": "long",
          "required": false
        },
        "totalTeachers": {
          "type": "long",
          "required": false
        },
        "totalSchoolEvents": {
          "type": "long",
          "required": false
        },
        "failRate": {
          "type": "double",
          "required": false
        },
        "startDate": {
          "type": "date",
          "required": false
        }
      }
    },
    "studentPerformanceMetric": {
      "id": "studentPerformanceMetric",
      "name": "studentPerformanceMetric",
      "properties": {
        "metricName": {
          "type": "string",
          "required": false
        },
        "metricCount": {
          "type": "long",
          "required": false
        },
        "metricRate": {
          "type": "double",
          "required": false
        }
      }
    },
    "studentPerformance": {
      "id": "studentPerformance",
      "name": "studentPerformance",
      "properties": {
        "studentName": {
          "type": "string",
          "required": false
        },
        "studentPerformanceMetrics": {
          "type": "List",
          "required": false,
          "items": {
            "$ref": "studentPerformanceMetric"
          }
        }
      }
    }
  }
}

[PedroAlvarado]

@fehguy here is a quick project that reproduces the problem we see. https://github.com/PedroAlvarado/swagger-239. Its based on a modified version of https://github.com/wordnik/swagger-core/tree/1.3-RC1/samples/java-jaxrs-cxf.
Let me know if you need more information or help. Thanks,

[fehguy]

OK, looks like the issue is in the School.java, line 39:

  public List<SchoolPerformance> getSchoolPerformanceList() {
    return schoolPerformanceList;
  }

  public void setSchoolPerformanceList(
          List<SchoolPerformance> schoolPerformanceList) {
    this.schoolPerformanceList = schoolPerformanceList;
  }

...which is triggered by having and underscore in the element name: school_performance

And caused by a regex which didn't expect underscores:

https://github.com/wordnik/swagger-core/blob/develop-1.3/modules/swagger-core/src/main/scala/com/wordnik/swagger/converter/ModelPropertyParser.scala#L132

which are totally valid in model names. This has been fixed, but since RC1 has been cut already, you'll have to deploy from source to pick it up.

You can grab the 1.3-RC1 branch and run mvn clean install to pick it up.