Safe Haskell	Safe-Inferred
Language	Haskell2010

IOHK.Cicero.API.Action

Synopsis

type API = NamedRoutes ActionRoutes
newtype ActionID = ActionID {
- uuid :: UUID
}
actionIdFromString :: String -> Maybe ActionID
data ActionRoutes mode = ActionRoutes {
- create :: mode :- (ReqBody '[JSON] CreateActionV1 :> Post '[JSON] CreateActionResponseV2)
- get :: mode :- (Capture "id" ActionID :> Get '[JSON] ActionV2)
}
data CreateActionV1 = CreateAction {
- names :: !ActionNamesV1
- source :: !ActionSourceV1
}
data CreateActionResponseV2
- = CreateActionOnly !ActionV2
- | CreateActionAll ![ActionV2]
newtype ActionSourceV1 = ActionSource {
- unActionSource :: Text
}
data ActionNamesV1
- = Only !Text
- | AllNames
newtype CUE = CUE {
- expr :: Text
}
data InputV2 = Input {
- not :: !Bool
- optional :: !Bool
- match :: !CUE
}
data ActionV2 = Action {
- id :: !ActionID
- name :: !Text
- source :: !ActionSourceV1
- createdAt :: !ZonedTime
- active :: !Bool
- meta :: !(Maybe (Map Text Value))
- inputs :: !(Map Text InputV2)
}

Documentation

type API = NamedRoutes ActionRoutes Source #

newtype ActionID Source #

Constructors

ActionID
Fields uuid :: UUID

Instances

Instances details

FromJSON ActionID Source #
Instance details Defined in IOHK.Cicero.API.Action Methods parseJSON :: Value -> Parser ActionID # parseJSONList :: Value -> Parser [ActionID] #
ToJSON ActionID Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: ActionID -> Value # toEncoding :: ActionID -> Encoding # toJSONList :: [ActionID] -> Value # toEncodingList :: [ActionID] -> Encoding #
Eq ActionID Source #
Instance details Defined in IOHK.Cicero.API.Action Methods (==) :: ActionID -> ActionID -> Bool # (/=) :: ActionID -> ActionID -> Bool #
Ord ActionID Source #
Instance details 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 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toUrlPiece :: ActionID -> Text # toEncodedUrlPiece :: ActionID -> Builder # toHeader :: ActionID -> ByteString # toQueryParam :: ActionID -> Text #

actionIdFromString :: String -> Maybe ActionID Source #

data ActionRoutes mode Source #

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

Instances details

Generic (ActionRoutes mode) Source #
Instance details 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) Source #
Instance details 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 Source #

Constructors

CreateAction
Fields names :: !ActionNamesV1 source :: !ActionSourceV1

Instances

Instances details

ToJSON CreateActionV1 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: CreateActionV1 -> Value # toEncoding :: CreateActionV1 -> Encoding # toJSONList :: [CreateActionV1] -> Value # toEncodingList :: [CreateActionV1] -> Encoding #

data CreateActionResponseV2 Source #

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

Instances details

FromJSON CreateActionResponseV2 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods parseJSON :: Value -> Parser CreateActionResponseV2 # parseJSONList :: Value -> Parser [CreateActionResponseV2] #
ToJSON CreateActionResponseV2 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: CreateActionResponseV2 -> Value # toEncoding :: CreateActionResponseV2 -> Encoding # toJSONList :: [CreateActionResponseV2] -> Value # toEncodingList :: [CreateActionResponseV2] -> Encoding #

newtype ActionSourceV1 Source #

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

Constructors

ActionSource
Fields unActionSource :: Text

Instances

Instances details

FromJSON ActionSourceV1 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods parseJSON :: Value -> Parser ActionSourceV1 # parseJSONList :: Value -> Parser [ActionSourceV1] #
ToJSON ActionSourceV1 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: ActionSourceV1 -> Value # toEncoding :: ActionSourceV1 -> Encoding # toJSONList :: [ActionSourceV1] -> Value # toEncodingList :: [ActionSourceV1] -> Encoding #
IsString ActionSourceV1 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods fromString :: String -> ActionSourceV1 #

data ActionNamesV1 Source #

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 Source #

A CUE lang value

For now just a wrapper around Text that we hope parses

Constructors

CUE
Fields expr :: Text

Instances

Instances details

FromJSON CUE Source #
Instance details Defined in IOHK.Cicero.API.Action Methods parseJSON :: Value -> Parser CUE # parseJSONList :: Value -> Parser [CUE] #
ToJSON CUE Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: CUE -> Value # toEncoding :: CUE -> Encoding # toJSONList :: [CUE] -> Value # toEncodingList :: [CUE] -> Encoding #

data InputV2 Source #

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

Instances details

FromJSON InputV2 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods parseJSON :: Value -> Parser InputV2 # parseJSONList :: Value -> Parser [InputV2] #
ToJSON InputV2 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: InputV2 -> Value # toEncoding :: InputV2 -> Encoding # toJSONList :: [InputV2] -> Value # toEncodingList :: [InputV2] -> Encoding #

data ActionV2 Source #

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

Instances details

FromJSON ActionV2 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods parseJSON :: Value -> Parser ActionV2 # parseJSONList :: Value -> Parser [ActionV2] #
ToJSON ActionV2 Source #
Instance details Defined in IOHK.Cicero.API.Action Methods toJSON :: ActionV2 -> Value # toEncoding :: ActionV2 -> Encoding # toJSONList :: [ActionV2] -> Value # toEncodingList :: [ActionV2] -> Encoding #