Compendium.Client

Client for the Compendium schema registry

Generic query of schemas

data IdlName

Interface Description Languages supported by Compendium.

Instances

Eq IdlName

Defined in Compendium.Client

Methods

(==) :: IdlName -> IdlName -> Bool

(/=) :: IdlName -> IdlName -> Bool

Show IdlName

Defined in Compendium.Client

Methods

showsPrec :: Int -> IdlName -> ShowS

show :: IdlName -> String

showList :: [IdlName] -> ShowS

Generic IdlName

Defined in Compendium.Client

Associated Types

type Rep IdlName :: Type -> Type

Methods

from :: IdlName -> Rep IdlName x

to :: Rep IdlName x -> IdlName

ToHttpApiData IdlName

Defined in Compendium.Client

Methods

toUrlPiece :: IdlName -> Text

toEncodedUrlPiece :: IdlName -> Builder

toHeader :: IdlName -> ByteString

toQueryParam :: IdlName -> Text

type Rep IdlName

Defined in Compendium.Client

type Rep IdlName = D1 ('MetaData "IdlName" "Compendium.Client" "compendium-client-0.2.1.1-5jiThMz8XbZF8uvAxqq5Ne" 'False) ((C1 ('MetaCons "Avro" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Protobuf" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Mu" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OpenApi" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Scala" 'PrefixI 'False) (U1 :: Type -> Type))))

transformation

Arguments

:: Manager

Connection details (from 'http-client').

-> BaseUrl

URL in which Compendium is running.

-> Text

Name that identifies the schema.

-> IdlName

Format of the returned schema.

-> IO (Either ClientError Text)

Obtain a schema from the registry.

Query Protocol Buffer schemas

obtainProtoBuf :: Manager -> BaseUrl -> Text -> IO (Either ObtainProtoBufError ProtoBuf)

Obtain a schema from the registry, and parse it as Protocol Buffers.

data ObtainProtoBufError

Errors which may arise during obtainProtoBuf.

Constructors

OPEClient ClientError

Error obtaining schema from Compendium

OPEParse (ParseErrorBundle Text Char)

Obtaining the schema was OK, error parsing it

Instances

Show ObtainProtoBufError

Defined in Compendium.Client

Methods

showsPrec :: Int -> ObtainProtoBufError -> ShowS

show :: ObtainProtoBufError -> String

showList :: [ObtainProtoBufError] -> ShowS