Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- data LifeCycleAPI auth f = LifeCycleAPI {
- agentSessionCreate :: f :- (Summary "Create a new agent session." :> (Description "Authenticated using the cluster join token acquired through POST /accounts/:accountId/clusterJoinTokens" :> ("agent" :> ("session" :> (ReqBody '[JSON] CreateAgentSession :> (auth :> Post '[JSON] Text))))))
- hello :: f :- (Summary "Update an agent session wrt features, versions, capabilities etc." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("hello" :> (ReqBody '[JSON] Hello :> (auth :> Post '[JSON] NoContent))))))
- heartbeat :: f :- (Summary "Update an agent session to indicate liveness." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("heartbeat" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent))))))
- goodbye :: f :- (Summary "Report that an agent has stopped." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("goodbye" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent))))))
- getServiceInfo :: f :- (Summary "Service version and configuration." :> ("agent" :> ("service-info" :> Get '[JSON] ServiceInfo)))
Documentation
data LifeCycleAPI auth f Source #
Agent session and "connection" endpoints
LifeCycleAPI | |
|
Instances
Generic (LifeCycleAPI auth f) Source # | |
Defined in Hercules.API.Agent.LifeCycle type Rep (LifeCycleAPI auth f) :: Type -> Type # from :: LifeCycleAPI auth f -> Rep (LifeCycleAPI auth f) x # to :: Rep (LifeCycleAPI auth f) x -> LifeCycleAPI auth f # | |
type Rep (LifeCycleAPI auth f) Source # | |
Defined in Hercules.API.Agent.LifeCycle type Rep (LifeCycleAPI auth f) = D1 ('MetaData "LifeCycleAPI" "Hercules.API.Agent.LifeCycle" "hercules-ci-api-agent-0.4.6.0-inplace" 'False) (C1 ('MetaCons "LifeCycleAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agentSessionCreate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Create a new agent session." :> (Description "Authenticated using the cluster join token acquired through POST /accounts/:accountId/clusterJoinTokens" :> ("agent" :> ("session" :> (ReqBody '[JSON] CreateAgentSession :> (auth :> Post '[JSON] Text)))))))) :*: S1 ('MetaSel ('Just "hello") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Update an agent session wrt features, versions, capabilities etc." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("hello" :> (ReqBody '[JSON] Hello :> (auth :> Post '[JSON] NoContent))))))))) :*: (S1 ('MetaSel ('Just "heartbeat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Update an agent session to indicate liveness." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("heartbeat" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent)))))))) :*: (S1 ('MetaSel ('Just "goodbye") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Report that an agent has stopped." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("goodbye" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent)))))))) :*: S1 ('MetaSel ('Just "getServiceInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Service version and configuration." :> ("agent" :> ("service-info" :> Get '[JSON] ServiceInfo))))))))) |