GetShopTV/swagger2

How to specify response type `file`?

Open

#76 opened on Aug 28, 2016

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (61 forks)github user discovery
help wanted

Repository metrics

Stars
 (74 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi,

I want to generate the following swagger spec (not relevant parts are omitted):

responses:
        '200':
          schema:
            type: file

For example, for following API:

newtype MyFile = MyFile ByteString 
  deriving (MimeRender OctetStream, MimeUnrender OctetStream)

type MyAPI = "download" :> Get '[OctetStream] MyFile

instance ToSchema MyFile where
  declareNamedSchema _ = do 
    return $ NamedSchema Nothing $ mempty 
      & type_ .~ SwaggerFile -- That doesn't work

Is there a way to do it properly?

Contributor guide

Research direction
Investigate the Swagger2 library's ToSchema instance and data types to see if there is a predefined SwaggerFile type or if you need to manually set the format to 'binary' in the schema. Also review the library's documentation or examples for file responses.
Tech stack
haskell
Domain
api
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellSwagger2
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60