Response schema type "file" not supported

[hamx0r]

Per Response Object documentation, a schema with "type" of "file" is allowed. However, the Swagger Editor claims theres an error in this spec fragment:

{
  "basePath": "/", 
  "definitions": {
    "Unauthorized": {
      "description": "Unauthorized", 
      "properties": {
        "errors": {
          "items": {
            "properties": {
              "id": {
                "type": "string"
              }, 
              "message": {
                "type": "string"
              }
            }, 
            "title": "Error item", 
            "type": "object"
          }, 
          "type": "array"
        }, 
        "status": {
          "type": "string"
        }
      }, 
      "required": [
        "status", 
        "errors"
      ]
    }
  }, 
  "info": {
    "contact": {
      "email": "me@github.com", 
      "name": "Broken File Response Type"
    }, 
    "title": "File Response API", 
    "version": "0.1"
  }, 
  "paths": {
    "/flights/csv/{flight_id}": {
      "get": {
        "parameters": [
          {
            "description": "CSV list of flight IDs", 
            "in": "path", 
            "name": "flight_id", 
            "required": true, 
            "type": "string"
          }, 
          {
            "description": "Pagination Range: items=500-999)", 
            "in": "header", 
            "name": "Range", 
            "pattern": "items=([0-9]+)\\-([0-9]+)", 
            "required": false, 
            "type": "string"
          }
        ], 
        "produces": [
          "application/zip"
        ], 
        "responses": {
          "200": {
            "description": "CSV ZIP File", 
            "schema": {
              "type": "file"
            }
          }, 
          "401": {
            "description": "Unauthorized", 
            "examples": {
              "application/json": {
                "errors": [
                  {
                    "id": "3NhNMUKzTTqEa8GI-MT7wA", 
                    "message": "401 Client Error: Unauthorized"
                  }
                ], 
                "status": "error"
              }
            }, 
            "schema": {
              "$ref": "#/definitions/Unauthorized"
            }
          }, 
          "403": {
            "description": "Forbidden", 
            "schema": {
              "type": "string"
            }
          }, 
          "500": {
            "description": "Internal Server Error", 
            "schema": {
              "type": "string"
            }
          }
        }, 
        "summary": "\n        Return CSV of flights, one for each flight \"id\" (a CSV list of id's is acceptable)\n        ", 
        "tags": [
          "flights"
        ]
      }, 
      "parameters": [
        {
          "in": "path", 
          "name": "flight_id", 
          "required": true, 
          "type": "string"
        }
      ]
    } 
  }, 
  "security": [
    {
      "view": []
    }
  ], 
  "securityDefinitions": {
    "view": {
      "in": "header", 
      "name": "X-Identity-Token", 
      "type": "apiKey"
    }
  }, 
  "swagger": "2.0", 
  "tags": [
    {
      "description": "???", 
      "name": "flights"
    }
  ]
}

[mohsen1]

@webron should know, this error is a schema error.

[webron]

Yup, this is filed here - OAI/OpenAPI-Specification#260. I'll try to get around to resolving it this week.

[Srithar-ccs]

Hi All, I am also facing this issue, Pls help on this,

OAI/OpenAPI-Specification#446

[webron]

@Srithar-ccs - what you described in the google group, and swagger-spec has nothing to do with this issue. Right now, you're not making it easier for us to help you by writing about it all over the place.

[Srithar-ccs]

i am sorry webron.

[yiyeguhu]

@webron
Can we have a complete example including "produces" field to show how to use file in response type?

Particularly, I have a doubt, say, in the example in the 1st comment: we can have multiple response types: file, Reference, and string. But the example only specifies "application/zip" as "produces" field. Does this do the work? What should we do in this scenario?

Thanks in advance.