swagger2 2.0 → 2.0.1
raw patch · 11 files changed
+35/−13 lines, 11 files
Files
- CHANGELOG.md +7/−0
- LICENSE +1/−1
- src/Data/Swagger.hs +7/−2
- src/Data/Swagger/Declare.hs +6/−0
- src/Data/Swagger/Lens.hs +6/−0
- src/Data/Swagger/Operation.hs +0/−2
- src/Data/Swagger/ParamSchema.hs +0/−2
- src/Data/Swagger/Schema.hs +0/−2
- src/Data/Swagger/Schema/Validation.hs +0/−2
- src/Data/Swagger/SchemaOptions.hs +6/−0
- swagger2.cabal +2/−2
CHANGELOG.md view
@@ -1,3 +1,10 @@+2.0.1+---++* Fixes:+ * Re-export `Pattern` synonym from `Data.Swagger`;+ * Documentation fixes.+ 2.0 ---
LICENSE view
@@ -1,4 +1,4 @@-Copyright (c) 2015, GetShopTV+Copyright (c) 2015-2016, GetShopTV All rights reserved. Redistribution and use in source and binary forms, with or without
src/Data/Swagger.hs view
@@ -1,4 +1,8 @@ -- |+-- Module: Data.Swagger+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>+-- Stability: experimental+-- -- Swagger™ is a project used to describe and document RESTful APIs. -- -- The Swagger specification defines a set of files required to describe such an API.@@ -71,6 +75,7 @@ NamedSchema(..), SwaggerItems(..), Xml(..),+ Pattern, -- ** Responses Responses(..),@@ -274,10 +279,10 @@ -- for a type-level servant API. -- -- Lenses and prisms can be used to manipulate such specification to add additional information, tags, extra responses, etc.--- To facilitate common needs, @'Data.Swagger.Operation'@ module provides useful helpers.+-- To facilitate common needs, @"Data.Swagger.Operation"@ module provides useful helpers. -- $validation -- While @'ToParamSchema'@ and @'ToSchema'@ provide means to easily obtain schemas for Haskell types, -- there is no static mechanism to ensure those instances correspond to the @'ToHttpApiData'@ or @'ToJSON'@ instances. ----- @'Data.Swagger.Schema.Validation'@ addresses @'ToJSON'@/@'ToSchema'@ validation.+-- @"Data.Swagger.Schema.Validation"@ addresses @'ToJSON'@/@'ToSchema'@ validation.
src/Data/Swagger/Declare.hs view
@@ -2,6 +2,12 @@ {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE FunctionalDependencies #-} {-# LANGUAGE MultiParamTypeClasses #-}+-- |+-- Module: Data.Swagger.Declare+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>+-- Stability: experimental+--+-- Declare monad transformer and associated functions. module Data.Swagger.Declare where import Prelude ()
src/Data/Swagger/Lens.hs view
@@ -10,6 +10,12 @@ {-# LANGUAGE UndecidableInstances #-} {-# OPTIONS_GHC -fno-warn-orphans #-} #include "overlapping-compat.h"+-- |+-- Module: Data.Swagger.Lens+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>+-- Stability: experimental+--+-- Lenses and prisms for Swagger. module Data.Swagger.Lens where import Control.Lens
src/Data/Swagger/Operation.hs view
@@ -1,8 +1,6 @@ {-# LANGUAGE RankNTypes #-} -- | -- Module: Data.Swagger.Operation--- Copyright: (c) 2015 GetShopTV--- License: BSD3 -- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com> -- Stability: experimental --
src/Data/Swagger/ParamSchema.hs view
@@ -1,7 +1,5 @@ -- | -- Module: Data.Swagger.ParamSchema--- Copyright: (c) 2015 GetShopTV--- License: BSD3 -- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com> -- Stability: experimental --
src/Data/Swagger/Schema.hs view
@@ -1,7 +1,5 @@ -- | -- Module: Data.Swagger.Schema--- Copyright: (c) 2015 GetShopTV--- License: BSD3 -- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com> -- Stability: experimental --
src/Data/Swagger/Schema/Validation.hs view
@@ -1,7 +1,5 @@ -- | -- Module: Data.Swagger.Schema.Validation--- Copyright: (c) 2015 GetShopTV--- License: BSD3 -- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com> -- Stability: experimental --
src/Data/Swagger/SchemaOptions.hs view
@@ -1,3 +1,9 @@+-- |+-- Module: Data.Swagger.SchemaOptions+-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>+-- Stability: experimental+--+-- Generic deriving options for @'ToParamSchema'@ and @'ToSchema'@. module Data.Swagger.SchemaOptions where -- | Options that specify how to encode your type to Swagger schema.
swagger2.cabal view
@@ -1,5 +1,5 @@ name: swagger2-version: 2.0+version: 2.0.1 synopsis: Swagger 2.0 data model description: Please see README.md homepage: https://github.com/GetShopTV/swagger2@@ -8,7 +8,7 @@ license-file: LICENSE author: Nickolay Kudasov maintainer: nickolay@getshoptv.com-copyright: (c) 2015, GetShopTV+copyright: (c) 2015-2016, GetShopTV category: Web build-type: Simple extra-source-files: