Safe Haskell	None
Language	Haskell2010

OM.DoH.Api

Description

Synopsis

data DoHApi route = DoHApi {
- getQuery :: route :- (Summary "Submit a raw DNS query on the query string." :> (QueryParam' '[Required, Strict] "dns" Query :> Get '[DnsMsgCT] Response))
- postQuery :: route :- (Summary "Submit a raw DNS query in the POST body." :> (ReqBody '[DnsMsgCT] Query :> Post '[DnsMsgCT] Response))
}
newtype Query = Query {
- unQuery :: ByteString
}
newtype Response = Response {
- unResponse :: ByteString
}
data DnsMsgCT

Documentation

The DoH api, defined in the Servant.API.Generic style.

Constructors

DoHApi
Fields getQuery :: route :- (Summary "Submit a raw DNS query on the query string." :> (QueryParam' '[Required, Strict] "dns" Query :> Get '[DnsMsgCT] Response)) postQuery :: route :- (Summary "Submit a raw DNS query in the POST body." :> (ReqBody '[DnsMsgCT] Query :> Post '[DnsMsgCT] Response))

Instances details

Instance details

Defined in OM.DoH.Api

Associated Types

type Rep (DoHApi route)

Instance details

Defined in OM.DoH.Api

type Rep (DoHApi route) = D1 ('MetaData "DoHApi" "OM.DoH.Api" "om-doh-0.1.0.2-inplace" 'False) (C1 ('MetaCons "DoHApi" 'PrefixI 'True) (S1 ('MetaSel ('Just "getQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Summary "Submit a raw DNS query on the query string." :> (QueryParam' '[Required, Strict] "dns" Query :> Get '[DnsMsgCT] Response)))) :*: S1 ('MetaSel ('Just "postQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Summary "Submit a raw DNS query in the POST body." :> (ReqBody '[DnsMsgCT] Query :> Post '[DnsMsgCT] Response))))))

Methods

from :: DoHApi route -> Rep (DoHApi route) x #

to :: Rep (DoHApi route) x -> DoHApi route #

type Rep (DoHApi route) Source #

Instance details

Defined in OM.DoH.Api

type Rep (DoHApi route) = D1 ('MetaData "DoHApi" "OM.DoH.Api" "om-doh-0.1.0.2-inplace" 'False) (C1 ('MetaCons "DoHApi" 'PrefixI 'True) (S1 ('MetaSel ('Just "getQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Summary "Submit a raw DNS query on the query string." :> (QueryParam' '[Required, Strict] "dns" Query :> Get '[DnsMsgCT] Response)))) :*: S1 ('MetaSel ('Just "postQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (Summary "Submit a raw DNS query in the POST body." :> (ReqBody '[DnsMsgCT] Query :> Post '[DnsMsgCT] Response))))))

A raw DNS query message. The Network.DNS module contains tools for encoding and decoding these messages.

Constructors

Query
Fields unQuery :: ByteString

Instances details

FromHttpApiData Query Source #
Instance details Defined in OM.DoH.Api Methods parseUrlPiece :: Text -> Either Text Query # parseHeader :: ByteString -> Either Text Query # parseQueryParam :: Text -> Either Text Query #
MimeUnrender DnsMsgCT Query Source #
Instance details Defined in OM.DoH.Api Methods mimeUnrender :: Proxy DnsMsgCT -> ByteString -> Either String Query # mimeUnrenderWithType :: Proxy DnsMsgCT -> MediaType -> ByteString -> Either String Query #

A raw DNS response message. The Network.DNS module contains tools for encoding and decoding these messages.

Constructors

Response
Fields unResponse :: ByteString

Instances details

MimeRender DnsMsgCT Response Source #
Instance details Defined in OM.DoH.Api Methods mimeRender :: Proxy DnsMsgCT -> Response -> ByteString #

The application/dns-message content type.

Instances details

Accept DnsMsgCT Source #
Instance details Defined in OM.DoH.Api Methods contentType :: Proxy DnsMsgCT -> MediaType # contentTypes :: Proxy DnsMsgCT -> NonEmpty MediaType #
MimeRender DnsMsgCT ByteString Source #
Instance details Defined in OM.DoH.Api Methods mimeRender :: Proxy DnsMsgCT -> ByteString -> ByteString #
MimeRender DnsMsgCT Response Source #
Instance details Defined in OM.DoH.Api Methods mimeRender :: Proxy DnsMsgCT -> Response -> ByteString #
MimeUnrender DnsMsgCT ByteString Source #
Instance details Defined in OM.DoH.Api Methods mimeUnrender :: Proxy DnsMsgCT -> ByteString -> Either String ByteString # mimeUnrenderWithType :: Proxy DnsMsgCT -> MediaType -> ByteString -> Either String ByteString #
MimeUnrender DnsMsgCT Query Source #
Instance details Defined in OM.DoH.Api Methods mimeUnrender :: Proxy DnsMsgCT -> ByteString -> Either String Query # mimeUnrenderWithType :: Proxy DnsMsgCT -> MediaType -> ByteString -> Either String Query #