IOHK.Cicero.API.Fact

Documentation

newtype FactID

Constructors

FactID

Fields

• uuid :: UUID

Instances

FromJSON FactID

Defined in IOHK.Cicero.API.Fact

Methods

parseJSON :: Value -> Parser FactID

parseJSONList :: Value -> Parser [FactID]

ToJSON FactID

Defined in IOHK.Cicero.API.Fact

Methods

toJSON :: FactID -> Value

toEncoding :: FactID -> Encoding

toJSONList :: [FactID] -> Value

toEncodingList :: [FactID] -> Encoding

Eq FactID

Defined in IOHK.Cicero.API.Fact

Methods

(==) :: FactID -> FactID -> Bool

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

Ord FactID

Defined in IOHK.Cicero.API.Fact

Methods

compare :: FactID -> FactID -> Ordering

(<) :: FactID -> FactID -> Bool

(<=) :: FactID -> FactID -> Bool

(>) :: FactID -> FactID -> Bool

(>=) :: FactID -> FactID -> Bool

max :: FactID -> FactID -> FactID

min :: FactID -> FactID -> FactID

ToHttpApiData FactID

Defined in IOHK.Cicero.API.Fact

Methods

toUrlPiece :: FactID -> Text

toEncodedUrlPiece :: FactID -> Builder

toHeader :: FactID -> ByteString

toQueryParam :: FactID -> Text

factIdFromString :: String -> Maybe FactID

type API = NamedRoutes FactRoutes

data FactRoutes mode

Fact routes in the Cicero API

Constructors

FactRoutes

Fields

• create :: mode :- (ReqBody '[OctetStream] CreateFactV1 :> Post '[JSON] FactV1)
• getAll :: mode :- (QueryParam' '[Required, Strict] "run" RunID :> Get '[JSON] [FactV1])

Instances

Generic (FactRoutes mode)

Defined in IOHK.Cicero.API.Fact

Associated Types

type Rep (FactRoutes mode) :: Type -> Type

Methods

from :: FactRoutes mode -> Rep (FactRoutes mode) x

to :: Rep (FactRoutes mode) x -> FactRoutes mode

type Rep (FactRoutes mode)

Defined in IOHK.Cicero.API.Fact

type Rep (FactRoutes mode) = D1 ('MetaData "FactRoutes" "IOHK.Cicero.API.Fact" "cicero-api-0.1.2.0-9y64LgroRO6CqnkOALTEuu" 'False) (C1 ('MetaCons "FactRoutes" 'PrefixI 'True) (S1 ('MetaSel ('Just "create") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (ReqBody '[OctetStream] CreateFactV1 :> Post '[JSON] FactV1))) :*: S1 ('MetaSel ('Just "getAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (QueryParam' '[Required, Strict] "run" RunID :> Get '[JSON] [FactV1])))))

data CreateFactV1

Constructors

CreateFact

Fields

• fact :: !Value

  The data of the fact

• artifact :: !(Maybe ByteString)

  Binary blob attached to the fact

Instances

MimeRender OctetStream CreateFactV1

This instance assumes that toEncoding @Value has no trailing whitespace!

Defined in IOHK.Cicero.API.Fact

Methods

mimeRender :: Proxy OctetStream -> CreateFactV1 -> ByteString

data FactV1

A Cicero fact

Constructors

Fact

Fields

• id :: !FactID
• runId :: !(Maybe RunID)
• createdAt :: !ZonedTime
• value :: !Value
• binaryHash :: !(Maybe Text)

  The hash of the artifact, if any

  This should be a proper hash type

Instances

FromJSON FactV1

Defined in IOHK.Cicero.API.Fact

Methods

parseJSON :: Value -> Parser FactV1

parseJSONList :: Value -> Parser [FactV1]

ToJSON FactV1

Defined in IOHK.Cicero.API.Fact

Methods

toJSON :: FactV1 -> Value

toEncoding :: FactV1 -> Encoding

toJSONList :: [FactV1] -> Value

toEncodingList :: [FactV1] -> Encoding