| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Hercules.API.State
Synopsis
- newtype RawBytes = RawBytes {}
- type ContentLength = Header "Content-Length" Integer
- type ContentDisposition = Header "Content-Disposition" Text
- data ProjectStateResourceGroup auth f = ProjectStateResourceGroup {
- putStateData :: f :- (Summary "Upload a state file" :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (StreamBody NoFraming OctetStream (SourceIO RawBytes) :> (auth :> Put '[JSON] NoContent))))))
- getStates :: f :- (Summary "List all state files" :> ("states" :> (auth :> Get '[JSON] ProjectState)))
- getStateData :: f :- (Summary "Download a state file" :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (QueryParam' '[Optional, Strict] "version" Int :> (auth :> StreamGet NoFraming OctetStream (Headers '[ContentLength, ContentDisposition] (SourceIO RawBytes))))))))
- acquireLock :: f :- (Summary "Acquire a lock" :> ("lock" :> (Capture' '[Required, Strict] "lockName" Text :> (ReqBody '[JSON] StateLockAcquireRequest :> (auth :> Post '[JSON] StateLockAcquireResponse)))))
- data StateAPI auth f = StateAPI {
- byProjectId :: f :- Substitute ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> Placeholder)) (ToServantApi (ProjectStateResourceGroup auth))
- byProjectName :: f :- Substitute ("site" :> (Capture' '[Required, Strict] "site" (Name Forge) :> ("account" :> (Capture' '[Required, Strict] "account" (Name Account) :> ("project" :> (Capture' '[Required, Strict] "project" (Name Project) :> Placeholder)))))) (ToServantApi (ProjectStateResourceGroup auth))
- updateLockLease :: f :- ("lock-leases" :> (Capture' '[Required, Strict] "lockLeaseId" (Id "StateLockLease") :> (ReqBody '[JSON] StateLockUpdateRequest :> (auth :> Post '[JSON] StateLockAcquiredResponse))))
- deleteLockLease :: f :- ("lock-leases" :> (Capture' '[Required, Strict] "lockLeaseId" (Id "StateLockLease") :> (auth :> Delete '[JSON] NoContent)))
Documentation
A newtype wrapper for servant-swagger
Constructors
| RawBytes | |
Fields | |
Instances
| ToSchema RawBytes Source # | |
Defined in Hercules.API.State Methods declareNamedSchema :: Proxy RawBytes -> Declare (Definitions Schema) NamedSchema # | |
| MimeRender OctetStream RawBytes Source # | |
Defined in Hercules.API.State Methods mimeRender :: Proxy OctetStream -> RawBytes -> ByteString # | |
| MimeUnrender OctetStream RawBytes Source # | |
Defined in Hercules.API.State Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String RawBytes # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String RawBytes # | |
type ContentLength = Header "Content-Length" Integer Source #
type ContentDisposition = Header "Content-Disposition" Text Source #
data ProjectStateResourceGroup auth f Source #
Constructors
| ProjectStateResourceGroup | |
Fields
| |
Instances
Constructors
| StateAPI | |
Fields
| |