Safe Haskell	None
Language	Haskell2010

Hercules.API.State

Synopsis

newtype RawBytes = RawBytes {
- fromRawBytes :: ByteString
}
type ContentLength = Header "Content-Length" Integer
type ContentDisposition = Header "Content-Disposition" Text
data StateAPI auth f = StateAPI {
- putProjectStateData :: f :- (Summary "Upload a state file" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (StreamBody NoFraming OctetStream (SourceIO RawBytes) :> (auth :> Put '[JSON] NoContent))))))))
- getProjectStates :: f :- (Summary "List all state files" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("states" :> (auth :> Get '[JSON] ProjectState)))))
- getProjectStateData :: f :- (Summary "Download a state file" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (auth :> StreamGet NoFraming OctetStream (Headers '[ContentLength, ContentDisposition] (SourceIO RawBytes)))))))))
}

Documentation

newtype RawBytes Source #

A newtype wrapper for servant-swagger

Constructors

RawBytes
Fields fromRawBytes :: ByteString

Instances

Instances details

ToSchema RawBytes Source #
Instance details Defined in Hercules.API.State Methods declareNamedSchema :: Proxy RawBytes -> Declare (Definitions Schema) NamedSchema #
MimeRender OctetStream RawBytes Source #
Instance details Defined in Hercules.API.State Methods mimeRender :: Proxy OctetStream -> RawBytes -> ByteString #
MimeUnrender OctetStream RawBytes Source #
Instance details 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 StateAPI auth f Source #

Constructors

StateAPI

Fields

putProjectStateData :: f :- (Summary "Upload a state file" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (StreamBody NoFraming OctetStream (SourceIO RawBytes) :> (auth :> Put '[JSON] NoContent))))))))
getProjectStates :: f :- (Summary "List all state files" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("states" :> (auth :> Get '[JSON] ProjectState)))))
getProjectStateData :: f :- (Summary "Download a state file" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (auth :> StreamGet NoFraming OctetStream (Headers '[ContentLength, ContentDisposition] (SourceIO RawBytes)))))))))

Instances

Instances details

Generic (StateAPI auth f) Source #
Instance details Defined in Hercules.API.State Associated Types type Rep (StateAPI auth f) :: Type -> Type # Methods from :: StateAPI auth f -> Rep (StateAPI auth f) x # to :: Rep (StateAPI auth f) x -> StateAPI auth f #
type Rep (StateAPI auth f) Source #
Instance details Defined in Hercules.API.State type Rep (StateAPI auth f) = D1 ('MetaData "StateAPI" "Hercules.API.State" "hercules-ci-api-0.6.0.1-L0iUsBHZSJOKN1YKeFqdwV" 'False) (C1 ('MetaCons "StateAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "putProjectStateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Upload a state file" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (StreamBody NoFraming OctetStream (SourceIO RawBytes) :> (auth :> Put '[JSON] NoContent)))))))))) :: (S1 ('MetaSel ('Just "getProjectStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "List all state files" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("states" :> (auth :> Get '[JSON] ProjectState))))))) :: S1 ('MetaSel ('Just "getProjectStateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Download a state file" :> ("projects" :> (Capture' '[Required, Strict] "projectId" (Id Project) :> ("state" :> (Capture' '[Required, Strict] "stateName" Text :> ("data" :> (auth :> StreamGet NoFraming OctetStream (Headers '[ContentLength, ContentDisposition] (SourceIO RawBytes))))))))))))))