git.iko.soy/deriving-openapi3
on 4d656fd help sign in
7299ae2
swap
0 ahead, 15 behind
4 files changed+80−15
since splitsnapshots
unifiedsplit
.github/workflows/build.yaml+6−2 deriving-openapi3.cabal+11−3 package.yaml+51 src/Deriving/OpenApi.hs+12−10
.github/workflows/build.yaml+6−2
@@ -17,7 +17,7 @@ jobs:
1717 - name: Check library version
1818 if: github.event_name == 'release'
1919 run: |
20− if [ "$(awk -F":" '{if ($1 == "version") {gsub(/ /, "", $2); print $2}}' *.cabal)" != "${{ github.event.release.tag_name }}" ]; then
20+ if [ "$(yq eval ".version" package.yaml)" != "${{ 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,11 +33,15 @@ jobs:
3333 path: |
3434 ~/.stack
3535 .stack-work
36− key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('**.cabal') }}
36+ key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
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+
4145 - name: Build
4246 shell: bash
4347 run: |
deriving-openapi3.cabal+11−3
@@ -22,6 +22,11 @@ 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+
2530library
2631 exposed-modules:
2732 Deriving.OpenApi
@@ -43,13 +48,16 @@ library
4348 OverloadedStrings
4449 DerivingStrategies
4550 DerivingVia
46− FlexibleContexts
4751 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
4852 build-depends:
4953 aeson
50− , base >=4.12
51− , deriving-aeson >=0.2.2
54+ , base
55+ , deriving-aeson
5256 , lens
5357 , openapi3
5458 , text
59+ if flag(servant-description)
60+ cpp-options: -DSERVANT_DESCRIPTION
61+ build-depends:
62+ servant
5563 default-language: Haskell2010
package.yamlnew file+51
@@ -0,0 +1,51 @@
1+name: deriving-openapi3
2+version: 0.1.0.0
3+synopsis: DerivingVia for OpenAPI 3
4+description: DerivingVia for OpenAPI 3
5+maintainer: Ilya Kostyuchenko <ilyakooo0@gmail.com>
6+category: JSON, Generics, OpenAPI
7+license: MIT
8+license-file: LICENSE
9+extra-source-files: Changelog.md
10+github: ilyakooo0/deriving-openapi3
11+ghc-options: -Weverything
12+ -Wno-star-is-type
13+ -Wno-unsafe
14+ -Wno-prepositive-qualified-module
15+ -Wno-safe
16+ -Wno-missing-safe-haskell-mode
17+ -Wno-missing-import-lists
18+ -Wno-implicit-prelude
19+dependencies:
20+ - base
21+ - openapi3
22+ - deriving-aeson
23+ - aeson
24+ - lens
25+ - text
26+when:
27+ - condition: flag(servant-description)
28+ dependencies:
29+ - servant
30+ cpp-options: -DSERVANT_DESCRIPTION
31+library:
32+ source-dirs: src
33+default-extensions:
34+ - AllowAmbiguousTypes
35+ - ScopedTypeVariables
36+ - KindSignatures
37+ - DataKinds
38+ - TypeOperators
39+ - FlexibleInstances
40+ - TypeApplications
41+ - UndecidableInstances
42+ - TypeFamilies
43+ - PolyKinds
44+ - OverloadedStrings
45+ - DerivingStrategies
46+ - DerivingVia
47+flags:
48+ servant-description:
49+ description: Create instances for the 'Description' type from 'servant'
50+ default: true
51+ manual: false
src/Deriving/OpenApi.hs+12−10
@@ -39,17 +39,23 @@ where
3939import Control.Lens
4040import qualified Data.Aeson.Types as A
4141import Data.OpenApi
42−import Data.OpenApi.Internal.ParamSchema
4342import Data.OpenApi.Internal.Schema
43+import Data.OpenApi.Internal.ParamSchema
4444import Data.Proxy
45−import Data.Text (Text)
46−import qualified Data.Text as T
4745import Data.Typeable
4846import Deriving.Aeson
4947import GHC.Generics
5048import GHC.TypeLits
5149
52−data Description (desc :: Symbol) = Description
50+-- $setup
51+-- >>> import qualified Data.Yaml
52+-- >>> import qualified Data.ByteString.Char8
53+
54+#ifdef SERVANT_DESCRIPTION
55+
56+import Servant.API
57+import Data.Text (Text)
58+import qualified Data.Text as T
5359
5460instance (AesonOptions xs) => AesonOptions (Description f ': xs) where
5561 aesonOptions = aesonOptions @xs
@@ -60,9 +66,7 @@ instance KnownSymbol t => OpenApiOptionModifier (Description t) where
6066toTextLine :: forall s. KnownSymbol s => Text
6167toTextLine = "\n\n" <> T.pack (symbolVal (Proxy @s))
6268
63−-- $setup
64−-- >>> import qualified Data.Yaml
65−-- >>> import qualified Data.ByteString.Char8
69+#endif
6670
6771type CustomOpenApi = CustomJSON
6872
@@ -79,7 +83,7 @@ instance
7983 ToParamSchema (CustomJSON (xs :: k) x)
8084 where
8185 toParamSchema Proxy =
82− genericToParamSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
86+ genericToParamSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
8387
8488class OpenApiOptionModifier x where
8589 openApiOptionsModifier :: SchemaOptions -> SchemaOptions
@@ -102,10 +106,8 @@ instance OpenApiOptionModifier UnwrapUnaryRecords where
102106
103107instance OpenApiOptionModifier OmitNothingFields
104108
105−#if MIN_VERSION_deriving_aeson(0,2,4)
106109instance OpenApiOptionModifier RejectUnknownFields where
107110 openApiSchemaModifier = schema . additionalProperties .~ Just (AdditionalPropertiesAllowed False)
108−#endif
109111
110112instance StringModifier f => OpenApiOptionModifier (FieldLabelModifier f) where
111113 openApiOptionsModifier o = o {fieldLabelModifier = getStringModifier @f}