IOHK.Cicero.API.Action

Documentation

type API = NamedRoutes ActionRoutes

newtype ActionID

Constructors

ActionID

Fields

• uuid :: UUID

Instances

FromJSON ActionID

Defined in IOHK.Cicero.API.Action

Methods

parseJSON :: Value -> Parser ActionID

parseJSONList :: Value -> Parser [ActionID]

ToJSON ActionID

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: ActionID -> Value

toEncoding :: ActionID -> Encoding

toJSONList :: [ActionID] -> Value

toEncodingList :: [ActionID] -> Encoding

Eq ActionID

Defined in IOHK.Cicero.API.Action

Methods

(==) :: ActionID -> ActionID -> Bool

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

Ord ActionID

Defined in IOHK.Cicero.API.Action

Methods

compare :: ActionID -> ActionID -> Ordering

(<) :: ActionID -> ActionID -> Bool

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

(>) :: ActionID -> ActionID -> Bool

(>=) :: ActionID -> ActionID -> Bool

max :: ActionID -> ActionID -> ActionID

min :: ActionID -> ActionID -> ActionID

ToHttpApiData ActionID

Defined in IOHK.Cicero.API.Action

Methods

toUrlPiece :: ActionID -> Text

toEncodedUrlPiece :: ActionID -> Builder

toHeader :: ActionID -> ByteString

toQueryParam :: ActionID -> Text

actionIdFromString :: String -> Maybe ActionID

data ActionRoutes mode

Action routes in the Cicero API

Constructors

ActionRoutes

Fields

• create :: mode :- (ReqBody '[JSON] CreateActionV1 :> Post '[JSON] CreateActionResponseV2)
• get :: mode :- (Capture "id" ActionID :> Get '[JSON] ActionV2)

Instances

Generic (ActionRoutes mode)

Defined in IOHK.Cicero.API.Action

Associated Types

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

Methods

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

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

type Rep (ActionRoutes mode)

Defined in IOHK.Cicero.API.Action

type Rep (ActionRoutes mode) = D1 ('MetaData "ActionRoutes" "IOHK.Cicero.API.Action" "cicero-api-0.1.2.0-9y64LgroRO6CqnkOALTEuu" 'False) (C1 ('MetaCons "ActionRoutes" 'PrefixI 'True) (S1 ('MetaSel ('Just "create") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (ReqBody '[JSON] CreateActionV1 :> Post '[JSON] CreateActionResponseV2))) :*: S1 ('MetaSel ('Just "get") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Capture "id" ActionID :> Get '[JSON] ActionV2)))))

data CreateActionV1

Constructors

CreateAction

Fields

• names :: !ActionNamesV1
• source :: !ActionSourceV1

Instances

ToJSON CreateActionV1

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: CreateActionV1 -> Value

toEncoding :: CreateActionV1 -> Encoding

toJSONList :: [CreateActionV1] -> Value

toEncodingList :: [CreateActionV1] -> Encoding

data CreateActionResponseV2

Constructors

CreateActionOnly !ActionV2

The specific action created

Returned if an Only was set in $sel:names:CreateAction

CreateActionAll ![ActionV2]

All actions created

Returned if AllNames was set in $sel:names:CreateAction

Instances

FromJSON CreateActionResponseV2

Defined in IOHK.Cicero.API.Action

Methods

parseJSON :: Value -> Parser CreateActionResponseV2

parseJSONList :: Value -> Parser [CreateActionResponseV2]

ToJSON CreateActionResponseV2

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: CreateActionResponseV2 -> Value

toEncoding :: CreateActionResponseV2 -> Encoding

toJSONList :: [CreateActionResponseV2] -> Value

toEncodingList :: [CreateActionResponseV2] -> Encoding

newtype ActionSourceV1

The source of an action, as a go-getter URL

Constructors

ActionSource

Fields

• unActionSource :: Text

Instances

FromJSON ActionSourceV1

Defined in IOHK.Cicero.API.Action

Methods

parseJSON :: Value -> Parser ActionSourceV1

parseJSONList :: Value -> Parser [ActionSourceV1]

ToJSON ActionSourceV1

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: ActionSourceV1 -> Value

toEncoding :: ActionSourceV1 -> Encoding

toJSONList :: [ActionSourceV1] -> Value

toEncodingList :: [ActionSourceV1] -> Encoding

IsString ActionSourceV1

Defined in IOHK.Cicero.API.Action

Methods

fromString :: String -> ActionSourceV1

data ActionNamesV1

The action names to add from a given ActionSourceV1

Constructors

Only !Text

Just add the action with the given name

AllNames

Add all names exported by the source

newtype CUE

A CUE lang value

For now just a wrapper around Text that we hope parses

Constructors

CUE

Fields

• expr :: Text

Instances

FromJSON CUE

Defined in IOHK.Cicero.API.Action

Methods

parseJSON :: Value -> Parser CUE

parseJSONList :: Value -> Parser [CUE]

ToJSON CUE

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: CUE -> Value

toEncoding :: CUE -> Encoding

toJSONList :: [CUE] -> Value

toEncodingList :: [CUE] -> Encoding

data InputV2

An input to a job

Constructors

Input

Fields

• not :: !Bool

  Negate the matching condition?

• optional :: !Bool

  Can this input be missing?

• match :: !CUE

  Which facts to match

Instances

FromJSON InputV2

Defined in IOHK.Cicero.API.Action

Methods

parseJSON :: Value -> Parser InputV2

parseJSONList :: Value -> Parser [InputV2]

ToJSON InputV2

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: InputV2 -> Value

toEncoding :: InputV2 -> Encoding

toJSONList :: [InputV2] -> Value

toEncodingList :: [InputV2] -> Encoding

data ActionV2

An action

Constructors

Action

Fields

• id :: !ActionID
• name :: !Text
• source :: !ActionSourceV1
• createdAt :: !ZonedTime
• active :: !Bool
• meta :: !(Maybe (Map Text Value))
• inputs :: !(Map Text InputV2)

Instances

FromJSON ActionV2

Defined in IOHK.Cicero.API.Action

Methods

parseJSON :: Value -> Parser ActionV2

parseJSONList :: Value -> Parser [ActionV2]

ToJSON ActionV2

Defined in IOHK.Cicero.API.Action

Methods

toJSON :: ActionV2 -> Value

toEncoding :: ActionV2 -> Encoding

toJSONList :: [ActionV2] -> Value

toEncodingList :: [ActionV2] -> Encoding