bf90b8e · typeable/openapi3

70

71infoExample :: SwaggerInfo

72infoExample = SwaggerInfo

73− { swaggerInfoTitle = "Swagger Sample App"

73+ { _swaggerInfoTitle = "Swagger Sample App"

74− , swaggerInfoDescription = Just "This is a sample server Petstore server."

74+ , _swaggerInfoDescription = Just "This is a sample server Petstore server."

75− , swaggerInfoTermsOfService = Just "http://swagger.io/terms/"

75+ , _swaggerInfoTermsOfService = Just "http://swagger.io/terms/"

76− , swaggerInfoContact = Just contactExample

76+ , _swaggerInfoContact = Just contactExample

77− , swaggerInfoLicense = Just licenseExample

77+ , _swaggerInfoLicense = Just licenseExample

78− , swaggerInfoVersion = "1.0.1" }

78+ , _swaggerInfoVersion = "1.0.1" }

79 where

80 license = SwaggerLicense

81− { swaggerLicenseName = "Apache 2.0"

81+ { _swaggerLicenseName = "Apache 2.0"

82− , swaggerLicenseUrl = Just (URL "http://www.apache.org/licenses/LICENSE-2.0.html") }

82+ , _swaggerLicenseUrl = Just (URL "http://www.apache.org/licenses/LICENSE-2.0.html") }

83

84infoExampleJSON :: Value

85infoExampleJSON = [aesonQQ|

106

107contactExample :: SwaggerContact

108contactExample = SwaggerContact

109− { swaggerContactName = Just "API Support"

109+ { _swaggerContactName = Just "API Support"

110− , swaggerContactUrl = Just (URL "http://www.swagger.io/support")

110+ , _swaggerContactUrl = Just (URL "http://www.swagger.io/support")

111− , swaggerContactEmail = Just "support@swagger.io" }

111+ , _swaggerContactEmail = Just "support@swagger.io" }

112

113contactExampleJSON :: Value

114contactExampleJSON = [aesonQQ|

125

126licenseExample :: SwaggerLicense

127licenseExample = SwaggerLicense

128− { swaggerLicenseName = "Apache 2.0"

128+ { _swaggerLicenseName = "Apache 2.0"

129− , swaggerLicenseUrl = Just (URL "http://www.apache.org/licenses/LICENSE-2.0.html") }

129+ , _swaggerLicenseUrl = Just (URL "http://www.apache.org/licenses/LICENSE-2.0.html") }

130

131licenseExampleJSON :: Value

132licenseExampleJSON = [aesonQQ|

143

144operationExample :: SwaggerOperation

145operationExample = mempty

146− { swaggerOperationTags = ["pet"]

146+ { _swaggerOperationTags = ["pet"]

147− , swaggerOperationSummary = Just "Updates a pet in the store with form data"

147+ , _swaggerOperationSummary = Just "Updates a pet in the store with form data"

148− , swaggerOperationDescription = Just ""

148+ , _swaggerOperationDescription = Just ""

149− , swaggerOperationOperationId = Just "updatePetWithForm"

149+ , _swaggerOperationOperationId = Just "updatePetWithForm"

150− , swaggerOperationConsumes = Just (SwaggerMimeList ["application/x-www-form-urlencoded"])

150+ , _swaggerOperationConsumes = Just (SwaggerMimeList ["application/x-www-form-urlencoded"])

151− , swaggerOperationProduces = Just (SwaggerMimeList ["application/json", "application/xml"])

151+ , _swaggerOperationProduces = Just (SwaggerMimeList ["application/json", "application/xml"])

152− , swaggerOperationParameters = params

152+ , _swaggerOperationParameters = params

153− , swaggerOperationResponses = responses

153+ , _swaggerOperationResponses = responses

154− , swaggerOperationSecurity = security

154+ , _swaggerOperationSecurity = security

155 }

156 where

157 security = [SwaggerSecurityRequirement [("petstore_auth", ["write:pets", "read:pets"])]]

158

159 responses = mempty

160− { swaggerResponsesResponses =

160+ { _swaggerResponsesResponses =

161− [ (200, SwaggerInline mempty { swaggerResponseDescription = "Pet updated." })

161+ [ (200, SwaggerInline mempty { _swaggerResponseDescription = "Pet updated." })

162− , (405, SwaggerInline mempty { swaggerResponseDescription = "Invalid input" }) ] }

162+ , (405, SwaggerInline mempty { _swaggerResponseDescription = "Invalid input" }) ] }

163

164 params = map SwaggerInline

165 [ SwaggerParameter

166− { swaggerParameterName = "petId"

166+ { _swaggerParameterName = "petId"

167− , swaggerParameterDescription = Just "ID of pet that needs to be updated"

167+ , _swaggerParameterDescription = Just "ID of pet that needs to be updated"

168− , swaggerParameterRequired = True

168+ , _swaggerParameterRequired = True

169− , swaggerParameterSchema = SwaggerParameterOther (stringSchema SwaggerParameterPath) }

169+ , _swaggerParameterSchema = SwaggerParameterOther (stringSchema SwaggerParameterPath) }

170 , SwaggerParameter

171− { swaggerParameterName = "name"

171+ { _swaggerParameterName = "name"

172− , swaggerParameterDescription = Just "Updated name of the pet"

172+ , _swaggerParameterDescription = Just "Updated name of the pet"

173− , swaggerParameterRequired = False

173+ , _swaggerParameterRequired = False

174− , swaggerParameterSchema = SwaggerParameterOther (stringSchema SwaggerParameterFormData) }

174+ , _swaggerParameterSchema = SwaggerParameterOther (stringSchema SwaggerParameterFormData) }

175 , SwaggerParameter

176− { swaggerParameterName = "status"

176+ { _swaggerParameterName = "status"

177− , swaggerParameterDescription = Just "Updated status of the pet"

177+ , _swaggerParameterDescription = Just "Updated status of the pet"

178− , swaggerParameterRequired = False

178+ , _swaggerParameterRequired = False

179− , swaggerParameterSchema = SwaggerParameterOther (stringSchema SwaggerParameterFormData) }

179+ , _swaggerParameterSchema = SwaggerParameterOther (stringSchema SwaggerParameterFormData) }

180 ]

181

182 stringSchema i = mempty

183− { swaggerParameterOtherSchemaIn = i

183+ { _swaggerParameterOtherSchemaIn = i

184− , swaggerParameterOtherSchemaType = SwaggerParamString

184+ , _swaggerParameterOtherSchemaType = SwaggerParamString

185 }

186

187operationExampleJSON :: Value

248

249schemaPrimitiveExample :: SwaggerSchema

250schemaPrimitiveExample = mempty

251− { swaggerSchemaType = SwaggerSchemaString

251+ { _swaggerSchemaType = SwaggerSchemaString

252− , swaggerSchemaFormat = Just "email"

252+ , _swaggerSchemaFormat = Just "email"

253 }

254

255schemaPrimitiveExampleJSON :: Value

262

263schemaSimpleModelExample :: SwaggerSchema

264schemaSimpleModelExample = mempty

265− { swaggerSchemaType = SwaggerSchemaObject

265+ { _swaggerSchemaType = SwaggerSchemaObject

266− , swaggerSchemaRequired = [ "name" ]

266+ , _swaggerSchemaRequired = [ "name" ]

267− , swaggerSchemaProperties =

267+ , _swaggerSchemaProperties =

268 [ ("name", SwaggerInline mempty

269− { swaggerSchemaType = SwaggerSchemaString } )

269+ { _swaggerSchemaType = SwaggerSchemaString } )

270− , ("address", SwaggerRef (SwaggerReference "#/definitions/Address"))

271 , ("age", SwaggerInline mempty

270 , ("age", SwaggerInline mempty

272− { swaggerSchemaType = SwaggerSchemaInteger

271+ { _swaggerSchemaType = SwaggerSchemaInteger

273− , swaggerSchemaFormat = Just "int32"

272+ , _swaggerSchemaFormat = Just "int32"

274− , swaggerSchemaCommon = mempty

273+ , _swaggerSchemaCommon = mempty

275− { swaggerSchemaMinimum = Just 0 } } ) ] }

274+ { _swaggerSchemaMinimum = Just 0 } } ) ] }

276

275

277schemaSimpleModelExampleJSON :: Value

276schemaSimpleModelExampleJSON :: Value

278schemaSimpleModelExampleJSON = [aesonQQ|

277schemaSimpleModelExampleJSON = [aesonQQ|

299

298

300schemaModelDictExample :: SwaggerSchema

299schemaModelDictExample :: SwaggerSchema

301schemaModelDictExample = mempty

300schemaModelDictExample = mempty

302− { swaggerSchemaType = SwaggerSchemaObject

301+ { _swaggerSchemaType = SwaggerSchemaObject

303− , swaggerSchemaAdditionalProperties = Just mempty

302+ , _swaggerSchemaAdditionalProperties = Just mempty

304− { swaggerSchemaType = SwaggerSchemaString } }

303+ { _swaggerSchemaType = SwaggerSchemaString } }

305

304

306schemaModelDictExampleJSON :: Value

305schemaModelDictExampleJSON :: Value

307schemaModelDictExampleJSON = [aesonQQ|

306schemaModelDictExampleJSON = [aesonQQ|

315

314

316schemaWithExampleExample :: SwaggerSchema

315schemaWithExampleExample :: SwaggerSchema

317schemaWithExampleExample = mempty

316schemaWithExampleExample = mempty

318− { swaggerSchemaType = SwaggerSchemaObject

317+ { _swaggerSchemaType = SwaggerSchemaObject

319− , swaggerSchemaProperties =

318+ , _swaggerSchemaProperties =

320 [ ("id", SwaggerInline mempty

319 [ ("id", SwaggerInline mempty

321− { swaggerSchemaType = SwaggerSchemaInteger

320+ { _swaggerSchemaType = SwaggerSchemaInteger

322− , swaggerSchemaFormat = Just "int64" })

321+ , _swaggerSchemaFormat = Just "int64" })

323 , ("name", SwaggerInline mempty

322 , ("name", SwaggerInline mempty

324− { swaggerSchemaType = SwaggerSchemaString }) ]

323+ { _swaggerSchemaType = SwaggerSchemaString }) ]

325− , swaggerSchemaRequired = [ "name" ]

324+ , _swaggerSchemaRequired = [ "name" ]

326− , swaggerSchemaExample = Just [aesonQQ|

325+ , _swaggerSchemaExample = Just [aesonQQ|

327 {

326 {

328 "name": "Puma",

327 "name": "Puma",

329 "id": 1

328 "id": 1

360definitionsExample :: HashMap Text SwaggerSchema

359definitionsExample :: HashMap Text SwaggerSchema

361definitionsExample =

360definitionsExample =

362 [ ("Category", mempty

361 [ ("Category", mempty

363− { swaggerSchemaType = SwaggerSchemaObject

362+ { _swaggerSchemaType = SwaggerSchemaObject

364− , swaggerSchemaProperties =

363+ , _swaggerSchemaProperties =

365 [ ("id", SwaggerInline mempty

364 [ ("id", SwaggerInline mempty

366− { swaggerSchemaType = SwaggerSchemaInteger

365+ { _swaggerSchemaType = SwaggerSchemaInteger

367− , swaggerSchemaFormat = Just "int64" })

366+ , _swaggerSchemaFormat = Just "int64" })

368 , ("name", SwaggerInline mempty

367 , ("name", SwaggerInline mempty

369− { swaggerSchemaType = SwaggerSchemaString }) ] })

368+ { _swaggerSchemaType = SwaggerSchemaString }) ] })

370 , ("Tag", mempty

369 , ("Tag", mempty

371− { swaggerSchemaType = SwaggerSchemaObject

370+ { _swaggerSchemaType = SwaggerSchemaObject

372− , swaggerSchemaProperties =

371+ , _swaggerSchemaProperties =

373 [ ("id", SwaggerInline mempty

372 [ ("id", SwaggerInline mempty

374− { swaggerSchemaType = SwaggerSchemaInteger

373+ { _swaggerSchemaType = SwaggerSchemaInteger

375− , swaggerSchemaFormat = Just "int64" })

374+ , _swaggerSchemaFormat = Just "int64" })

376 , ("name", SwaggerInline mempty

375 , ("name", SwaggerInline mempty

377− { swaggerSchemaType = SwaggerSchemaString }) ] }) ]

376+ { _swaggerSchemaType = SwaggerSchemaString }) ] }) ]

378

377

379definitionsExampleJSON :: Value

378definitionsExampleJSON :: Value

380definitionsExampleJSON = [aesonQQ|

379definitionsExampleJSON = [aesonQQ|

413parametersDefinitionExample :: HashMap Text SwaggerParameter

412parametersDefinitionExample :: HashMap Text SwaggerParameter

414parametersDefinitionExample =

413parametersDefinitionExample =

415 [ ("skipParam", mempty

414 [ ("skipParam", mempty

416− { swaggerParameterName = "skip"

415+ { _swaggerParameterName = "skip"

417− , swaggerParameterDescription = Just "number of items to skip"

416+ , _swaggerParameterDescription = Just "number of items to skip"

418− , swaggerParameterRequired = True

417+ , _swaggerParameterRequired = True

419− , swaggerParameterSchema = SwaggerParameterOther mempty

418+ , _swaggerParameterSchema = SwaggerParameterOther mempty

420− { swaggerParameterOtherSchemaIn = SwaggerParameterQuery

419+ { _swaggerParameterOtherSchemaIn = SwaggerParameterQuery

421− , swaggerParameterOtherSchemaType = SwaggerParamInteger

420+ , _swaggerParameterOtherSchemaType = SwaggerParamInteger

422− , swaggerParameterOtherSchemaFormat = Just "int32" } })

421+ , _swaggerParameterOtherSchemaFormat = Just "int32" } })

423 , ("limitParam", mempty

422 , ("limitParam", mempty

424− { swaggerParameterName = "limit"

423+ { _swaggerParameterName = "limit"

425− , swaggerParameterDescription = Just "max records to return"

424+ , _swaggerParameterDescription = Just "max records to return"

426− , swaggerParameterRequired = True

425+ , _swaggerParameterRequired = True

427− , swaggerParameterSchema = SwaggerParameterOther mempty

426+ , _swaggerParameterSchema = SwaggerParameterOther mempty

428− { swaggerParameterOtherSchemaIn = SwaggerParameterQuery

427+ { _swaggerParameterOtherSchemaIn = SwaggerParameterQuery

429− , swaggerParameterOtherSchemaType = SwaggerParamInteger

428+ , _swaggerParameterOtherSchemaType = SwaggerParamInteger

430− , swaggerParameterOtherSchemaFormat = Just "int32" } }) ]

429+ , _swaggerParameterOtherSchemaFormat = Just "int32" } }) ]

431

430

432parametersDefinitionExampleJSON :: Value

431parametersDefinitionExampleJSON :: Value

433parametersDefinitionExampleJSON = [aesonQQ|

432parametersDefinitionExampleJSON = [aesonQQ|

457

456

458responsesDefinitionExample :: HashMap Text SwaggerResponse

457responsesDefinitionExample :: HashMap Text SwaggerResponse

459responsesDefinitionExample =

458responsesDefinitionExample =

460− [ ("NotFound", mempty { swaggerResponseDescription = "Entity not found." })

459+ [ ("NotFound", mempty { _swaggerResponseDescription = "Entity not found." })

461− , ("IllegalInput", mempty { swaggerResponseDescription = "Illegal input for operation." }) ]

460+ , ("IllegalInput", mempty { _swaggerResponseDescription = "Illegal input for operation." }) ]

462

461

463responsesDefinitionExampleJSON :: Value

462responsesDefinitionExampleJSON :: Value

464responsesDefinitionExampleJSON = [aesonQQ|

463responsesDefinitionExampleJSON = [aesonQQ|

479securityDefinitionsExample :: HashMap Text SwaggerSecurityScheme

478securityDefinitionsExample :: HashMap Text SwaggerSecurityScheme

480securityDefinitionsExample =

479securityDefinitionsExample =

481 [ ("api_key", SwaggerSecurityScheme

480 [ ("api_key", SwaggerSecurityScheme

482− { swaggerSecuritySchemeType = SwaggerSecuritySchemeApiKey (SwaggerApiKeyParams "api_key" SwaggerApiKeyHeader)

481+ { _swaggerSecuritySchemeType = SwaggerSecuritySchemeApiKey (SwaggerApiKeyParams "api_key" SwaggerApiKeyHeader)

483− , swaggerSecuritySchemeDescription = Nothing })

482+ , _swaggerSecuritySchemeDescription = Nothing })

484 , ("petstore_auth", SwaggerSecurityScheme

483 , ("petstore_auth", SwaggerSecurityScheme

485− { swaggerSecuritySchemeType = SwaggerSecuritySchemeOAuth2 (SwaggerOAuth2Params

484+ { _swaggerSecuritySchemeType = SwaggerSecuritySchemeOAuth2 (SwaggerOAuth2Params

486− { swaggerOAuth2Flow = SwaggerOAuth2Implicit "http://swagger.io/api/oauth/dialog"

485+ { _swaggerOAuth2Flow = SwaggerOAuth2Implicit "http://swagger.io/api/oauth/dialog"

487− , swaggerOAuth2Scopes =

486+ , _swaggerOAuth2Scopes =

488 [ ("write:pets", "modify pets in your account")

487 [ ("write:pets", "modify pets in your account")

489 , ("read:pets", "read your pets") ] } )

488 , ("read:pets", "read your pets") ] } )

490− , swaggerSecuritySchemeDescription = Nothing }) ]

489+ , _swaggerSecuritySchemeDescription = Nothing }) ]

491

490

492securityDefinitionsExampleJSON :: Value

491securityDefinitionsExampleJSON :: Value

493securityDefinitionsExampleJSON = [aesonQQ|

492securityDefinitionsExampleJSON = [aesonQQ|

515

514

516swaggerExample :: Swagger

515swaggerExample :: Swagger

517swaggerExample = mempty

516swaggerExample = mempty

518− { swaggerBasePath = Just "/"

517+ { _swaggerBasePath = Just "/"

519− , swaggerSchemes = Just [Http]

518+ , _swaggerSchemes = Just [Http]

520− , swaggerInfo = mempty

519+ , _swaggerInfo = mempty

521− { swaggerInfoVersion = "1.0"

520+ { _swaggerInfoVersion = "1.0"

522− , swaggerInfoTitle = "Todo API"

521+ , _swaggerInfoTitle = "Todo API"

523− , swaggerInfoLicense = Just SwaggerLicense

522+ , _swaggerInfoLicense = Just SwaggerLicense

524− { swaggerLicenseName = "MIT"

523+ { _swaggerLicenseName = "MIT"

525− , swaggerLicenseUrl = Just (URL "http://mit.com") }

524+ , _swaggerLicenseUrl = Just (URL "http://mit.com") }

526− , swaggerInfoDescription = Just "This is a an API that tests servant-swagger support for a Todo API" }

525+ , _swaggerInfoDescription = Just "This is a an API that tests servant-swagger support for a Todo API" }

527− , swaggerPaths = mempty

526+ , _swaggerPaths = mempty

528− { swaggerPathsMap =

527+ { _swaggerPathsMap =

529 [ ("/todo/{id}", mempty

528 [ ("/todo/{id}", mempty

530− { swaggerPathItemGet = Just mempty

529+ { _swaggerPathItemGet = Just mempty

531− { swaggerOperationResponses = mempty

530+ { _swaggerOperationResponses = mempty

532− { swaggerResponsesResponses =

531+ { _swaggerResponsesResponses =

533 [ (200, SwaggerInline mempty

532 [ (200, SwaggerInline mempty

534− { swaggerResponseSchema = Just $ SwaggerInline mempty

533+ { _swaggerResponseSchema = Just $ SwaggerInline mempty

535− { swaggerSchemaExample = Just [aesonQQ|

534+ { _swaggerSchemaExample = Just [aesonQQ|

536 {

535 {

537 "created": 100,

536 "created": 100,

538 "description": "get milk"

537 "description": "get milk"

539 } |]

538 } |]

540− , swaggerSchemaType = SwaggerSchemaObject

539+ , _swaggerSchemaType = SwaggerSchemaObject

541− , swaggerSchemaDescription = Just "This is some real Todo right here"

540+ , _swaggerSchemaDescription = Just "This is some real Todo right here"

542− , swaggerSchemaProperties =

541+ , _swaggerSchemaProperties =

543 [ ("created", SwaggerInline mempty

542 [ ("created", SwaggerInline mempty

544− { swaggerSchemaType = SwaggerSchemaInteger

543+ { _swaggerSchemaType = SwaggerSchemaInteger

545− , swaggerSchemaFormat = Just "int32" })

544+ , _swaggerSchemaFormat = Just "int32" })

546 , ("description", SwaggerInline mempty

545 , ("description", SwaggerInline mempty

547− { swaggerSchemaType = SwaggerSchemaString }) ] }

546+ { _swaggerSchemaType = SwaggerSchemaString }) ] }

548− , swaggerResponseDescription = "OK" }) ] }

547+ , _swaggerResponseDescription = "OK" }) ] }

549− , swaggerOperationProduces = Just (SwaggerMimeList [ "application/json" ])

548+ , _swaggerOperationProduces = Just (SwaggerMimeList [ "application/json" ])

550− , swaggerOperationParameters =

549+ , _swaggerOperationParameters =

551 [ SwaggerInline mempty

550 [ SwaggerInline mempty

552− { swaggerParameterRequired = True

551+ { _swaggerParameterRequired = True

553− , swaggerParameterName = "id"

552+ , _swaggerParameterName = "id"

554− , swaggerParameterDescription = Just "TodoId param"

553+ , _swaggerParameterDescription = Just "TodoId param"

555− , swaggerParameterSchema = SwaggerParameterOther mempty

554+ , _swaggerParameterSchema = SwaggerParameterOther mempty

556− { swaggerParameterOtherSchemaIn = SwaggerParameterPath

555+ { _swaggerParameterOtherSchemaIn = SwaggerParameterPath

557− , swaggerParameterOtherSchemaType = SwaggerParamString } } ]

556+ , _swaggerParameterOtherSchemaType = SwaggerParamString } } ]

558− , swaggerOperationTags = [ "todo" ] } }) ] } }

557+ , _swaggerOperationTags = [ "todo" ] } }) ] } }

559

558

560swaggerExampleJSON :: Value

559swaggerExampleJSON :: Value

561swaggerExampleJSON = [aesonQQ|

560swaggerExampleJSON = [aesonQQ|