-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | json-spec-openapi
--   
--   This package provides a way to produce <a>openapi3</a> documentation
--   from a <a>json-spec</a> specification.
--   
--   <h1>Example</h1>
--   
--   Given this data type:
--   
--   <pre>
--   data User = User
--     {      name :: Text
--     , lastLogin :: UTCTime
--     }
--     deriving ToSchema via (EncodingSchema User) -- &lt;-- ToSchema instance defined here
--   instance HasJsonEncodingSpec User where
--     type EncodingSpec User =
--       JsonObject
--         '[ '("name", JsonString)
--          , '("last-login", JsonDateTime)
--          ]
--     toJSONStructure user =
--       (Field @"name" (name user),
--       (Field @"last-login" (lastLogin user),
--       ()))
--   </pre>
--   
--   Calling `Data.Aeson.encode (Data.OpenApi3.toSchema (Proxy :: Proxy
--   User))` will produce the following Schema:
--   
--   <pre>
--   {
--     "additionalProperties": false,
--     "properties": {
--       "last-login": {
--         "format": "date-time",
--         "type": "string"
--       },
--       "name": {
--         "type": "string"
--       }
--     },
--     "required": [
--       "name",
--       "last-login"
--     ],
--     "type": "object"
--   }
--   </pre>
@package json-spec-openapi
@version 0.1.0.2


-- | This module provides tools for integrating the type-level JSON
--   <a>Specification</a> with the "openapi" package.
--   
--   You can use <a>toOpenApiSchema</a> as a low-level tool to transform
--   <tt>json-spec</tt> <a>Specification</a>s into <tt>openapi3</tt>
--   <a>Schema</a>s directly, irrespective of any particular business data
--   type.
--   
--   More likely you will want to use <tt>-XDerivingVia</tt> along with
--   <a>EncodingSchema</a> or <a>DecodingSchema</a> to derive
--   <a>ToSchema</a> instances for your data types.
--   
--   Example, given this data type:
--   
--   <pre>
--   data User = User
--     {      name :: Text
--     , lastLogin :: UTCTime
--     }
--     deriving ToSchema via (EncodingSchema User) -- &lt;-- ToSchema instance defined here
--   instance HasJsonEncodingSpec User where
--     type EncodingSpec User =
--       JsonObject
--         '[ '("name", JsonString)
--          , '("last-login", JsonDateTime)
--          ]
--     toJSONStructure user =
--       (Field @"name" (name user),
--       (Field @"last-login" (lastLogin user),
--       ()))
--   </pre>
--   
--   Calling <tt><a>encode</a> (<a>toSchema</a> (<a>Proxy</a> ::
--   <a>Proxy</a> User))</tt> will produce the following Schema:
--   
--   <pre>
--   {
--     "additionalProperties": false,
--     "properties": {
--       "last-login": {
--         "format": "date-time",
--         "type": "string"
--       },
--       "name": {
--         "type": "string"
--       }
--     },
--     "required": [
--       "name",
--       "last-login"
--     ],
--     "type": "object"
--   }
--   </pre>
--   
--   If you needed more control over the content of the schema you might
--   also consider doing something like this, e.g. in the case where you
--   would like to allow additional properties:
--   
--   <pre>
--   data User = User
--     {      name :: Text
--     , lastLogin :: UTCTime
--     }
--   instance HasJsonEncodingSpec User where
--     type EncodingSpec User =
--       JsonObject
--         '[ '("name", JsonString)
--          , '("last-login", JsonDateTime)
--          ]
--     toJSONStructure user =
--       (Field @"name" (name user),
--       (Field @"last-login" (lastLogin user),
--       ()))
--   instance ToSchema User where
--     declareNamedSchema _proxy =
--         pure $
--           NamedSchema
--             Nothing
--             (
--               toOpenApiSchema (EncodingSpec User)
--                 &amp; set
--                     additionalProperties
--                     (Just (AdditionalPropertiesAllowed True))
--             )
--   </pre>
module Data.JsonSpec.OpenApi

-- | Convert a <a>Specification</a> into an OpenAPI <a>Schema</a>. The type
--   class <a>Internal</a> is an internal and opaque implementation detail
--   and not something you should have to worry about. It <i>should</i>
--   already have an instance for every possible <a>Specification</a> that
--   can be constructed. If it does not, then that is a bug. Please report
--   it! :-)
toOpenApiSchema :: Internal spec => Proxy (spec :: Specification) -> Schema

-- | Helper for defining <a>ToSchema</a> instances based on
--   <a>HasJsonEncodingSpec</a> using <tt>deriving via</tt>.
--   
--   Example:
--   
--   <pre>
--   data MyType = ...
--     deriving ToSchema via (EncodingSchema MyType)
--   instance HasJsonEncodingSchema MyType where
--     ...
--   </pre>
newtype EncodingSchema a
EncodingSchema :: a -> EncodingSchema a
[unEncodingSchema] :: EncodingSchema a -> a

-- | Helper for defining <a>ToSchema</a> instances based on
--   <a>HasJsonDecodingSpec</a> using <tt>deriving via</tt>.
--   
--   Example:
--   
--   <pre>
--   data MyType = ...
--     deriving ToSchema via (DecodingSchema MyType)
--   instance HasJsonDecodingSchema MyType where
--     ...
--   </pre>
newtype DecodingSchema a
DecodingSchema :: a -> DecodingSchema a
[unDecodingSchema] :: DecodingSchema a -> a
instance (Data.Typeable.Internal.Typeable a, Data.JsonSpec.OpenApi.Internal (Data.JsonSpec.Decode.DecodingSpec a)) => Data.OpenApi.Internal.Schema.ToSchema (Data.JsonSpec.OpenApi.DecodingSchema a)
instance (Data.Typeable.Internal.Typeable a, Data.JsonSpec.OpenApi.Internal (Data.JsonSpec.Encode.EncodingSpec a)) => Data.OpenApi.Internal.Schema.ToSchema (Data.JsonSpec.OpenApi.EncodingSchema a)
instance GHC.TypeLits.KnownSymbol tag => Data.JsonSpec.OpenApi.Internal ('Data.JsonSpec.Spec.JsonTag tag)
instance Data.JsonSpec.OpenApi.Internal 'Data.JsonSpec.Spec.JsonString
instance (Data.JsonSpec.OpenApi.Internal left, Data.JsonSpec.OpenApi.Internal right) => Data.JsonSpec.OpenApi.Internal ('Data.JsonSpec.Spec.JsonEither left right)
instance Data.JsonSpec.OpenApi.Internal 'Data.JsonSpec.Spec.JsonNum
instance Data.JsonSpec.OpenApi.Internal 'Data.JsonSpec.Spec.JsonInt
instance Data.JsonSpec.OpenApi.Internal ('Data.JsonSpec.Spec.JsonObject '[])
instance (GHC.TypeLits.KnownSymbol key, Data.JsonSpec.OpenApi.Internal spec, Data.JsonSpec.OpenApi.Internal ('Data.JsonSpec.Spec.JsonObject more)) => Data.JsonSpec.OpenApi.Internal ('Data.JsonSpec.Spec.JsonObject ('(key, spec) : more))
instance Data.JsonSpec.OpenApi.Internal spec => Data.JsonSpec.OpenApi.Internal ('Data.JsonSpec.Spec.JsonArray spec)
instance Data.JsonSpec.OpenApi.Internal 'Data.JsonSpec.Spec.JsonBool
instance Data.JsonSpec.OpenApi.Internal 'Data.JsonSpec.Spec.JsonDateTime