Safe Haskell	Safe-Inferred
Language	Haskell2010

PowerDNS.API.Metadata

Contents

API
Data types

Description

This module implements the endpoints described at Metadata API

Synopsis

data MetadataAPI f = MetadataAPI {
- apiListMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> Get '[JSON] [Metadata])))))
- apiCreateMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (ReqBody '[JSON] Metadata :> PostNoContent))))))
- apiGetMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> Get '[JSON] Metadata))))))
- apiUpdateMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> (ReqBody '[JSON] Metadata :> Put '[JSON] Metadata)))))))
- apiDeleteMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> DeleteNoContent))))))
}
data Metadata = Metadata {
- md_kind :: Text
- md_metadata :: [Text]
}

API

data MetadataAPI f Source #

Constructors

MetadataAPI

Fields

apiListMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> Get '[JSON] [Metadata])))))
apiCreateMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (ReqBody '[JSON] Metadata :> PostNoContent))))))
apiGetMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> Get '[JSON] Metadata))))))
apiUpdateMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> (ReqBody '[JSON] Metadata :> Put '[JSON] Metadata)))))))
apiDeleteMetadata :: f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> DeleteNoContent))))))

Instances

Instances details

Generic (MetadataAPI f) Source #
Instance details Defined in PowerDNS.API.Metadata Associated Types type Rep (MetadataAPI f) :: Type -> Type # Methods from :: MetadataAPI f -> Rep (MetadataAPI f) x # to :: Rep (MetadataAPI f) x -> MetadataAPI f #
type Rep (MetadataAPI f) Source #
Instance details Defined in PowerDNS.API.Metadata type Rep (MetadataAPI f) = D1 ('MetaData "MetadataAPI" "PowerDNS.API.Metadata" "powerdns-0.4.3-inplace" 'False) (C1 ('MetaCons "MetadataAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiListMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> Get '[JSON] [Metadata]))))))) :: S1 ('MetaSel ('Just "apiCreateMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (ReqBody '[JSON] Metadata :> PostNoContent))))))))) :: (S1 ('MetaSel ('Just "apiGetMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> Get '[JSON] Metadata)))))))) :: (S1 ('MetaSel ('Just "apiUpdateMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> (ReqBody '[JSON] Metadata :> Put '[JSON] Metadata))))))))) :: S1 ('MetaSel ('Just "apiDeleteMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("zones" :> (Capture "zone_id" Text :> ("metadata" :> (Capture "kind" Text :> DeleteNoContent))))))))))))

Data types

data Metadata Source #

Constructors

Metadata
Fields md_kind :: Text md_metadata :: [Text]

Instances

Instances details

FromJSON Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods parseJSON :: Value -> Parser Metadata parseJSONList :: Value -> Parser [Metadata]
ToJSON Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods toJSON :: Metadata -> Value toEncoding :: Metadata -> Encoding toJSONList :: [Metadata] -> Value toEncodingList :: [Metadata] -> Encoding
Data Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Metadata -> c Metadata # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Metadata # toConstr :: Metadata -> Constr # dataTypeOf :: Metadata -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Metadata) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Metadata) # gmapT :: (forall b. Data b => b -> b) -> Metadata -> Metadata # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Metadata -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Metadata -> r # gmapQ :: (forall d. Data d => d -> u) -> Metadata -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Metadata -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Metadata -> m Metadata # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Metadata -> m Metadata # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Metadata -> m Metadata #
Generic Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Associated Types type Rep Metadata :: Type -> Type # Methods from :: Metadata -> Rep Metadata x # to :: Rep Metadata x -> Metadata #
Show Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
NFData Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods rnf :: Metadata -> () #
Eq Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #
Ord Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods compare :: Metadata -> Metadata -> Ordering # (<) :: Metadata -> Metadata -> Bool # (<=) :: Metadata -> Metadata -> Bool # (>) :: Metadata -> Metadata -> Bool # (>=) :: Metadata -> Metadata -> Bool # max :: Metadata -> Metadata -> Metadata # min :: Metadata -> Metadata -> Metadata #
type Rep Metadata Source #
Instance details Defined in PowerDNS.API.Metadata type Rep Metadata = D1 ('MetaData "Metadata" "PowerDNS.API.Metadata" "powerdns-0.4.3-inplace" 'False) (C1 ('MetaCons "Metadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "md_kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "md_metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))