mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 04:24:35 +03:00
b094947239
This PR expands the set of codecs for source metadata to include `TableMetadata`, `FunctionMetadata`, and various permission types. This fills out more detail in the generated OpenAPI document. See the [generated OpenAPI spec](https://gist.github.com/hallettj/783d06a926cbc854eececa4964e8aa5b) based on this PR. See also the [generated TypeScript types](https://github.com/hasura/graphql-engine-mono/files/9448102/client-typescript.tar.gz) based on that spec. Ticket: https://hasurahq.atlassian.net/browse/MM-66 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5664 GitOrigin-RevId: b6e1f32c669368cd6150e6f69fc36b78b748d9bb
41 lines
1.6 KiB
Haskell
41 lines
1.6 KiB
Haskell
-- | Utility functions for use defining autodocodec codecs.
|
|
module Hasura.Metadata.DTO.Utils (codecNamePrefix, versionField, optionalVersionField) where
|
|
|
|
import Autodocodec
|
|
( Codec (EqCodec),
|
|
ObjectCodec,
|
|
optionalFieldWith',
|
|
requiredFieldWith',
|
|
scientificCodec,
|
|
(.=),
|
|
)
|
|
import Data.Scientific (Scientific)
|
|
import Data.Text qualified as T
|
|
import Data.Text.Extended qualified as T
|
|
import Hasura.Prelude
|
|
import Hasura.SQL.Tag (HasTag (backendTag), reify)
|
|
|
|
-- | Defines a required object field named @version@ that must have the given
|
|
-- integer value. On serialization the field will have the given value
|
|
-- automatically. On deserialization parsing will fail unless the field has the
|
|
-- exact given value.
|
|
versionField :: Integer -> ObjectCodec a Scientific
|
|
versionField v = requiredFieldWith' "version" (EqCodec n scientificCodec) .= const n
|
|
where
|
|
n = fromInteger v
|
|
|
|
-- | Defines an optional object field named @version@ that must have the given
|
|
-- integer value if the field is present. On serialization the field will have
|
|
-- the given value automatically. On deserialization parsing will fail unless
|
|
-- the field has the exact given value, or is absent.
|
|
optionalVersionField :: Integer -> ObjectCodec a (Maybe Scientific)
|
|
optionalVersionField v =
|
|
optionalFieldWith' "version" (EqCodec n scientificCodec) .= const (Just n)
|
|
where
|
|
n = fromInteger v
|
|
|
|
-- | Provides a title-cased name for a database kind, inferring the appropriate
|
|
-- database kind from type context.
|
|
codecNamePrefix :: forall b. (HasTag b) => Text
|
|
codecNamePrefix = T.toTitle $ T.toTxt $ reify $ backendTag @b
|