Hercules.API.Build

Documentation

data BuildAPI auth f

Constructors

BuildAPI

Fields

• restartDerivation :: f :- (Summary "Restart a derivation" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> ("retry" :> (auth :> Post '[PlainText, JSON] NoContent)))))))
• readDerivationLogText :: f :- (Summary "Read a derivation build log" :> (Description "This interface may change." :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> ("log" :> (QueryParam "logId" (Id "log") :> (auth :> Get '[PlainText, JSON] Text)))))))))
• getLog :: f :- (Summary "Read all recorded log entries" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> ("log" :> ("lines" :> (QueryParam' '[Required] "logId" (Id "log") :> (QueryParam' '[Optional] "iMin" Int :> (auth :> Get '[JSON] Log))))))))))
• getDerivationInfo :: f :- (Summary "Get information about a derivation." :> (Description "Optionally, a job id can be specified to provide context." :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> (QueryParam' '[Optional, Strict] "via-job" (Id Job) :> (auth :> Get '[JSON] DerivationInfo))))))))

Instances

Generic (BuildAPI auth f)

Defined in Hercules.API.Build

Associated Types

type Rep (BuildAPI auth f) :: Type -> Type

Methods

from :: BuildAPI auth f -> Rep (BuildAPI auth f) x

to :: Rep (BuildAPI auth f) x -> BuildAPI auth f

type Rep (BuildAPI auth f)

Defined in Hercules.API.Build

type Rep (BuildAPI auth f) = D1 ('MetaData "BuildAPI" "Hercules.API.Build" "hercules-ci-api-0.7.1.0-8tZQ0QEUPOjGB9puScoqoh" 'False) (C1 ('MetaCons "BuildAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restartDerivation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Restart a derivation" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> ("retry" :> (auth :> Post '[PlainText, JSON] NoContent))))))))) :*: S1 ('MetaSel ('Just "readDerivationLogText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Read a derivation build log" :> (Description "This interface may change." :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> ("log" :> (QueryParam "logId" (Id "log") :> (auth :> Get '[PlainText, JSON] Text)))))))))))) :*: (S1 ('MetaSel ('Just "getLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Read all recorded log entries" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> ("log" :> ("lines" :> (QueryParam' '[Required] "logId" (Id "log") :> (QueryParam' '[Optional] "iMin" Int :> (auth :> Get '[JSON] Log)))))))))))) :*: S1 ('MetaSel ('Just "getDerivationInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Get information about a derivation." :> (Description "Optionally, a job id can be specified to provide context." :> ("accounts" :> (Capture "accountId" (Id Account) :> ("derivations" :> (Capture "derivationPath" Text :> (QueryParam' '[Optional, Strict] "via-job" (Id Job) :> (auth :> Get '[JSON] DerivationInfo)))))))))))))