mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-25 00:13:11 +03:00
4f835623b1
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4400 GitOrigin-RevId: 2d90542f95ef4dad70c8dfe1ca3b4c1f3bdaa527
63 lines
2.1 KiB
Haskell
63 lines
2.1 KiB
Haskell
{-# LANGUAGE DeriveAnyClass #-}
|
|
|
|
module Hasura.Backends.DataConnector.API.V0.Schema
|
|
( SchemaResponse (..),
|
|
QueryResponse (..),
|
|
Capabilities (..),
|
|
)
|
|
where
|
|
|
|
import Autodocodec
|
|
import Control.DeepSeq (NFData)
|
|
import Data.Aeson (FromJSON, Object, ToJSON)
|
|
import Data.Data (Data)
|
|
import Data.Hashable (Hashable)
|
|
import Data.OpenApi (ToSchema)
|
|
import GHC.Generics (Generic)
|
|
import Hasura.Backends.DataConnector.API.V0.Table qualified as API.V0
|
|
import Prelude
|
|
|
|
--------------------------------------------------------------------------------
|
|
-- Schema Response
|
|
|
|
-- | The Schema Response provides the schemas for tracked tables and
|
|
-- 'Capabilities' supported by the service.
|
|
data SchemaResponse = SchemaResponse
|
|
{ srCapabilities :: Capabilities,
|
|
srTables :: [API.V0.TableInfo]
|
|
}
|
|
deriving stock (Eq, Ord, Show, Generic, Data)
|
|
deriving anyclass (NFData, Hashable)
|
|
deriving (FromJSON, ToJSON, ToSchema) via Autodocodec SchemaResponse
|
|
|
|
instance HasCodec SchemaResponse where
|
|
codec =
|
|
object "SchemaResponse" $
|
|
SchemaResponse
|
|
<$> requiredField "capabilities" "Capabilities of the agent" .= srCapabilities
|
|
<*> requiredField "tables" "Available tables" .= srTables
|
|
|
|
-- | The 'Capabilities' describes the _capabilities_ of the
|
|
-- service. Specifically, the service is capable of serving queries
|
|
-- which involve relationships.
|
|
data Capabilities = Capabilities
|
|
{ dcRelationships :: Bool
|
|
}
|
|
deriving stock (Eq, Ord, Show, Generic, Data)
|
|
deriving anyclass (NFData, Hashable)
|
|
deriving (FromJSON, ToJSON, ToSchema) via Autodocodec Capabilities
|
|
|
|
instance HasCodec Capabilities where
|
|
codec =
|
|
object "Capabilities" $
|
|
Capabilities <$> requiredField "relationships" "Does the agent support relationships?" .= dcRelationships
|
|
|
|
--------------------------------------------------------------------------------
|
|
-- Query Response
|
|
|
|
-- | The resolved query response provided by the 'POST /query'
|
|
-- endpoint encoded as 'J.Value'.
|
|
newtype QueryResponse = QueryResponse {getQueryResponse :: [Object]}
|
|
deriving newtype (Eq, Ord, Show, NFData)
|
|
deriving (ToJSON, FromJSON, ToSchema) via Autodocodec [Object]
|