content: {-# LANGUAGE OverloadedLists #-}
  {-# LANGUAGE OverloadedStrings #-}
  {-# LANGUAGE ScopedTypeVariables #-}
  {-# LANGUAGE QuasiQuotes #-}
  module Data.SwaggerSpec where
  
  import Prelude ()
  import Prelude.Compat
  
  import Control.Lens
  
  import Data.Aeson
  import Data.Aeson.QQ.Simple
  import Data.HashMap.Strict (HashMap)
  import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
  import qualified Data.HashSet.InsOrd as InsOrdHS
  import Data.Text (Text)
  
  import Data.Swagger
  import SpecCommon
  import Test.Hspec hiding (example)
  
  spec :: Spec
  spec = do
    describe "host" $ do
      it "can decode the host port" $ do
        let h = Just $ Host "localhost" (Just (fromInteger 8000))
            swagger :: Swagger
            swagger = swaggerExample
              & host .~ h
            parsed :: Swagger = either error id $ eitherDecode' $ encode swagger
        parsed ^. host `shouldBe` h
    describe "License Object" $ licenseExample <=> licenseExampleJSON
    describe "Contact Object" $ contactExample <=> contactExampleJSON
    describe "Info Object" $ infoExample <=> infoExampleJSON
    describe "Operation Object" $ operationExample <=> operationExampleJSON
    describe "Schema Object" $ do
      context "Primitive Sample" $ schemaPrimitiveExample <=> schemaPrimitiveExampleJSON
      context "Simple Model" $ schemaSimpleModelExample <=> schemaSimpleModelExampleJSON
      context "Model with Map/Dictionary Properties" $ schemaModelDictExample <=> schemaModelDictExampleJSON
      context "Model with Arbitrary Properties" $ schemaAdditionalExample <=> schemaAdditionalExampleJSON
      context "Model with Example" $ schemaWithExampleExample <=> schemaWithExampleExampleJSON
    describe "Definitions Object" $ definitionsExample <=> definitionsExampleJSON
    describe "Parameters Definition Object" $ paramsDefinitionExample <=> paramsDefinitionExampleJSON
    describe "Responses Definition Object" $ responsesDefinitionExample <=> responsesDefinitionExampleJSON
    describe "Security Definitions Object" $ securityDefinitionsExample <=> securityDefinitionsExampleJSON
    describe "OAuth2 Security Definitions with merged Scope" $ oAuth2SecurityDefinitionsExample <=> oAuth2SecurityDefinitionsExampleJSON
    describe "Composition Schema Example" $ compositionSchemaExample <=> compositionSchemaExampleJSON
    describe "Swagger Object" $ do
      context "Example with no paths" $ emptyPathsFieldExample <=> emptyPathsFieldExampleJSON
      context "Todo Example" $ swaggerExample <=> swaggerExampleJSON
      context "PetStore Example" $
        it "decodes successfully" $ do
          fromJSON petstoreExampleJSON `shouldSatisfy` (\x -> case x of Success (_ :: Swagger) -> True; _ -> False)
  
  main :: IO ()
  main = hspec spec
  
  -- =======================================================================
  -- Info object
  -- =======================================================================
  
  infoExample :: Info
  infoExample = mempty
    & title          .~ "Swagger Sample App"
    & description    ?~ "This is a sample server Petstore server."
    & termsOfService ?~ "http://swagger.io/terms/"
    & contact        ?~ contactExample
    & license        ?~ licenseExample
    & version        .~ "1.0.1"
  
  infoExampleJSON :: Value
  infoExampleJSON = [aesonQQ|
  {
    "title": "Swagger Sample App",
    "description": "This is a sample server Petstore server.",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "name": "API Support",
      "url": "http://www.swagger.io/support",
      "email": "support@swagger.io"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.0.1"
  }
  |]
  
  -- =======================================================================
  -- Contact object
  -- =======================================================================
  
  contactExample :: Contact
  contactExample = mempty
    & name  ?~ "API Support"
    & url   ?~ URL "http://www.swagger.io/support"
    & email ?~ "support@swagger.io"
  
  contactExampleJSON :: Value
  contactExampleJSON = [aesonQQ|
  {
    "name": "API Support",
    "url": "http://www.swagger.io/support",
    "email": "support@swagger.io"
  }
  |]
  
  -- =======================================================================
  -- License object
  -- =======================================================================
  
  licenseExample :: License
  licenseExample = "Apache 2.0"
    & url ?~ URL "http://www.apache.org/licenses/LICENSE-2.0.html"
  
  licenseExampleJSON :: Value
  licenseExampleJSON = [aesonQQ|
  {
    "name": "Apache 2.0",
    "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
  }
  |]
  
  
  -- =======================================================================
  -- Operation object
  -- =======================================================================
  
  operationExample :: Operation
  operationExample = mempty
    & tags    .~ InsOrdHS.fromList ["pet"]
    & summary ?~ "Updates a pet in the store with form data"
    & description ?~ ""
    & operationId ?~ "updatePetWithForm"
    & consumes    ?~ MimeList ["application/x-www-form-urlencoded"]
    & produces    ?~ MimeList ["application/json", "application/xml"]
    & parameters .~ map Inline
        [ mempty
            & name        .~ "petId"
            & description ?~ "ID of pet that needs to be updated"
            & required    ?~ True
            & schema .~ ParamOther (stringSchema ParamPath)
        , mempty
            & name        .~ "name"
            & description ?~ "Updated name of the pet"
            & required    ?~ False
            & schema .~ ParamOther (stringSchema ParamFormData)
        , mempty
            & name        .~ "status"
            & description ?~ "Updated status of the pet"
            & required    ?~ False
            & schema .~ ParamOther (stringSchema ParamFormData)
        ]
  
    & at 200 ?~ "Pet updated."
    & at 405 ?~ "Invalid input"
    & security .~ [SecurityRequirement [("petstore_auth", ["write:pets", "read:pets"])]]
    & extensions .~ InsOrdHashMap.fromList [("age", Number 42)]
    where
      stringSchema :: ParamLocation -> ParamOtherSchema
      stringSchema loc = mempty
        & in_ .~ loc
        & type_ ?~ SwaggerString
  
  operationExampleJSON :: Value
  operationExampleJSON = [aesonQQ|
  {
    "tags": [
      "pet"
    ],
    "summary": "Updates a pet in the store with form data",
    "description": "",
    "operationId": "updatePetWithForm",
    "consumes": [
      "application/x-www-form-urlencoded"
    ],
    "produces": [
      "application/json",
      "application/xml"
    ],
    "parameters": [
      {
        "name": "petId",
        "in": "path",
        "description": "ID of pet that needs to be updated",
        "required": true,
        "type": "string"
      },
      {
        "name": "name",
        "in": "formData",
        "description": "Updated name of the pet",
        "required": false,
        "type": "string"
      },
      {
        "name": "status",
        "in": "formData",
        "description": "Updated status of the pet",
        "required": false,
        "type": "string"
      }
    ],
    "responses": {
      "200": {
        "description": "Pet updated."
      },
      "405": {
        "description": "Invalid input"
      }
    },
    "security": [
      {
        "petstore_auth": [
          "write:pets",
          "read:pets"
        ]
      }
    ],
    "x-age": 42
  }
  |]
  
  -- =======================================================================
  -- Schema object
  -- =======================================================================
  
  schemaPrimitiveExample :: Schema
  schemaPrimitiveExample = mempty
    & type_  ?~ SwaggerString
    & format ?~ "email"
  
  schemaPrimitiveExampleJSON :: Value
  schemaPrimitiveExampleJSON = [aesonQQ|
  {
      "type": "string",
      "format": "email"
  }
  |]
  
  schemaSimpleModelExample :: Schema
  schemaSimpleModelExample = mempty
    & type_ ?~ SwaggerObject
    & required .~ [ "name" ]
    & properties .~
        [ ("name", Inline (mempty & type_ ?~ SwaggerString))
        , ("address", Ref (Reference "Address"))
        , ("age", Inline $ mempty
              & minimum_ ?~ 0
              & type_    ?~ SwaggerInteger
              & format   ?~ "int32" ) ]
  
  schemaSimpleModelExampleJSON :: Value
  schemaSimpleModelExampleJSON = [aesonQQ|
  {
    "type": "object",
    "required": [
      "name"
    ],
    "properties": {
      "name": {
        "type": "string"
      },
      "address": {
        "$ref": "#/definitions/Address"
      },
      "age": {
        "type": "integer",
        "format": "int32",
        "minimum": 0
      }
    }
  }
  |]
  
  schemaModelDictExample :: Schema
  schemaModelDictExample = mempty
    & type_ ?~ SwaggerObject
    & additionalProperties ?~ AdditionalPropertiesSchema (Inline (mempty & type_ ?~ SwaggerString))
  
  schemaModelDictExampleJSON :: Value
  schemaModelDictExampleJSON = [aesonQQ|
  {
    "type": "object",
    "additionalProperties": {
      "type": "string"
    }
  }
  |]
  
  schemaAdditionalExample :: Schema
  schemaAdditionalExample = mempty
    & type_ ?~ SwaggerObject
    & additionalProperties ?~ AdditionalPropertiesAllowed True
  
  schemaAdditionalExampleJSON :: Value
  schemaAdditionalExampleJSON = [aesonQQ|
  {
    "type": "object",
    "additionalProperties": true
  }
  |]
  
  schemaWithExampleExample :: Schema
  schemaWithExampleExample = mempty
    & type_ ?~ SwaggerObject
    & properties .~
        [ ("id", Inline $ mempty
              & type_  ?~ SwaggerInteger
              & format ?~ "int64" )
        , ("name", Inline $ mempty
              & type_ ?~ SwaggerString) ]
    & required .~ [ "name" ]
    & example ?~ [aesonQQ|
      {
        "name": "Puma",
        "id": 1
      }
    |]
  
  schemaWithExampleExampleJSON :: Value
  schemaWithExampleExampleJSON = [aesonQQ|
  {
    "type": "object",
    "properties": {
      "id": {
        "type": "integer",
        "format": "int64"
      },
      "name": {
        "type": "string"
      }
    },
    "required": [
      "name"
    ],
    "example": {
      "name": "Puma",
      "id": 1
    }
  }
  |]
  
  -- =======================================================================
  -- Definitions object
  -- =======================================================================
  
  definitionsExample :: HashMap Text Schema
  definitionsExample =
    [ ("Category", mempty
        & type_ ?~ SwaggerObject
        & properties .~
            [ ("id", Inline $ mempty
                & type_  ?~ SwaggerInteger
                & format ?~ "int64")
            , ("name", Inline (mempty & type_ ?~ SwaggerString)) ] )
    , ("Tag", mempty
        & type_ ?~ SwaggerObject
        & properties .~
            [ ("id", Inline $ mempty
                & type_  ?~ SwaggerInteger
                & format ?~ "int64")
            , ("name", Inline (mempty & type_ ?~ SwaggerString)) ] ) ]
  
  definitionsExampleJSON :: Value
  definitionsExampleJSON = [aesonQQ|
  {
    "Category": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "Tag": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
  |]
  
  -- =======================================================================
  -- Parameters Definition object
  -- =======================================================================
  
  paramsDefinitionExample :: HashMap Text Param
  paramsDefinitionExample =
    [ ("skipParam", mempty
        & name .~ "skip"
        & description ?~ "number of items to skip"
        & required ?~ True
        & schema .~ ParamOther (mempty
            & in_    .~ ParamQuery
            & type_  ?~ SwaggerInteger
            & format ?~ "int32" ))
    , ("limitParam", mempty
        & name .~ "limit"
        & description ?~ "max records to return"
        & required ?~ True
        & schema .~ ParamOther (mempty
            & in_    .~ ParamQuery
            & type_  ?~ SwaggerInteger
            & format ?~ "int32" )) ]
  
  paramsDefinitionExampleJSON :: Value
  paramsDefinitionExampleJSON = [aesonQQ|
  {
    "skipParam": {
      "name": "skip",
      "in": "query",
      "description": "number of items to skip",
      "required": true,
      "type": "integer",
      "format": "int32"
    },
    "limitParam": {
      "name": "limit",
      "in": "query",
      "description": "max records to return",
      "required": true,
      "type": "integer",
      "format": "int32"
    }
  }
  |]
  
  -- =======================================================================
  -- Responses Definition object
  -- =======================================================================
  
  responsesDefinitionExample :: HashMap Text Response
  responsesDefinitionExample =
    [ ("NotFound", mempty & description .~ "Entity not found.")
    , ("IllegalInput", mempty & description .~ "Illegal input for operation.") ]
  
  responsesDefinitionExampleJSON :: Value
  responsesDefinitionExampleJSON = [aesonQQ|
  {
    "NotFound": {
      "description": "Entity not found."
    },
    "IllegalInput": {
      "description": "Illegal input for operation."
    }
  }
  |]
  
  -- =======================================================================
  -- Responses Definition object
  -- =======================================================================
  
  securityDefinitionsExample :: SecurityDefinitions
  securityDefinitionsExample = SecurityDefinitions
    [ ("api_key", SecurityScheme
        { _securitySchemeType = SecuritySchemeApiKey (ApiKeyParams "api_key" ApiKeyHeader)
        , _securitySchemeDescription = Nothing })
    , ("petstore_auth", SecurityScheme
        { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params
            { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"
            , _oauth2Scopes =
                [ ("write:pets",  "modify pets in your account")
                , ("read:pets", "read your pets") ] } )
        , _securitySchemeDescription = Nothing }) ]
  
  securityDefinitionsExampleJSON :: Value
  securityDefinitionsExampleJSON = [aesonQQ|
  {
    "api_key": {
      "type": "apiKey",
      "name": "api_key",
      "in": "header"
    },
    "petstore_auth": {
      "type": "oauth2",
      "authorizationUrl": "http://swagger.io/api/oauth/dialog",
      "flow": "implicit",
      "scopes": {
        "write:pets": "modify pets in your account",
        "read:pets": "read your pets"
      }
    }
  }
  |]
  
  oAuth2SecurityDefinitionsReadExample :: SecurityDefinitions
  oAuth2SecurityDefinitionsReadExample = SecurityDefinitions
    [ ("petstore_auth", SecurityScheme
        { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params
            { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"
            , _oauth2Scopes =
                [ ("read:pets", "read your pets") ] } )
        , _securitySchemeDescription = Nothing })
    ]
  
  oAuth2SecurityDefinitionsWriteExample :: SecurityDefinitions
  oAuth2SecurityDefinitionsWriteExample = SecurityDefinitions
    [ ("petstore_auth", SecurityScheme
        { _securitySchemeType = SecuritySchemeOAuth2 (OAuth2Params
            { _oauth2Flow = OAuth2Implicit "http://swagger.io/api/oauth/dialog"
            , _oauth2Scopes =
                [ ("write:pets", "modify pets in your account") ] } )
        , _securitySchemeDescription = Nothing })
    ]
  
  oAuth2SecurityDefinitionsExample :: SecurityDefinitions
  oAuth2SecurityDefinitionsExample =
    oAuth2SecurityDefinitionsWriteExample <>
    oAuth2SecurityDefinitionsReadExample
  
  oAuth2SecurityDefinitionsExampleJSON :: Value
  oAuth2SecurityDefinitionsExampleJSON = [aesonQQ|
  {
    "petstore_auth": {
      "type": "oauth2",
      "authorizationUrl": "http://swagger.io/api/oauth/dialog",
      "flow": "implicit",
      "scopes": {
        "write:pets": "modify pets in your account",
        "read:pets": "read your pets"
      }
    }
  }
  |]
  
  -- =======================================================================
  -- Swagger object
  -- =======================================================================
  
  emptyPathsFieldExample :: Swagger
  emptyPathsFieldExample = mempty
  
  emptyPathsFieldExampleJSON :: Value
  emptyPathsFieldExampleJSON = [aesonQQ|
  {
    "swagger": "2.0",
    "info": {"version": "", "title": ""},
    "paths": {}
  }
  |]
  
  swaggerExample :: Swagger
  swaggerExample = mempty
    & basePath ?~ "/"
    & schemes ?~ [Http]
    & info .~ (mempty
        & version .~ "1.0"
        & title .~ "Todo API"
        & license ?~ "MIT"
        & license._Just.url ?~ URL "http://mit.com"
        & description ?~ "This is a an API that tests servant-swagger support for a Todo API")
    & paths.at "/todo/{id}" ?~ (mempty & get ?~ ((mempty :: Operation)
        & at 200 ?~ Inline (mempty
            & description .~ "OK"
            & schema ?~ Inline (mempty
                & type_ ?~ SwaggerObject
                & example ?~ [aesonQQ|
                    {
                      "created": 100,
                      "description": "get milk"
                    } |]
                & description ?~ "This is some real Todo right here"
                & properties .~
                    [ ("created", Inline $ mempty
                        & type_  ?~ SwaggerInteger
                        & format ?~ "int32")
                    , ("description", Inline (mempty & type_ ?~ SwaggerString))]))
        & produces ?~ MimeList [ "application/json" ]
        & parameters .~
            [ Inline $ mempty
                & required ?~ True
                & name .~ "id"
                & description ?~ "TodoId param"
                & schema .~ ParamOther (mempty
                    & in_ .~ ParamPath
                    & type_ ?~ SwaggerString ) ]
        & tags .~ InsOrdHS.fromList [ "todo" ] ))
  
  swaggerExampleJSON :: Value
  swaggerExampleJSON = [aesonQQ|
  {
      "swagger": "2.0",
      "basePath": "/",
      "schemes": [
          "http"
      ],
      "info": {
          "version": "1.0",
          "title": "Todo API",
          "license": {
              "url": "http://mit.com",
              "name": "MIT"
          },
          "description": "This is a an API that tests servant-swagger support for a Todo API"
      },
      "paths": {
          "/todo/{id}": {
              "get": {
                  "responses": {
                      "200": {
                          "schema": {
                              "example": {
                                  "created": 100,
                                  "description": "get milk"
                              },
                              "type": "object",
                              "description": "This is some real Todo right here",
                              "properties": {
                                  "created": {
                                      "format": "int32",
                                      "type": "integer"
                                  },
                                  "description": {
                                      "type": "string"
                                  }
                              }
                          },
                          "description": "OK"
                      }
                  },
                  "produces": [
                      "application/json"
                  ],
                  "parameters": [
                      {
                          "required": true,
                          "in": "path",
                          "name": "id",
                          "type": "string",
                          "description": "TodoId param"
                      }
                  ],
                  "tags": [
                      "todo"
                  ]
              }
          }
      }
  }
  |]
  
  petstoreExampleJSON :: Value
  petstoreExampleJSON = [aesonQQ|
  {
     "swagger":"2.0",
     "info":{
        "description":"This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
        "version":"1.0.0",
        "title":"Swagger Petstore",
        "termsOfService":"http://swagger.io/terms/",
        "contact":{
           "email":"apiteam@swagger.io"
        },
        "license":{
           "name":"Apache 2.0",
           "url":"http://www.apache.org/licenses/LICENSE-2.0.html"
        }
     },
     "host":"petstore.swagger.io",
     "basePath":"/v2",
     "tags":[
        {
           "name":"pet",
           "description":"Everything about your Pets",
           "externalDocs":{
              "description":"Find out more",
              "url":"http://swagger.io"
           }
        },
        {
           "name":"store",
           "description":"Access to Petstore orders"
        },
        {
           "name":"user",
           "description":"Operations about user",
           "externalDocs":{
              "description":"Find out more about our store",
              "url":"http://swagger.io"
           }
        }
     ],
     "schemes":[
        "http"
     ],
     "paths":{
        "/pet":{
           "post":{
              "tags":[
                 "pet"
              ],
              "summary":"Add a new pet to the store",
              "description":"",
              "operationId":"addPet",
              "consumes":[
                 "application/json",
                 "application/xml"
              ],
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "in":"body",
                    "name":"body",
                    "description":"Pet object that needs to be added to the store",
                    "required":true,
                    "schema":{
                       "$ref":"#/definitions/Pet"
                    }
                 }
              ],
              "responses":{
                 "405":{
                    "description":"Invalid input"
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           },
           "put":{
              "tags":[
                 "pet"
              ],
              "summary":"Update an existing pet",
              "description":"",
              "operationId":"updatePet",
              "consumes":[
                 "application/json",
                 "application/xml"
              ],
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "in":"body",
                    "name":"body",
                    "description":"Pet object that needs to be added to the store",
                    "required":true,
                    "schema":{
                       "$ref":"#/definitions/Pet"
                    }
                 }
              ],
              "responses":{
                 "400":{
                    "description":"Invalid ID supplied"
                 },
                 "404":{
                    "description":"Pet not found"
                 },
                 "405":{
                    "description":"Validation exception"
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           }
        },
        "/pet/findByStatus":{
           "get":{
              "tags":[
                 "pet"
              ],
              "summary":"Finds Pets by status",
              "description":"Multiple status values can be provided with comma seperated strings",
              "operationId":"findPetsByStatus",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"status",
                    "in":"query",
                    "description":"Status values that need to be considered for filter",
                    "required":true,
                    "type":"array",
                    "items":{
                       "type":"string",
                       "enum":[
                          "available",
                          "pending",
                          "sold"
                       ],
                       "default":"available"
                    },
                    "collectionFormat":"csv"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "type":"array",
                       "items":{
                          "$ref":"#/definitions/Pet"
                       }
                    }
                 },
                 "400":{
                    "description":"Invalid status value"
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           }
        },
        "/pet/findByTags":{
           "get":{
              "tags":[
                 "pet"
              ],
              "summary":"Finds Pets by tags",
              "description":"Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
              "operationId":"findPetsByTags",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"tags",
                    "in":"query",
                    "description":"Tags to filter by",
                    "required":true,
                    "type":"array",
                    "items":{
                       "type":"string"
                    },
                    "collectionFormat":"csv"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "type":"array",
                       "items":{
                          "$ref":"#/definitions/Pet"
                       }
                    }
                 },
                 "400":{
                    "description":"Invalid tag value"
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           }
        },
        "/pet/{petId}":{
           "get":{
              "tags":[
                 "pet"
              ],
              "summary":"Find pet by ID",
              "description":"Returns a single pet",
              "operationId":"getPetById",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"petId",
                    "in":"path",
                    "description":"ID of pet to return",
                    "required":true,
                    "type":"integer",
                    "format":"int64"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "$ref":"#/definitions/Pet"
                    }
                 },
                 "400":{
                    "description":"Invalid ID supplied"
                 },
                 "404":{
                    "description":"Pet not found"
                 }
              },
              "security":[
                 {
                    "api_key": []
                 }
              ]
           },
           "post":{
              "tags":[
                 "pet"
              ],
              "summary":"Updates a pet in the store with form data",
              "description":"",
              "operationId":"updatePetWithForm",
              "consumes":[
                 "application/x-www-form-urlencoded"
              ],
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"petId",
                    "in":"path",
                    "description":"ID of pet that needs to be updated",
                    "required":true,
                    "type":"integer",
                    "format":"int64"
                 },
                 {
                    "name":"name",
                    "in":"formData",
                    "description":"Updated name of the pet",
                    "required":false,
                    "type":"string"
                 },
                 {
                    "name":"status",
                    "in":"formData",
                    "description":"Updated status of the pet",
                    "required":false,
                    "type":"string"
                 }
              ],
              "responses":{
                 "405":{
                    "description":"Invalid input"
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           },
           "delete":{
              "tags":[
                 "pet"
              ],
              "summary":"Deletes a pet",
              "description":"",
              "operationId":"deletePet",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"api_key",
                    "in":"header",
                    "required":false,
                    "type":"string"
                 },
                 {
                    "name":"petId",
                    "in":"path",
                    "description":"Pet id to delete",
                    "required":true,
                    "type":"integer",
                    "format":"int64"
                 }
              ],
              "responses":{
                 "400":{
                    "description":"Invalid pet value"
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           }
        },
        "/pet/{petId}/uploadImage":{
           "post":{
              "tags":[
                 "pet"
              ],
              "summary":"uploads an image",
              "description":"",
              "operationId":"uploadFile",
              "consumes":[
                 "multipart/form-data"
              ],
              "produces":[
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"petId",
                    "in":"path",
                    "description":"ID of pet to update",
                    "required":true,
                    "type":"integer",
                    "format":"int64"
                 },
                 {
                    "name":"additionalMetadata",
                    "in":"formData",
                    "description":"Additional data to pass to server",
                    "required":false,
                    "type":"string"
                 },
                 {
                    "name":"file",
                    "in":"formData",
                    "description":"file to upload",
                    "required":false,
                    "type":"file"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "$ref":"#/definitions/ApiResponse"
                    }
                 }
              },
              "security":[
                 {
                    "petstore_auth":[
                       "write:pets",
                       "read:pets"
                    ]
                 }
              ]
           }
        },
        "/store/inventory":{
           "get":{
              "tags":[
                 "store"
              ],
              "summary":"Returns pet inventories by status",
              "description":"Returns a map of status codes to quantities",
              "operationId":"getInventory",
              "produces":[
                 "application/json"
              ],
              "parameters": [],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "type":"object",
                       "additionalProperties":{
                          "type":"integer",
                          "format":"int32"
                       }
                    }
                 }
              },
              "security":[
                 {
                    "api_key": []
                 }
              ]
           }
        },
        "/store/order":{
           "post":{
              "tags":[
                 "store"
              ],
              "summary":"Place an order for a pet",
              "description":"",
              "operationId":"placeOrder",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "in":"body",
                    "name":"body",
                    "description":"order placed for purchasing the pet",
                    "required":true,
                    "schema":{
                       "$ref":"#/definitions/Order"
                    }
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "$ref":"#/definitions/Order"
                    }
                 },
                 "400":{
                    "description":"Invalid Order"
                 }
              }
           }
        },
        "/store/order/{orderId}":{
           "get":{
              "tags":[
                 "store"
              ],
              "summary":"Find purchase order by ID",
              "description":"For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
              "operationId":"getOrderById",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"orderId",
                    "in":"path",
                    "description":"ID of pet that needs to be fetched",
                    "required":true,
                    "type":"integer",
                    "maximum":5.0,
                    "minimum":1.0,
                    "format":"int64"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "$ref":"#/definitions/Order"
                    }
                 },
                 "400":{
                    "description":"Invalid ID supplied"
                 },
                 "404":{
                    "description":"Order not found"
                 }
              }
           },
           "delete":{
              "tags":[
                 "store"
              ],
              "summary":"Delete purchase order by ID",
              "description":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
              "operationId":"deleteOrder",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"orderId",
                    "in":"path",
                    "description":"ID of the order that needs to be deleted",
                    "required":true,
                    "type":"string",
                    "minimum":1.0
                 }
              ],
              "responses":{
                 "400":{
                    "description":"Invalid ID supplied"
                 },
                 "404":{
                    "description":"Order not found"
                 }
              }
           }
        },
        "/user":{
           "post":{
              "tags":[
                 "user"
              ],
              "summary":"Create user",
              "description":"This can only be done by the logged in user.",
              "operationId":"createUser",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "in":"body",
                    "name":"body",
                    "description":"Created user object",
                    "required":true,
                    "schema":{
                       "$ref":"#/definitions/User"
                    }
                 }
              ],
              "responses":{
                 "default":{
                    "description":"successful operation"
                 }
              }
           }
        },
        "/user/createWithArray":{
           "post":{
              "tags":[
                 "user"
              ],
              "summary":"Creates list of users with given input array",
              "description":"",
              "operationId":"createUsersWithArrayInput",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "in":"body",
                    "name":"body",
                    "description":"List of user object",
                    "required":true,
                    "schema":{
                       "type":"array",
                       "items":{
                          "$ref":"#/definitions/User"
                       }
                    }
                 }
              ],
              "responses":{
                 "default":{
                    "description":"successful operation"
                 }
              }
           }
        },
        "/user/createWithList":{
           "post":{
              "tags":[
                 "user"
              ],
              "summary":"Creates list of users with given input array",
              "description":"",
              "operationId":"createUsersWithListInput",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "in":"body",
                    "name":"body",
                    "description":"List of user object",
                    "required":true,
                    "schema":{
                       "type":"array",
                       "items":{
                          "$ref":"#/definitions/User"
                       }
                    }
                 }
              ],
              "responses":{
                 "default":{
                    "description":"successful operation"
                 }
              }
           }
        },
        "/user/login":{
           "get":{
              "tags":[
                 "user"
              ],
              "summary":"Logs user into the system",
              "description":"",
              "operationId":"loginUser",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"username",
                    "in":"query",
                    "description":"The user name for login",
                    "required":true,
                    "type":"string"
                 },
                 {
                    "name":"password",
                    "in":"query",
                    "description":"The password for login in clear text",
                    "required":true,
                    "type":"string"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "type":"string"
                    },
                    "headers":{
                       "X-Rate-Limit":{
                          "type":"integer",
                          "format":"int32",
                          "description":"calls per hour allowed by the user"
                       },
                       "X-Expires-After":{
                          "type":"string",
                          "format":"date-time",
                          "description":"date in UTC when toekn expires"
                       }
                    }
                 },
                 "400":{
                    "description":"Invalid username/password supplied"
                 }
              }
           }
        },
        "/user/logout":{
           "get":{
              "tags":[
                 "user"
              ],
              "summary":"Logs out current logged in user session",
              "description":"",
              "operationId":"logoutUser",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters": [],
              "responses":{
                 "default":{
                    "description":"successful operation"
                 }
              }
           }
        },
        "/user/{username}":{
           "get":{
              "tags":[
                 "user"
              ],
              "summary":"Get user by user name",
              "description":"",
              "operationId":"getUserByName",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"username",
                    "in":"path",
                    "description":"The name that needs to be fetched. Use user1 for testing. ",
                    "required":true,
                    "type":"string"
                 }
              ],
              "responses":{
                 "200":{
                    "description":"successful operation",
                    "schema":{
                       "$ref":"#/definitions/User"
                    }
                 },
                 "400":{
                    "description":"Invalid username supplied"
                 },
                 "404":{
                    "description":"User not found"
                 }
              }
           },
           "put":{
              "tags":[
                 "user"
              ],
              "summary":"Updated user",
              "description":"This can only be done by the logged in user.",
              "operationId":"updateUser",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"username",
                    "in":"path",
                    "description":"name that need to be deleted",
                    "required":true,
                    "type":"string"
                 },
                 {
                    "in":"body",
                    "name":"body",
                    "description":"Updated user object",
                    "required":true,
                    "schema":{
                       "$ref":"#/definitions/User"
                    }
                 }
              ],
              "responses":{
                 "400":{
                    "description":"Invalid user supplied"
                 },
                 "404":{
                    "description":"User not found"
                 }
              }
           },
           "delete":{
              "tags":[
                 "user"
              ],
              "summary":"Delete user",
              "description":"This can only be done by the logged in user.",
              "operationId":"deleteUser",
              "produces":[
                 "application/xml",
                 "application/json"
              ],
              "parameters":[
                 {
                    "name":"username",
                    "in":"path",
                    "description":"The name that needs to be deleted",
                    "required":true,
                    "type":"string"
                 }
              ],
              "responses":{
                 "400":{
                    "description":"Invalid username supplied"
                 },
                 "404":{
                    "description":"User not found"
                 }
              }
           }
        }
     },
     "securityDefinitions":{
        "petstore_auth":{
           "type":"oauth2",
           "authorizationUrl":"http://petstore.swagger.io/api/oauth/dialog",
           "flow":"implicit",
           "scopes":{
              "write:pets":"modify pets in your account",
              "read:pets":"read your pets"
           }
        },
        "api_key":{
           "type":"apiKey",
           "name":"api_key",
           "in":"header"
        }
     },
     "definitions":{
        "Order":{
           "type":"object",
           "properties":{
              "id":{
                 "type":"integer",
                 "format":"int64"
              },
              "petId":{
                 "type":"integer",
                 "format":"int64"
              },
              "quantity":{
                 "type":"integer",
                 "format":"int32"
              },
              "shipDate":{
                 "type":"string",
                 "format":"date-time"
              },
              "status":{
                 "type":"string",
                 "description":"Order Status",
                 "enum":[
                    "placed",
                    "approved",
                    "delivered"
                 ]
              },
              "complete":{
                 "type":"boolean",
                 "default":false
              }
           },
           "xml":{
              "name":"Order"
           }
        },
        "Category":{
           "type":"object",
           "properties":{
              "id":{
                 "type":"integer",
                 "format":"int64"
              },
              "name":{
                 "type":"string"
              }
           },
           "xml":{
              "name":"Category"
           }
        },
        "User":{
           "type":"object",
           "properties":{
              "id":{
                 "type":"integer",
                 "format":"int64"
              },
              "username":{
                 "type":"string"
              },
              "firstName":{
                 "type":"string"
              },
              "lastName":{
                 "type":"string"
              },
              "email":{
                 "type":"string"
              },
              "password":{
                 "type":"string"
              },
              "phone":{
                 "type":"string"
              },
              "userStatus":{
                 "type":"integer",
                 "format":"int32",
                 "description":"User Status"
              }
           },
           "xml":{
              "name":"User"
           }
        },
        "Tag":{
           "type":"object",
           "properties":{
              "id":{
                 "type":"integer",
                 "format":"int64"
              },
              "name":{
                 "type":"string"
              }
           },
           "xml":{
              "name":"Tag"
           }
        },
        "Pet":{
           "type":"object",
           "required":[
              "name",
              "photoUrls"
           ],
           "properties":{
              "id":{
                 "type":"integer",
                 "format":"int64"
              },
              "category":{
                 "$ref":"#/definitions/Category"
              },
              "name":{
                 "type":"string",
                 "example":"doggie"
              },
              "photoUrls":{
                 "type":"array",
                 "xml":{
                    "name":"photoUrl",
                    "wrapped":true
                 },
                 "items":{
                    "type":"string"
                 }
              },
              "tags":{
                 "type":"array",
                 "xml":{
                    "name":"tag",
                    "wrapped":true
                 },
                 "items":{
                    "$ref":"#/definitions/Tag"
                 }
              },
              "status":{
                 "type":"string",
                 "description":"pet status in the store",
                 "enum":[
                    "available",
                    "pending",
                    "sold"
                 ]
              }
           },
           "xml":{
              "name":"Pet"
           }
        },
        "ApiResponse":{
           "type":"object",
           "properties":{
              "code":{
                 "type":"integer",
                 "format":"int32"
              },
              "type":{
                 "type":"string"
              },
              "message":{
                 "type":"string"
              }
           }
        }
     },
     "externalDocs":{
        "description":"Find out more about Swagger",
        "url":"http://swagger.io"
     }
  }
  |]
  
  compositionSchemaExample :: Schema
  compositionSchemaExample = mempty
    & type_ ?~ SwaggerObject
    & Data.Swagger.allOf ?~ [
        Ref (Reference "Other")
      , Inline (mempty
               & type_ ?~ SwaggerObject
               & properties .~
                    [ ("greet", Inline $ mempty
                              & type_ ?~ SwaggerString) ])
    ]
  
  compositionSchemaExampleJSON :: Value
  compositionSchemaExampleJSON = [aesonQQ|
  {
    "type": "object",
    "allOf": [
        {
           "$ref": "#/definitions/Other"
        },
        {
          "type": "object",
          "properties": {
            "greet": { "type": "string" }
          }
        }
    ]
  }
  |]
  