kuber-3.1.0.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Kuber.Http.Spec

Documentation

type KuberServerApi era = ("api" :> ("v3" :> QueryApi era)) :<|> ("api" :> ("v1" :> (KuberApi era :<|> UtilityApi))) #

type QueryApi era = ("protocol-params" :> Get '[JSON] (LedgerProtocolParameters era)) :<|> (("chain-point" :> Get '[JSON] ChainPointModal) :<|> (("current-era" :> Get '[JSON] AnyCardanoEraModal) :<|> (("utxo" :> (QueryParams "address" Text :> (QueryParams "txin" Text :> Get '[JSON] (UtxoModal ConwayEra)))) :<|> (("system-start" :> Get '[JSON] SystemStartModal) :<|> (("genesis-params" :> Get '[JSON] (GenesisParamModal ShelleyEra)) :<|> ("health" :> Get '[JSON] HealthStatusModal)))))) #

type KuberApi era = ("tx" :> (QueryParam "submit" Bool :> (ReqBody '[JSON] (TxBuilder_ era) :> Post '[JSON] TxModal))) :<|> (("tx" :> ("submit" :> (ReqBody '[JSON] SubmitTxModal :> Post '[JSON] TxModal))) :<|> (("time" :> Get '[JSON] TranslationResponse) :<|> (("time" :> ("toslot" :> (ReqBody '[JSON] TimeTranslationReq :> Post '[JSON] TranslationResponse))) :<|> ("time" :> ("fromSlot" :> (ReqBody '[JSON] SlotTranslationReq :> Post '[JSON] TranslationResponse)))))) #

type UtilityApi = ("tx" :> ("fee" :> (ReqBody '[CBORBinary, CBORText, JSON] TxModal :> Post '[JSON] Coin))) :<|> ("tx" :> ("exUnits" :> (ReqBody '[CBORBinary, CBORText, CBORText] TxModal :> Post '[JSON] ExUnitsResponseModal))) #

kuberApiServerProxy :: Proxy (KuberServerApi era) #

data CBORBinary #

Instances

Instances details
Accept CBORBinary # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

contentType :: Proxy CBORBinary -> MediaType #

contentTypes :: Proxy CBORBinary -> NonEmpty MediaType #

MimeRender CBORBinary TxModal # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeRender :: Proxy CBORBinary -> TxModal -> ByteString #

MimeUnrender CBORBinary SubmitTxModal # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy CBORBinary -> ByteString -> Either String SubmitTxModal #

mimeUnrenderWithType :: Proxy CBORBinary -> MediaType -> ByteString -> Either String SubmitTxModal #

MimeUnrender CBORBinary TxModal # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy CBORBinary -> ByteString -> Either String TxModal #

mimeUnrenderWithType :: Proxy CBORBinary -> MediaType -> ByteString -> Either String TxModal #

IsTxBuilderEra era => MimeUnrender CBORBinary (Tx era) # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy CBORBinary -> ByteString -> Either String (Tx era) #

mimeUnrenderWithType :: Proxy CBORBinary -> MediaType -> ByteString -> Either String (Tx era) #

data CBORText #

Instances

Instances details
Accept CBORText # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

contentType :: Proxy CBORText -> MediaType #

contentTypes :: Proxy CBORText -> NonEmpty MediaType #

MimeRender CBORBinary a => MimeRender CBORText a # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeRender :: Proxy CBORText -> a -> ByteString #

MimeUnrender CBORBinary a => MimeUnrender CBORText a # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy CBORText -> ByteString -> Either String a #

mimeUnrenderWithType :: Proxy CBORText -> MediaType -> ByteString -> Either String a #

data AnyTextType #

Instances

Instances details
Accept AnyTextType # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

contentType :: Proxy AnyTextType -> MediaType #

contentTypes :: Proxy AnyTextType -> NonEmpty MediaType #

MimeUnrender AnyTextType Text # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy AnyTextType -> ByteString -> Either String Text #

mimeUnrenderWithType :: Proxy AnyTextType -> MediaType -> ByteString -> Either String Text #

MimeUnrender AnyTextType Text # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy AnyTextType -> ByteString -> Either String Text #

mimeUnrenderWithType :: Proxy AnyTextType -> MediaType -> ByteString -> Either String Text #

MimeUnrender AnyTextType String # 
Instance details

Defined in Cardano.Kuber.Http.MediaType

Methods

mimeUnrender :: Proxy AnyTextType -> ByteString -> Either String String #

mimeUnrenderWithType :: Proxy AnyTextType -> MediaType -> ByteString -> Either String String #