@@ -1,17 +1,15 @@
2{-# LANGUAGE ConstraintKinds #-}
1{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DefaultSignatures #-}
2{-# LANGUAGE DefaultSignatures #-}
5{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE KindSignatures #-}
5{-# LANGUAGE KindSignatures #-}
6+{-# LANGUAGE DataKinds #-}
8{-# LANGUAGE OverloadedLists #-}
7{-# LANGUAGE OverloadedLists #-}
9{-# LANGUAGE OverloadedStrings #-}
8{-# LANGUAGE OverloadedStrings #-}
10{-# LANGUAGE PackageImports #-}
9{-# LANGUAGE PackageImports #-}
11{-# LANGUAGE PolyKinds #-}
10{-# LANGUAGE PolyKinds #-}
12{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE TupleSections #-}
12{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeApplications #-}
15{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeOperators #-}
14{-# LANGUAGE TypeOperators #-}
17{-# LANGUAGE TypeSynonymInstances #-}
15{-# LANGUAGE TypeSynonymInstances #-}
@@ -19,7 +17,7 @@
19{-# OPTIONS_GHC -Wno-redundant-constraints #-}
17{-# OPTIONS_GHC -Wno-redundant-constraints #-}
20-- For TypeErrors
18-- For TypeErrors
21{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
19{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
22−module Data.OpenApi.Internal.Schema where
20+module Data.Swagger.Internal.Schema where
24import Prelude ()
22import Prelude ()
25import Prelude.Compat
23import Prelude.Compat
@@ -42,7 +40,6 @@ import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
42import Data.Int
40import Data.Int
43import Data.IntSet (IntSet)
41import Data.IntSet (IntSet)
44import Data.IntMap (IntMap)
42import Data.IntMap (IntMap)
45−import Data.List (sort)
46import Data.List.NonEmpty.Compat (NonEmpty)
43import Data.List.NonEmpty.Compat (NonEmpty)
47import Data.Map (Map)
44import Data.Map (Map)
48import Data.Maybe (fromMaybe)
45import Data.Maybe (fromMaybe)
@@ -62,16 +59,14 @@ import Numeric.Natural.Compat (Natural)
62import Data.Word
59import Data.Word
63import GHC.Generics
60import GHC.Generics
64import qualified Data.UUID.Types as UUID
61import qualified Data.UUID.Types as UUID
65−import Type.Reflection (Typeable, typeRep)
67−import Data.OpenApi.Aeson.Compat (keyToText, objectKeys, toInsOrdHashMap)
68−import Data.OpenApi.Declare
63+import Data.Swagger.Declare
69−import Data.OpenApi.Internal
64+import Data.Swagger.Internal
70−import Data.OpenApi.Internal.ParamSchema (ToParamSchema (..))
65+import Data.Swagger.Internal.ParamSchema (ToParamSchema(..))
71−import Data.OpenApi.Internal.TypeShape
72−import Data.OpenApi.Lens hiding (name, schema)
66+import Data.Swagger.Lens hiding (name, schema)
73−import qualified Data.OpenApi.Lens as Swagger
67+import qualified Data.Swagger.Lens as Swagger
74−import Data.OpenApi.SchemaOptions
68+import Data.Swagger.SchemaOptions
69+import Data.Swagger.Internal.TypeShape
76import qualified Data.ByteString as BS
71import qualified Data.ByteString as BS
77import qualified Data.ByteString.Lazy.Char8 as BSL
72import qualified Data.ByteString.Lazy.Char8 as BSL
@@ -102,7 +97,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
103-- import Control.Lens
98-- import Control.Lens
104-- import Data.Proxy
99-- import Data.Proxy
105−-- import Data.OpenApi
100+-- import Data.Swagger
107-- data Coord = Coord { x :: Double, y :: Double }
102-- data Coord = Coord { x :: Double, y :: Double }
@@ -110,7 +105,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
110-- declareNamedSchema _ = do
105-- declareNamedSchema _ = do
111-- doubleSchema <- declareSchemaRef (Proxy :: Proxy Double)
106-- doubleSchema <- declareSchemaRef (Proxy :: Proxy Double)
112-- return $ NamedSchema (Just \"Coord\") $ mempty
107-- return $ NamedSchema (Just \"Coord\") $ mempty
113−-- & type_ ?~ OpenApiObject
108+-- & type_ ?~ SwaggerObject
114-- & properties .~
109-- & properties .~
115-- [ (\"x\", doubleSchema)
110-- [ (\"x\", doubleSchema)
116-- , (\"y\", doubleSchema)
111-- , (\"y\", doubleSchema)
@@ -136,7 +131,7 @@ rename name (NamedSchema _ schema) = NamedSchema name schema
137-- instance ToSchema Coord
132-- instance ToSchema Coord
139−class Typeable a => ToSchema a where
134+class ToSchema a where
140 -- | Convert a type into an optionally named schema
135 -- | Convert a type into an optionally named schema
141 -- together with all used definitions.
136 -- together with all used definitions.
142 -- Note that the schema itself is included in definitions
137 -- Note that the schema itself is included in definitions
@@ -158,19 +153,13 @@ declareSchema = fmap _namedSchemaSchema . declareNamedSchema
159-- >>> toNamedSchema (Proxy :: Proxy String) ^. name
154-- >>> toNamedSchema (Proxy :: Proxy String) ^. name
160-- Nothing
155-- Nothing
161−-- >>> BSL.putStrLn $ encodePretty (toNamedSchema (Proxy :: Proxy String) ^. schema)
156+-- >>> BSL.putStrLn $ encode (toNamedSchema (Proxy :: Proxy String) ^. schema)
163−-- "type": "string"
157+-- {"type":"string"}
166-- >>> toNamedSchema (Proxy :: Proxy Day) ^. name
159-- >>> toNamedSchema (Proxy :: Proxy Day) ^. name
167-- Just "Day"
160-- Just "Day"
168−-- >>> BSL.putStrLn $ encodePretty (toNamedSchema (Proxy :: Proxy Day) ^. schema)
161+-- >>> BSL.putStrLn $ encode (toNamedSchema (Proxy :: Proxy Day) ^. schema)
170−-- "example": "2016-07-22",
162+-- {"example":"2016-07-22","format":"date","type":"string"}
174toNamedSchema :: ToSchema a => Proxy a -> NamedSchema
163toNamedSchema :: ToSchema a => Proxy a -> NamedSchema
175toNamedSchema = undeclare . declareNamedSchema
164toNamedSchema = undeclare . declareNamedSchema
@@ -186,35 +175,22 @@ schemaName = _namedSchemaName . toNamedSchema
187-- | Convert a type into a schema.
176-- | Convert a type into a schema.
189−-- >>> BSL.putStrLn $ encodePretty $ toSchema (Proxy :: Proxy Int8)
178+-- >>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy Int8)
193−-- "type": "integer"
179+-- {"maximum":127,"minimum":-128,"type":"integer"}
196−-- >>> BSL.putStrLn $ encodePretty $ toSchema (Proxy :: Proxy [Day])
181+-- >>> BSL.putStrLn $ encode $ toSchema (Proxy :: Proxy [Day])
199−-- "$ref": "#/components/schemas/Day"
182+-- {"items":{"$ref":"#/components/schemas/Day"},"type":"array"}
203toSchema :: ToSchema a => Proxy a -> Schema
183toSchema :: ToSchema a => Proxy a -> Schema
204toSchema = _namedSchemaSchema . toNamedSchema
184toSchema = _namedSchemaSchema . toNamedSchema
206-- | Convert a type into a referenced schema if possible.
186-- | Convert a type into a referenced schema if possible.
207-- Only named schemas can be referenced, nameless schemas are inlined.
187-- Only named schemas can be referenced, nameless schemas are inlined.
209−-- >>> BSL.putStrLn $ encodePretty $ toSchemaRef (Proxy :: Proxy Integer)
189+-- >>> BSL.putStrLn $ encode $ toSchemaRef (Proxy :: Proxy Integer)
211−-- "type": "integer"
190+-- {"type":"integer"}
214−-- >>> BSL.putStrLn $ encodePretty $ toSchemaRef (Proxy :: Proxy Day)
192+-- >>> BSL.putStrLn $ encode $ toSchemaRef (Proxy :: Proxy Day)
216−-- "$ref": "#/components/schemas/Day"
193+-- {"$ref":"#/components/schemas/Day"}
218toSchemaRef :: ToSchema a => Proxy a -> Referenced Schema
194toSchemaRef :: ToSchema a => Proxy a -> Referenced Schema
219toSchemaRef = undeclare . declareSchemaRef
195toSchemaRef = undeclare . declareSchemaRef
@@ -282,15 +258,8 @@ inlineAllSchemas = inlineSchemasWhen (const True)
283-- | Convert a type into a schema without references.
259-- | Convert a type into a schema without references.
285−-- >>> BSL.putStrLn $ encodePretty $ toInlinedSchema (Proxy :: Proxy [Day])
261+-- >>> BSL.putStrLn $ encode $ toInlinedSchema (Proxy :: Proxy [Day])
288−-- "example": "2016-07-22",
262+-- {"items":{"example":"2016-07-22","format":"date","type":"string"},"type":"array"}
295-- __WARNING:__ @'toInlinedSchema'@ will produce infinite schema
264-- __WARNING:__ @'toInlinedSchema'@ will produce infinite schema
296-- when inlining recursive schemas.
265-- when inlining recursive schemas.
@@ -320,67 +289,41 @@ inlineNonRecursiveSchemas defs = inlineSchemasWhen nonRecursive defs
320 traverse_ usedNames (InsOrdHashMap.lookup name defs)
289 traverse_ usedNames (InsOrdHashMap.lookup name defs)
321 Inline subschema -> usedNames subschema
290 Inline subschema -> usedNames subschema
292+-- | Default schema for binary data (any sequence of octets).
293+binarySchema :: Schema
294+binarySchema = mempty
295+ & type_ ?~ SwaggerString
296+ & format ?~ "binary"
298+-- | Default schema for binary data (base64 encoded).
301+ & type_ ?~ SwaggerString
304+-- | Default schema for password string.
305+-- @"password"@ format is used to hint UIs the input needs to be obscured.
306+passwordSchema :: Schema
307+passwordSchema = mempty
308+ & type_ ?~ SwaggerString
309+ & format ?~ "password"
323-- | Make an unrestrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
311-- | Make an unrestrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
324-- Produced schema can be used for further refinement.
312-- Produced schema can be used for further refinement.
326−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema "hello"
314+-- >>> BSL.putStrLn $ encode $ sketchSchema "hello"
328−-- "example": "hello",
315+-- {"example":"hello","type":"string"}
332−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema (1, 2, 3)
317+-- >>> BSL.putStrLn $ encode $ sketchSchema (1, 2, 3)
340−-- "type": "number"
318+-- {"example":[1,2,3],"items":{"type":"number"},"type":"array"}
345−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema ("Jack", 25)
320+-- >>> BSL.putStrLn $ encode $ sketchSchema ("Jack", 25)
346−-- {
321+-- {"example":["Jack",25],"items":[{"type":"string"},{"type":"number"}],"type":"array"}
362-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
323-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
363-- >>> instance ToJSON Person
324-- >>> instance ToJSON Person
364−-- >>> BSL.putStrLn $ encodePretty $ sketchSchema (Person "Jack" 25)
325+-- >>> BSL.putStrLn $ encode $ sketchSchema (Person "Jack" 25)
365−-- {
326+-- {"required":["age","name"],"properties":{"age":{"type":"number"},"name":{"type":"string"}},"example":{"age":25,"name":"Jack"},"type":"object"}
384sketchSchema :: ToJSON a => a -> Schema
327sketchSchema :: ToJSON a => a -> Schema
385sketchSchema = sketch . toJSON
328sketchSchema = sketch . toJSON
@@ -388,15 +331,15 @@ sketchSchema = sketch . toJSON
388 sketch js@(Bool _) = go js
331 sketch js@(Bool _) = go js
389 sketch js = go js & example ?~ js
332 sketch js = go js & example ?~ js
391− go Null = mempty & type_ ?~ OpenApiNull
334+ go Null = mempty & type_ ?~ SwaggerNull
392− go (Bool _) = mempty & type_ ?~ OpenApiBoolean
335+ go (Bool _) = mempty & type_ ?~ SwaggerBoolean
393− go (String _) = mempty & type_ ?~ OpenApiString
336+ go (String _) = mempty & type_ ?~ SwaggerString
394− go (Number _) = mempty & type_ ?~ OpenApiNumber
337+ go (Number _) = mempty & type_ ?~ SwaggerNumber
395 go (Array xs) = mempty
338 go (Array xs) = mempty
396− & type_ ?~ OpenApiArray
339+ & type_ ?~ SwaggerArray
397 & items ?~ case ischema of
340 & items ?~ case ischema of
398− Just s -> OpenApiItemsObject (Inline s)
341+ Just s -> SwaggerItemsObject (Inline s)
399− _ -> OpenApiItemsArray (map Inline ys)
342+ _ -> SwaggerItemsArray (map Inline ys)
401 ys = map go (V.toList xs)
344 ys = map go (V.toList xs)
402 allSame = and ((zipWith (==)) ys (tail ys))
345 allSame = and ((zipWith (==)) ys (tail ys))
@@ -405,178 +348,64 @@ sketchSchema = sketch . toJSON
405 (z:_) | allSame -> Just z
348 (z:_) | allSame -> Just z
406 _ -> Nothing
349 _ -> Nothing
407 go (Object o) = mempty
350 go (Object o) = mempty
408− & type_ ?~ OpenApiObject
351+ & type_ ?~ SwaggerObject
409− & required .~ sort (objectKeys o)
352+ & required .~ HashMap.keys o
410− & properties .~ fmap (Inline . go) (toInsOrdHashMap o)
353+ & properties .~ fmap (Inline . go) (InsOrdHashMap.fromHashMap o)
412-- | Make a restrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
355-- | Make a restrictive sketch of a @'Schema'@ based on a @'ToJSON'@ instance.
413-- Produced schema uses as much constraints as possible.
356-- Produced schema uses as much constraints as possible.
415−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema "hello"
358+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema "hello"
416−-- {
359+-- {"maxLength":5,"pattern":"hello","minLength":5,"type":"string","enum":["hello"]}
422−-- "pattern": "hello",
426−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema (1, 2, 3)
361+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema (1, 2, 3)
427−-- {
362+-- {"minItems":3,"uniqueItems":true,"items":[{"maximum":1,"minimum":1,"multipleOf":1,"type":"number","enum":[1]},{"maximum":2,"minimum":2,"multipleOf":2,"type":"number","enum":[2]},{"maximum":3,"minimum":3,"multipleOf":3,"type":"number","enum":[3]}],"maxItems":3,"type":"array","enum":[[1,2,3]]}
467−-- "uniqueItems": true
470−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema ("Jack", 25)
364+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema ("Jack", 25)
471−-- {
365+-- {"minItems":2,"uniqueItems":true,"items":[{"maxLength":4,"pattern":"Jack","minLength":4,"type":"string","enum":["Jack"]},{"maximum":25,"minimum":25,"multipleOf":25,"type":"number","enum":[25]}],"maxItems":2,"type":"array","enum":[["Jack",25]]}
485−-- "pattern": "Jack",
501−-- "uniqueItems": true
504-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
367-- >>> data Person = Person { name :: String, age :: Int } deriving (Generic)
505-- >>> instance ToJSON Person
368-- >>> instance ToJSON Person
506−-- >>> BSL.putStrLn $ encodePretty $ sketchStrictSchema (Person "Jack" 25)
369+-- >>> BSL.putStrLn $ encode $ sketchStrictSchema (Person "Jack" 25)
507−-- {
370+-- {"required":["age","name"],"properties":{"age":{"maximum":25,"minimum":25,"multipleOf":25,"type":"number","enum":[25]},"name":{"maxLength":4,"pattern":"Jack","minLength":4,"type":"string","enum":["Jack"]}},"maxProperties":2,"minProperties":2,"type":"object","enum":[{"age":25,"name":"Jack"}]}
514−-- "maxProperties": 2,
515−-- "minProperties": 2,
532−-- "pattern": "Jack",
542sketchStrictSchema :: ToJSON a => a -> Schema
371sketchStrictSchema :: ToJSON a => a -> Schema
543sketchStrictSchema = go . toJSON
372sketchStrictSchema = go . toJSON
545− go Null = mempty & type_ ?~ OpenApiNull
374+ go Null = mempty & type_ ?~ SwaggerNull
546 go js@(Bool _) = mempty
375 go js@(Bool _) = mempty
547− & type_ ?~ OpenApiBoolean
376+ & type_ ?~ SwaggerBoolean
548 & enum_ ?~ [js]
377 & enum_ ?~ [js]
549 go js@(String s) = mempty
378 go js@(String s) = mempty
550− & type_ ?~ OpenApiString
379+ & type_ ?~ SwaggerString
551 & maxLength ?~ fromIntegral (T.length s)
380 & maxLength ?~ fromIntegral (T.length s)
552 & minLength ?~ fromIntegral (T.length s)
381 & minLength ?~ fromIntegral (T.length s)
553 & pattern ?~ s
382 & pattern ?~ s
554 & enum_ ?~ [js]
383 & enum_ ?~ [js]
555 go js@(Number n) = mempty
384 go js@(Number n) = mempty
556− & type_ ?~ OpenApiNumber
385+ & type_ ?~ SwaggerNumber
557 & maximum_ ?~ n
386 & maximum_ ?~ n
558 & minimum_ ?~ n
387 & minimum_ ?~ n
559 & multipleOf ?~ n
388 & multipleOf ?~ n
560 & enum_ ?~ [js]
389 & enum_ ?~ [js]
561 go js@(Array xs) = mempty
390 go js@(Array xs) = mempty
562− & type_ ?~ OpenApiArray
391+ & type_ ?~ SwaggerArray
563 & maxItems ?~ fromIntegral sz
392 & maxItems ?~ fromIntegral sz
564 & minItems ?~ fromIntegral sz
393 & minItems ?~ fromIntegral sz
565− & items ?~ OpenApiItemsArray (map (Inline . go) (V.toList xs))
394+ & items ?~ SwaggerItemsArray (map (Inline . go) (V.toList xs))
566 & uniqueItems ?~ allUnique
395 & uniqueItems ?~ allUnique
567 & enum_ ?~ [js]
396 & enum_ ?~ [js]
569 sz = length xs
398 sz = length xs
570 allUnique = sz == HashSet.size (HashSet.fromList (V.toList xs))
399 allUnique = sz == HashSet.size (HashSet.fromList (V.toList xs))
571 go js@(Object o) = mempty
400 go js@(Object o) = mempty
572− & type_ ?~ OpenApiObject
401+ & type_ ?~ SwaggerObject
573− & required .~ sort names
402+ & required .~ names
574− & properties .~ fmap (Inline . go) (toInsOrdHashMap o)
403+ & properties .~ fmap (Inline . go) (InsOrdHashMap.fromHashMap o)
575 & maxProperties ?~ fromIntegral (length names)
404 & maxProperties ?~ fromIntegral (length names)
576 & minProperties ?~ fromIntegral (length names)
405 & minProperties ?~ fromIntegral (length names)
577 & enum_ ?~ [js]
406 & enum_ ?~ [js]
579− names = objectKeys o
408+ names = HashMap.keys o
581class GToSchema (f :: * -> *) where
410class GToSchema (f :: * -> *) where
582 gdeclareNamedSchema :: SchemaOptions -> Proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
411 gdeclareNamedSchema :: SchemaOptions -> Proxy f -> Schema -> Declare (Definitions Schema) NamedSchema
@@ -585,8 +414,8 @@ instance {-# OVERLAPPABLE #-} ToSchema a => ToSchema [a] where
585 declareNamedSchema _ = do
414 declareNamedSchema _ = do
586 ref <- declareSchemaRef (Proxy :: Proxy a)
415 ref <- declareSchemaRef (Proxy :: Proxy a)
587 return $ unnamed $ mempty
416 return $ unnamed $ mempty
588− & type_ ?~ OpenApiArray
417+ & type_ ?~ SwaggerArray
589− & items ?~ OpenApiItemsObject ref
418+ & items ?~ SwaggerItemsObject ref
591instance {-# OVERLAPPING #-} ToSchema String where declareNamedSchema = plain . paramSchemaToSchema
420instance {-# OVERLAPPING #-} ToSchema String where declareNamedSchema = plain . paramSchemaToSchema
592instance ToSchema Bool where declareNamedSchema = plain . paramSchemaToSchema
421instance ToSchema Bool where declareNamedSchema = plain . paramSchemaToSchema
@@ -611,7 +440,7 @@ instance ToSchema Scientific where declareNamedSchema = plain . paramSchemaToSc
611instance ToSchema Double where declareNamedSchema = plain . paramSchemaToSchema
440instance ToSchema Double where declareNamedSchema = plain . paramSchemaToSchema
612instance ToSchema Float where declareNamedSchema = plain . paramSchemaToSchema
441instance ToSchema Float where declareNamedSchema = plain . paramSchemaToSchema
614−instance (Typeable (Fixed a), HasResolution a) => ToSchema (Fixed a) where declareNamedSchema = plain . paramSchemaToSchema
443+instance HasResolution a => ToSchema (Fixed a) where declareNamedSchema = plain . paramSchemaToSchema
616instance ToSchema a => ToSchema (Maybe a) where
445instance ToSchema a => ToSchema (Maybe a) where
617 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
446 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy a)
@@ -628,22 +457,16 @@ instance ToSchema UUID.UUID where
628 declareNamedSchema p = pure $ named "UUID" $ paramSchemaToSchema p
457 declareNamedSchema p = pure $ named "UUID" $ paramSchemaToSchema p
629 & example ?~ toJSON (UUID.toText UUID.nil)
458 & example ?~ toJSON (UUID.toText UUID.nil)
631−instance (ToSchema a, ToSchema b) => ToSchema (a, b) where
460+instance (ToSchema a, ToSchema b) => ToSchema (a, b)
632− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
633−instance (ToSchema a, ToSchema b, ToSchema c) => ToSchema (a, b, c) where
461+instance (ToSchema a, ToSchema b, ToSchema c) => ToSchema (a, b, c)
634− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
635−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d) => ToSchema (a, b, c, d) where
462+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d) => ToSchema (a, b, c, d)
636− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
637−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e) => ToSchema (a, b, c, d, e) where
463+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e) => ToSchema (a, b, c, d, e)
638− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
639−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f) => ToSchema (a, b, c, d, e, f) where
464+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f) => ToSchema (a, b, c, d, e, f)
640− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
641−instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f, ToSchema g) => ToSchema (a, b, c, d, e, f, g) where
465+instance (ToSchema a, ToSchema b, ToSchema c, ToSchema d, ToSchema e, ToSchema f, ToSchema g) => ToSchema (a, b, c, d, e, f, g)
642− declareNamedSchema = fmap unname . genericDeclareNamedSchema defaultSchemaOptions
644timeSchema :: T.Text -> Schema
467timeSchema :: T.Text -> Schema
645timeSchema fmt = mempty
468timeSchema fmt = mempty
646− & type_ ?~ OpenApiString
469+ & type_ ?~ SwaggerString
647 & format ?~ fmt
470 & format ?~ fmt
649-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
472-- | Format @"date"@ corresponds to @yyyy-mm-dd@ format.
@@ -658,7 +481,7 @@ instance ToSchema LocalTime where
658 declareNamedSchema _ = pure $ named "LocalTime" $ timeSchema "yyyy-mm-ddThh:MM:ss"
481 declareNamedSchema _ = pure $ named "LocalTime" $ timeSchema "yyyy-mm-ddThh:MM:ss"
659 & example ?~ toJSON (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0))
482 & example ?~ toJSON (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0))
661−-- | Format @"date-time"@ corresponds to @yyyy-mm-ddThh:MM:ss(Z|+hh:MM)@ format.
484+-- | Format @"date"@ corresponds to @yyyy-mm-ddThh:MM:ss(Z|+hh:MM)@ format.
662instance ToSchema ZonedTime where
485instance ToSchema ZonedTime where
663 declareNamedSchema _ = pure $ named "ZonedTime" $ timeSchema "date-time"
486 declareNamedSchema _ = pure $ named "ZonedTime" $ timeSchema "date-time"
664 & example ?~ toJSON (ZonedTime (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0)) (hoursToTimeZone 3))
487 & example ?~ toJSON (ZonedTime (LocalTime (fromGregorian 2016 7 22) (TimeOfDay 7 40 0)) (hoursToTimeZone 3))
@@ -690,7 +513,7 @@ instance ToSchemaByteStringError BSL.ByteString => ToSchema BSL.ByteString where
690instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))
513instance ToSchema IntSet where declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy (Set Int))
692-- | NOTE: This schema does not account for the uniqueness of keys.
515-- | NOTE: This schema does not account for the uniqueness of keys.
693−instance (ToSchema a) => ToSchema (IntMap a) where
516+instance ToSchema a => ToSchema (IntMap a) where
694 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [(Int, a)])
517 declareNamedSchema _ = declareNamedSchema (Proxy :: Proxy [(Int, a)])
696instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
519instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
@@ -701,7 +524,7 @@ instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (Map k v) where
701 declareObjectMapSchema = do
524 declareObjectMapSchema = do
702 schema <- declareSchemaRef (Proxy :: Proxy v)
525 schema <- declareSchemaRef (Proxy :: Proxy v)
703 return $ unnamed $ mempty
526 return $ unnamed $ mempty
704− & type_ ?~ OpenApiObject
527+ & type_ ?~ SwaggerObject
705 & additionalProperties ?~ AdditionalPropertiesSchema schema
528 & additionalProperties ?~ AdditionalPropertiesSchema schema
707instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
530instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
@@ -709,7 +532,7 @@ instance (ToJSONKey k, ToSchema k, ToSchema v) => ToSchema (HashMap k v) where
710instance {-# OVERLAPPING #-} ToSchema Object where
533instance {-# OVERLAPPING #-} ToSchema Object where
711 declareNamedSchema _ = pure $ NamedSchema (Just "Object") $ mempty
534 declareNamedSchema _ = pure $ NamedSchema (Just "Object") $ mempty
712− & type_ ?~ OpenApiObject
535+ & type_ ?~ SwaggerObject
713 & description ?~ "Arbitrary JSON object."
536 & description ?~ "Arbitrary JSON object."
714 & additionalProperties ?~ AdditionalPropertiesAllowed True
537 & additionalProperties ?~ AdditionalPropertiesAllowed True
@@ -746,15 +569,11 @@ instance ToSchema a => ToSchema (Identity a) where declareNamedSchema _ = declar
747-- | Default schema for @'Bounded'@, @'Integral'@ types.
570-- | Default schema for @'Bounded'@, @'Integral'@ types.
749−-- >>> BSL.putStrLn $ encodePretty $ toSchemaBoundedIntegral (Proxy :: Proxy Int16)
572+-- >>> BSL.putStrLn $ encode $ toSchemaBoundedIntegral (Proxy :: Proxy Int16)
751−-- "maximum": 32767,
573+-- {"maximum":32767,"minimum":-32768,"type":"integer"}
752−-- "minimum": -32768,
755toSchemaBoundedIntegral :: forall a. (Bounded a, Integral a) => Proxy a -> Schema
574toSchemaBoundedIntegral :: forall a. (Bounded a, Integral a) => Proxy a -> Schema
756toSchemaBoundedIntegral _ = mempty
575toSchemaBoundedIntegral _ = mempty
757− & type_ ?~ OpenApiInteger
576+ & type_ ?~ SwaggerInteger
758 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
577 & minimum_ ?~ fromInteger (toInteger (minBound :: a))
759 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
578 & maximum_ ?~ fromInteger (toInteger (maxBound :: a))
@@ -783,27 +602,8 @@ genericDeclareNamedSchemaNewtype opts f proxy = genericNameSchema opts proxy <$>
783-- >>> instance ToSchema ButtonState
602-- >>> instance ToSchema ButtonState
784-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
603-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
785-- >>> type ImageUrl = T.Text
604-- >>> type ImageUrl = T.Text
786−-- >>> BSL.putStrLn $ encodePretty $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
605+-- >>> BSL.putStrLn $ encode $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
787−-- {
606+-- {"properties":{"Neutral":{"type":"string"},"Focus":{"type":"string"},"Active":{"type":"string"},"Hover":{"type":"string"},"Disabled":{"type":"string"}},"type":"object"}
808-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
608-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
809-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
609-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
@@ -811,15 +611,15 @@ declareSchemaBoundedEnumKeyMapping :: forall map key value.
811 (Bounded key, Enum key, ToJSONKey key, ToSchema key, ToSchema value)
611 (Bounded key, Enum key, ToJSONKey key, ToSchema key, ToSchema value)
812 => Proxy (map key value) -> Declare (Definitions Schema) Schema
612 => Proxy (map key value) -> Declare (Definitions Schema) Schema
813declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key of
613declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key of
814− ToJSONKeyText getKey _ -> objectSchema getKey
614+ ToJSONKeyText keyToText _ -> objectSchema keyToText
815 ToJSONKeyValue _ _ -> declareSchema (Proxy :: Proxy [(key, value)])
615 ToJSONKeyValue _ _ -> declareSchema (Proxy :: Proxy [(key, value)])
817− objectSchema getKey = do
617+ objectSchema keyToText = do
818 valueRef <- declareSchemaRef (Proxy :: Proxy value)
618 valueRef <- declareSchemaRef (Proxy :: Proxy value)
819 let allKeys = [minBound..maxBound :: key]
619 let allKeys = [minBound..maxBound :: key]
820− mkPair k = (keyToText $ getKey k, valueRef)
620+ mkPair k = (keyToText k, valueRef)
821 return $ mempty
621 return $ mempty
822− & type_ ?~ OpenApiObject
622+ & type_ ?~ SwaggerObject
823 & properties .~ InsOrdHashMap.fromList (map mkPair allKeys)
623 & properties .~ InsOrdHashMap.fromList (map mkPair allKeys)
825-- | A 'Schema' for a mapping with 'Bounded' 'Enum' keys.
625-- | A 'Schema' for a mapping with 'Bounded' 'Enum' keys.
@@ -830,27 +630,8 @@ declareSchemaBoundedEnumKeyMapping _ = case toJSONKey :: ToJSONKeyFunction key o
830-- >>> instance ToSchema ButtonState
630-- >>> instance ToSchema ButtonState
831-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
631-- >>> instance ToJSONKey ButtonState where toJSONKey = toJSONKeyText (T.pack . show)
832-- >>> type ImageUrl = T.Text
632-- >>> type ImageUrl = T.Text
833−-- >>> BSL.putStrLn $ encodePretty $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
633+-- >>> BSL.putStrLn $ encode $ toSchemaBoundedEnumKeyMapping (Proxy :: Proxy (Map ButtonState ImageUrl))
834−-- {
634+-- {"properties":{"Neutral":{"type":"string"},"Focus":{"type":"string"},"Active":{"type":"string"},"Hover":{"type":"string"},"Disabled":{"type":"string"}},"type":"object"}
855-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
636-- Note: this is only useful when @key@ is encoded with 'ToJSONKeyText'.
856-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
637-- If it is encoded with 'ToJSONKeyValue' then a regular schema for @[(key, value)]@ is used.
@@ -860,7 +641,7 @@ toSchemaBoundedEnumKeyMapping :: forall map key value.
860toSchemaBoundedEnumKeyMapping = flip evalDeclare mempty . declareSchemaBoundedEnumKeyMapping
641toSchemaBoundedEnumKeyMapping = flip evalDeclare mempty . declareSchemaBoundedEnumKeyMapping
862-- | A configurable generic @'Schema'@ creator.
643-- | A configurable generic @'Schema'@ creator.
863−genericDeclareSchema :: (Generic a, GToSchema (Rep a), Typeable a) =>
644+genericDeclareSchema :: (Generic a, GToSchema (Rep a)) =>
864 SchemaOptions -> Proxy a -> Declare (Definitions Schema) Schema
645 SchemaOptions -> Proxy a -> Declare (Definitions Schema) Schema
865genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSchema opts proxy
646genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSchema opts proxy
@@ -868,24 +649,9 @@ genericDeclareSchema opts proxy = _namedSchemaSchema <$> genericDeclareNamedSche
868-- This function applied to @'defaultSchemaOptions'@
649-- This function applied to @'defaultSchemaOptions'@
869-- is used as the default for @'declareNamedSchema'@
650-- is used as the default for @'declareNamedSchema'@
870-- when the type is an instance of @'Generic'@.
651-- when the type is an instance of @'Generic'@.
872−-- Default implementation will use the name from 'Typeable' instance, including concrete
873−-- instantioations of type variables.
877−-- >>> _namedSchemaName $ undeclare $ genericDeclareNamedSchema defaultSchemaOptions (Proxy :: Proxy (Either Int Bool))
878−-- Just "Either_Int_Bool"
879−genericDeclareNamedSchema :: forall a. (Generic a, GToSchema (Rep a), Typeable a) =>
652+genericDeclareNamedSchema :: forall a. (Generic a, GToSchema (Rep a)) =>
880 SchemaOptions -> Proxy a -> Declare (Definitions Schema) NamedSchema
653 SchemaOptions -> Proxy a -> Declare (Definitions Schema) NamedSchema
881−genericDeclareNamedSchema opts _ =
882− rename (Just $ T.pack name) <$> gdeclareNamedSchema opts (Proxy :: Proxy (Rep a)) mempty
654+genericDeclareNamedSchema opts _ = gdeclareNamedSchema opts (Proxy :: Proxy (Rep a)) mempty
886− orig = fmap unspace $ show $ typeRep @a
887− name = datatypeNameModifier opts orig
890-- | Derive a 'Generic'-based name for a datatype and assign it to a given 'Schema'.
656-- | Derive a 'Generic'-based name for a datatype and assign it to a given 'Schema'.
891genericNameSchema :: forall a d f.
657genericNameSchema :: forall a d f.
@@ -901,19 +667,19 @@ gdatatypeSchemaName opts _ = case orig of
901 orig = datatypeName (Proxy3 :: Proxy3 d f a)
667 orig = datatypeName (Proxy3 :: Proxy3 d f a)
902 name = datatypeNameModifier opts orig
668 name = datatypeNameModifier opts orig
904−-- | Construct 'NamedSchema' usinng 'ToParamSchema'.
670+-- | Lift a plain @'ParamSchema'@ into a model @'NamedSchema'@.
905paramSchemaToNamedSchema :: (ToParamSchema a, Generic a, Rep a ~ D1 d f, Datatype d) =>
671paramSchemaToNamedSchema :: (ToParamSchema a, Generic a, Rep a ~ D1 d f, Datatype d) =>
906 SchemaOptions -> Proxy a -> NamedSchema
672 SchemaOptions -> Proxy a -> NamedSchema
907paramSchemaToNamedSchema opts proxy = genericNameSchema opts proxy (paramSchemaToSchema proxy)
673paramSchemaToNamedSchema opts proxy = genericNameSchema opts proxy (paramSchemaToSchema proxy)
909−-- | Construct 'Schema' usinng 'ToParamSchema'.
675+-- | Lift a plain @'ParamSchema'@ into a model @'Schema'@.
910paramSchemaToSchema :: ToParamSchema a => Proxy a -> Schema
676paramSchemaToSchema :: ToParamSchema a => Proxy a -> Schema
911−paramSchemaToSchema = toParamSchema
677+paramSchemaToSchema proxy = mempty & paramSchema .~ toParamSchema proxy
913nullarySchema :: Schema
679nullarySchema :: Schema
914nullarySchema = mempty
680nullarySchema = mempty
915− & type_ ?~ OpenApiArray
681+ & type_ ?~ SwaggerArray
916− & items ?~ OpenApiItemsArray []
682+ & items ?~ SwaggerItemsArray []
918gtoNamedSchema :: GToSchema f => SchemaOptions -> Proxy f -> NamedSchema
684gtoNamedSchema :: GToSchema f => SchemaOptions -> Proxy f -> NamedSchema
919gtoNamedSchema opts proxy = undeclare $ gdeclareNamedSchema opts proxy mempty
685gtoNamedSchema opts proxy = undeclare $ gdeclareNamedSchema opts proxy mempty
@@ -943,15 +709,12 @@ instance (Selector s, GToSchema f, GToSchema (S1 s f)) => GToSchema (C1 c (S1 s
943 | unwrapUnaryRecords opts = fieldSchema
709 | unwrapUnaryRecords opts = fieldSchema
944 | otherwise =
710 | otherwise =
945 case schema ^. items of
711 case schema ^. items of
946− Just (OpenApiItemsArray [_]) -> fieldSchema
712+ Just (SwaggerItemsArray [_]) -> fieldSchema
948− -- We have to run recordSchema instead of just using its defs,
714+ declare defs
949− -- since those can be recursive and will lead to infinite loop,
950− -- see https://github.com/biocad/openapi3/pull/37
951− NamedSchema _ schema' <- recordSchema
952− return (unnamed schema')
715+ return (unnamed schema)
954− (_, NamedSchema _ schema) = runDeclare recordSchema mempty
717+ (defs, NamedSchema _ schema) = runDeclare recordSchema mempty
955 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s
718 recordSchema = gdeclareNamedSchema opts (Proxy :: Proxy (S1 s f)) s
956 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s
719 fieldSchema = gdeclareNamedSchema opts (Proxy :: Proxy f) s
@@ -974,10 +737,10 @@ gdeclareSchemaRef opts proxy = do
974 return $ Ref (Reference name)
737 return $ Ref (Reference name)
975 _ -> Inline <$> gdeclareSchema opts proxy
738 _ -> Inline <$> gdeclareSchema opts proxy
977−appendItem :: Referenced Schema -> Maybe OpenApiItems -> Maybe OpenApiItems
740+appendItem :: Referenced Schema -> Maybe SwaggerItems -> Maybe SwaggerItems
978−appendItem x Nothing = Just (OpenApiItemsArray [x])
741+appendItem x Nothing = Just (SwaggerItemsArray [x])
979−appendItem x (Just (OpenApiItemsArray xs)) = Just (OpenApiItemsArray (xs ++ [x]))
742+appendItem x (Just (SwaggerItemsArray xs)) = Just (SwaggerItemsArray (xs ++ [x]))
980−appendItem _ _ = error "GToSchema.appendItem: cannot append to OpenApiItemsObject"
743+appendItem _ _ = error "GToSchema.appendItem: cannot append to SwaggerItemsObject"
982withFieldSchema :: forall proxy s f. (Selector s, GToSchema f) =>
745withFieldSchema :: forall proxy s f. (Selector s, GToSchema f) =>
983 SchemaOptions -> proxy s f -> Bool -> Schema -> Declare (Definitions Schema) Schema
746 SchemaOptions -> proxy s f -> Bool -> Schema -> Declare (Definitions Schema) Schema
@@ -986,12 +749,12 @@ withFieldSchema opts _ isRequiredField schema = do
987 if T.null fname
750 if T.null fname
988 then schema
751 then schema
989− & type_ ?~ OpenApiArray
752+ & type_ ?~ SwaggerArray
990 & items %~ appendItem ref
753 & items %~ appendItem ref
991 & maxItems %~ Just . maybe 1 (+1) -- increment maxItems
754 & maxItems %~ Just . maybe 1 (+1) -- increment maxItems
992 & minItems %~ Just . maybe 1 (+1) -- increment minItems
755 & minItems %~ Just . maybe 1 (+1) -- increment minItems
993 else schema
756 else schema
994− & type_ ?~ OpenApiObject
757+ & type_ ?~ SwaggerObject
995 & properties . at fname ?~ ref
758 & properties . at fname ?~ ref
996 & if isRequiredField
759 & if isRequiredField
997 then required %~ (++ [fname])
760 then required %~ (++ [fname])
@@ -1026,14 +789,14 @@ gdeclareNamedSumSchema opts proxy _
1026 | otherwise = do
789 | otherwise = do
1027 (schemas, _) <- runWriterT declareSumSchema
790 (schemas, _) <- runWriterT declareSumSchema
1028 return $ unnamed $ mempty
791 return $ unnamed $ mempty
1029− & type_ ?~ OpenApiObject
792+ & type_ ?~ SwaggerObject
1030 & oneOf ?~ (snd <$> schemas)
793 & oneOf ?~ (snd <$> schemas)
1032 declareSumSchema = gsumToSchema opts proxy
795 declareSumSchema = gsumToSchema opts proxy
1033 (sumSchemas, All allNullary) = undeclare (runWriterT declareSumSchema)
796 (sumSchemas, All allNullary) = undeclare (runWriterT declareSumSchema)
1035 toStringTag schemas = mempty
798 toStringTag schemas = mempty
1036− & type_ ?~ OpenApiString
799+ & type_ ?~ SwaggerString
1037 & enum_ ?~ map (String . fst) sumSchemas
800 & enum_ ?~ map (String . fst) sumSchemas
1039type AllNullary = All
802type AllNullary = All
@@ -1055,15 +818,15 @@ gsumConToSchemaWith ref opts _ = (tag, schema)
1055 case ref of
818 case ref of
1056 -- If subschema is an object and constructor is a record, we add tag directly
819 -- If subschema is an object and constructor is a record, we add tag directly
1057 -- to the record, as Aeson does it.
820 -- to the record, as Aeson does it.
1058− Just (Inline sub) | sub ^. type_ == Just OpenApiObject && isRecord -> Inline $ sub
821+ Just (Inline sub) | sub ^. type_ == Just SwaggerObject && isRecord -> Inline $ sub
1059 & required <>~ [T.pack tagField]
822 & required <>~ [T.pack tagField]
1060− & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag])
823+ & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag])
1062 -- If it is not a record, we need to put subschema into "contents" field.
825 -- If it is not a record, we need to put subschema into "contents" field.
1063 _ | not isRecord -> Inline $ mempty
826 _ | not isRecord -> Inline $ mempty
1064− & type_ ?~ OpenApiObject
827+ & type_ ?~ SwaggerObject
1065 & required .~ [T.pack tagField]
828 & required .~ [T.pack tagField]
1066− & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag])
829+ & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag])
1067 -- If constructor is nullary, there is no content.
830 -- If constructor is nullary, there is no content.
1068 & case ref of
831 & case ref of
1069 Just r -> (properties . at (T.pack contentsField) ?~ r) . (required <>~ [T.pack contentsField])
832 Just r -> (properties . at (T.pack contentsField) ?~ r) . (required <>~ [T.pack contentsField])
@@ -1071,17 +834,17 @@ gsumConToSchemaWith ref opts _ = (tag, schema)
1072 -- In the remaining cases we combine "tag" object and "contents" object using allOf.
835 -- In the remaining cases we combine "tag" object and "contents" object using allOf.
1073 _ -> Inline $ mempty
836 _ -> Inline $ mempty
1074− & type_ ?~ OpenApiObject
837+ & type_ ?~ SwaggerObject
1075 & allOf ?~ [Inline $ mempty
838 & allOf ?~ [Inline $ mempty
1076− & type_ ?~ OpenApiObject
839+ & type_ ?~ SwaggerObject
1077 & required .~ (T.pack tagField : if isRecord then [] else [T.pack contentsField])
840 & required .~ (T.pack tagField : if isRecord then [] else [T.pack contentsField])
1078− & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag])]
841+ & properties . at (T.pack tagField) ?~ (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag])]
1079 & if isRecord
842 & if isRecord
1080 then allOf . _Just <>~ [refOrNullary]
843 then allOf . _Just <>~ [refOrNullary]
1081− else allOf . _Just <>~ [Inline $ mempty & type_ ?~ OpenApiObject & properties . at (T.pack contentsField) ?~ refOrNullary]
844+ else allOf . _Just <>~ [Inline $ mempty & type_ ?~ SwaggerObject & properties . at (T.pack contentsField) ?~ refOrNullary]
1082 UntaggedValue -> refOrEnum -- Aeson encodes nullary constructors as strings in this case.
845 UntaggedValue -> refOrEnum -- Aeson encodes nullary constructors as strings in this case.
1083 ObjectWithSingleField -> Inline $ mempty
846 ObjectWithSingleField -> Inline $ mempty
1084− & type_ ?~ OpenApiObject
847+ & type_ ?~ SwaggerObject
1085 & required .~ [tag]
848 & required .~ [tag]
1086 & properties . at tag ?~ refOrNullary
849 & properties . at tag ?~ refOrNullary
1087 TwoElemArray -> error "unrepresentable in OpenAPI 3"
850 TwoElemArray -> error "unrepresentable in OpenAPI 3"
@@ -1089,7 +852,7 @@ gsumConToSchemaWith ref opts _ = (tag, schema)
1089 tag = T.pack (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
852 tag = T.pack (constructorTagModifier opts (conName (Proxy3 :: Proxy3 c f p)))
1090 isRecord = conIsRecord (Proxy3 :: Proxy3 c f p)
853 isRecord = conIsRecord (Proxy3 :: Proxy3 c f p)
1091 refOrNullary = fromMaybe (Inline nullarySchema) ref
854 refOrNullary = fromMaybe (Inline nullarySchema) ref
1092− refOrEnum = fromMaybe (Inline $ mempty & type_ ?~ OpenApiString & enum_ ?~ [String tag]) ref
855+ refOrEnum = fromMaybe (Inline $ mempty & type_ ?~ SwaggerString & enum_ ?~ [String tag]) ref
1094gsumConToSchema :: (GToSchema (C1 c f), Constructor c) =>
857gsumConToSchema :: (GToSchema (C1 c f), Constructor c) =>
1095 SchemaOptions -> Proxy (C1 c f) -> Declare (Definitions Schema) [(T.Text, Referenced Schema)]
858 SchemaOptions -> Proxy (C1 c f) -> Declare (Definitions Schema) [(T.Text, Referenced Schema)]
@@ -1114,13 +877,7 @@ data Proxy2 a b = Proxy2
1115data Proxy3 a b c = Proxy3
878data Proxy3 a b c = Proxy3
1117−{- $setup
880+-- $setup
1118−>>> import Data.OpenApi
881+-- >>> import Data.Swagger
1119−>>> import Data.Aeson (encode)
882+-- >>> import Data.Aeson (encode)
1120−>>> import Data.Aeson.Types (toJSONKeyText)
883+-- >>> import Data.Aeson.Types (toJSONKeyText)
1121−>>> import Data.OpenApi.Internal.Utils
1122−>>> :set -XScopedTypeVariables
1123−>>> :set -XDeriveAnyClass
1124−>>> :set -XStandaloneDeriving
1125−>>> :set -XTypeApplications