[CAMEL-15919] Response message definition does not correctly handle java.io.File as response model

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.6.0
• Fix Version/s: 3.7.0
• Component/s: camel-openapi-java, camel-swagger-java
• Estimated Complexity: Novice
• Assignee: Unassigned
• Reporter: Michael Prankl
• Created: 03/Dec/20 15:34
• Updated: 04/Dec/20 06:10
• Resolved: 04/Dec/20 06:10

Description

Currently, specifying "java.io.File" class as response model (for example when the API returns a binary document, aka "Download") in RestOperationResponseMsgDefinition produces an incorrect Swagger / OAS2 / OAS3 definition:

 

"responses" : {
  "200" : {
    "description" : "Created PDF file",
    "schema" : {
      "type" : "string",
      "format" : "java.io.File"
    },
  },
  // ....
}

 The correct way to handle this according to Swagger docs v2 (https://swagger.io/docs/specification/2-0/describing-responses/) is:

"responses" : {
  "200" : {
    "description" : "Created PDF file",
    "schema" : {
      "type" : "file"
    },
  },
  // ....
}

 
camel-openapi-java with OAS2 / OAS3 is also affected.
 

Issue Links

• links to: GitHub Pull Request #4719