git.iko.soy/deriving-openapi3
on master help sign in
swap
7299ae213 ahead, 0 behind
3 files changed+19−27
since splitsnapshots
unifiedsplit
.github/workflows/build.yaml+2−6 deriving-openapi3.cabal+3−11 src/Deriving/OpenApi.hs+14−10
.github/workflows/build.yaml+2−6
@@ -17,7 +17,7 @@ jobs:
1717 - name: Check library version
1818 if: github.event_name == 'release'
1919 run: |
20− if [ "$(yq eval ".version" package.yaml)" != "${{ github.event.release.tag_name }}" ]; then
20+ if [ "$(awk -F":" '{if ($1 == "version") {gsub(/ /, "", $2); print $2}}' *.cabal)" != "${{ github.event.release.tag_name }}" ]; then
2121 echo "::error file=action.yaml::Library version does not match release version."
2222 exit 1
2323 fi
@@ -33,15 +33,11 @@ jobs:
3333 path: |
3434 ~/.stack
3535 .stack-work
36− key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
36+ key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('**.cabal') }}
3737 restore-keys: |
3838 ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}
3939 ${{ runner.os }}-stack
4040
41− - name: Upgrade stack
42− shell: bash
43− run: stack upgrade --git
44−
4541 - name: Build
4642 shell: bash
4743 run: |
deriving-openapi3.cabal+3−11
@@ -22,11 +22,6 @@ source-repository head
2222 type: git
2323 location: https://github.com/ilyakooo0/deriving-openapi3
2424
25−flag servant-description
26− description: Create instances for the 'Description' type from 'servant'
27− manual: False
28− default: True
29−
3025library
3126 exposed-modules:
3227 Deriving.OpenApi
@@ -48,16 +43,13 @@ library
4843 OverloadedStrings
4944 DerivingStrategies
5045 DerivingVia
46+ FlexibleContexts
5147 ghc-options: -Weverything -Wno-star-is-type -Wno-unsafe -Wno-prepositive-qualified-module -Wno-safe -Wno-missing-safe-haskell-mode -Wno-missing-import-lists -Wno-implicit-prelude
5248 build-depends:
5349 aeson
54− , base
55− , deriving-aeson
50+ , base >=4.12
51+ , deriving-aeson >=0.2.2
5652 , lens
5753 , openapi3
5854 , text
59− if flag(servant-description)
60− cpp-options: -DSERVANT_DESCRIPTION
61− build-depends:
62− servant
6355 default-language: Haskell2010
src/Deriving/OpenApi.hs+14−10
@@ -39,22 +39,17 @@ where
3939import Control.Lens
4040import qualified Data.Aeson.Types as A
4141import Data.OpenApi
42+import Data.OpenApi.Internal.ParamSchema
4243import Data.OpenApi.Internal.Schema
4344import Data.Proxy
45+import Data.Text (Text)
46+import qualified Data.Text as T
4447import Data.Typeable
4548import Deriving.Aeson
4649import GHC.Generics
4750import GHC.TypeLits
4851
49−-- $setup
50−-- >>> import qualified Data.Yaml
51−-- >>> import qualified Data.ByteString.Char8
52−
53−#ifdef SERVANT_DESCRIPTION
54−
55−import Servant.API
56−import Data.Text (Text)
57−import qualified Data.Text as T
52+data Description (desc :: Symbol) = Description
5853
5954instance (AesonOptions xs) => AesonOptions (Description f ': xs) where
6055 aesonOptions = aesonOptions @xs
@@ -65,7 +60,9 @@ instance KnownSymbol t => OpenApiOptionModifier (Description t) where
6560toTextLine :: forall s. KnownSymbol s => Text
6661toTextLine = "\n\n" <> T.pack (symbolVal (Proxy @s))
6762
68−#endif
63+-- $setup
64+-- >>> import qualified Data.Yaml
65+-- >>> import qualified Data.ByteString.Char8
6966
7067type CustomOpenApi = CustomJSON
7168
@@ -77,6 +74,13 @@ instance
7774 openApiSchemaModifier @xs
7875 <$> genericDeclareNamedSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
7976
77+instance
78+ (OpenApiOptionModifier xs, GToParamSchema (Rep x), Generic x) =>
79+ ToParamSchema (CustomJSON (xs :: k) x)
80+ where
81+ toParamSchema Proxy =
82+ genericToParamSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
83+
8084class OpenApiOptionModifier x where
8185 openApiOptionsModifier :: SchemaOptions -> SchemaOptions
8286 openApiOptionsModifier = id