Can't define the file download spec in OpenAPI about http4k HOT 3 CLOSED

I think you want to use this:

        returning("XLS" to Response(OK).with(CONTENT_TYPE of OCTET_STREAM))
        returning("JSON" to Response(OK).with(CONTENT_TYPE of APPLICATION_JSON))

Which generates in the output:

 "responses": {
          "200": {
            "description": "JSON,XLS",
            "content": {
              "application/json": {
                "schema": {
                }
              },
              "application/octet-stream": {
                "schema": {
                }
              }
            }
          }
        }

I think this should work, so closing. Please reopen if you need to :)

from http4k.

Well, not exactly. For

returning("PDF" to Response(OK).with(CONTENT_TYPE of APPLICATION_PDF))

we'll have

        "responses": {
          "200": {
            "description": "PDF",
            "content": {
              "application/pdf": {
                "schema": {
                }
              }
            }
          }
        },

and we're missing the schema bit that is described in OpenAPI docs. Even in your examples your octet-stream lacks the schema: type: string format: binary bit.

I think it may be problematic not to able to be generate the spec in a way it's described in OpenAPI docs, other tools that depend on that may fail

from http4k.

And I cannot reopen the issue, don't have the button anywhere @daviddenton

from http4k.