IOHK.Cicero.API.Run

Documentation

newtype RunID

Constructors

RunID

Fields

• uuid :: UUID

Instances

FromJSON RunID

Defined in IOHK.Cicero.API.Run

Methods

parseJSON :: Value -> Parser RunID

parseJSONList :: Value -> Parser [RunID]

ToJSON RunID

Defined in IOHK.Cicero.API.Run

Methods

toJSON :: RunID -> Value

toEncoding :: RunID -> Encoding

toJSONList :: [RunID] -> Value

toEncodingList :: [RunID] -> Encoding

Eq RunID

Defined in IOHK.Cicero.API.Run

Methods

(==) :: RunID -> RunID -> Bool

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

Ord RunID

Defined in IOHK.Cicero.API.Run

Methods

compare :: RunID -> RunID -> Ordering

(<) :: RunID -> RunID -> Bool

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

(>) :: RunID -> RunID -> Bool

(>=) :: RunID -> RunID -> Bool

max :: RunID -> RunID -> RunID

min :: RunID -> RunID -> RunID

ToHttpApiData RunID

Defined in IOHK.Cicero.API.Run

Methods

toUrlPiece :: RunID -> Text

toEncodedUrlPiece :: RunID -> Builder

toHeader :: RunID -> ByteString

toQueryParam :: RunID -> Text

runIdFromString :: String -> Maybe RunID

type API = NamedRoutes RunRoutes

data RunRoutes mode

Run routes in the Cicero API

Constructors

RunRoutes

Fields

• getAll :: mode :- (QueryFlag "recursive" :> (QueryParams "input" FactID :> (QueryParam "offset" Natural :> (QueryParam "limit" Natural :> Get '[JSON] [RunV2]))))
• createFact :: mode :- (Capture "id" RunID :> ("fact" :> (ReqBody '[OctetStream] CreateFactV1 :> Post '[JSON] FactV1)))
• getLogs :: mode :- (Capture "id" RunID :> ("logs" :> Get '[JSON] RunLogsV1))

Instances

Generic (RunRoutes mode)

Defined in IOHK.Cicero.API.Run

Associated Types

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

Methods

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

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

type Rep (RunRoutes mode)

Defined in IOHK.Cicero.API.Run

type Rep (RunRoutes mode) = D1 ('MetaData "RunRoutes" "IOHK.Cicero.API.Run" "cicero-api-0.1.1.3-IBOneHfrhNLHE3ibncoqJp" 'False) (C1 ('MetaCons "RunRoutes" 'PrefixI 'True) (S1 ('MetaSel ('Just "getAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (QueryFlag "recursive" :> (QueryParams "input" FactID :> (QueryParam "offset" Natural :> (QueryParam "limit" Natural :> Get '[JSON] [RunV2])))))) :*: (S1 ('MetaSel ('Just "createFact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Capture "id" RunID :> ("fact" :> (ReqBody '[OctetStream] CreateFactV1 :> Post '[JSON] FactV1))))) :*: S1 ('MetaSel ('Just "getLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Capture "id" RunID :> ("logs" :> Get '[JSON] RunLogsV1)))))))

data RunV2

Constructors

Run

Fields

• nomadJobId :: !RunID
• invocationId :: !InvocationID
• createdAt :: !ZonedTime
• finishedAt :: !(Maybe ZonedTime)

Instances

FromJSON RunV2

Defined in IOHK.Cicero.API.Run

Methods

parseJSON :: Value -> Parser RunV2

parseJSONList :: Value -> Parser [RunV2]

ToJSON RunV2

Defined in IOHK.Cicero.API.Run

Methods

toJSON :: RunV2 -> Value

toEncoding :: RunV2 -> Encoding

toJSONList :: [RunV2] -> Value

toEncodingList :: [RunV2] -> Encoding

newtype RunLogsV1

Constructors

RunLogs [RunLog]

Instances

FromJSON RunLogsV1

Defined in IOHK.Cicero.API.Run

Methods

parseJSON :: Value -> Parser RunLogsV1

parseJSONList :: Value -> Parser [RunLogsV1]

ToJSON RunLogsV1

Defined in IOHK.Cicero.API.Run

Methods

toJSON :: RunLogsV1 -> Value

toEncoding :: RunLogsV1 -> Encoding

toJSONList :: [RunLogsV1] -> Value

toEncodingList :: [RunLogsV1] -> Encoding

data RunLog

Constructors

RunLog

Fields

• time :: !ZonedTime
• source :: !Text
• text :: !Text

Instances

FromJSON RunLog

Defined in IOHK.Cicero.API.Run

Methods

parseJSON :: Value -> Parser RunLog

parseJSONList :: Value -> Parser [RunLog]

ToJSON RunLog

Defined in IOHK.Cicero.API.Run

Methods

toJSON :: RunLog -> Value

toEncoding :: RunLog -> Encoding

toJSONList :: [RunLog] -> Value

toEncodingList :: [RunLog] -> Encoding