Safe Haskell	None
Language	Haskell2010

Avers.API

Synopsis

type AversAPI = CreateObject :<|> (LookupObject :<|> (PatchObject :<|> (DeleteObject :<|> (LookupPatch :<|> (ObjectChanges :<|> (CreateRelease :<|> (LookupRelease :<|> (LookupLatestRelease :<|> (Feed :<|> (ChangeSecret :<|> (CreateSession :<|> (LookupSession :<|> (DeleteSession :<|> (UploadBlob :<|> (LookupBlob :<|> LookupBlobContent)))))))))))))))
type CreateObject = "objects" :> (Credentials :> (ReqBody '[JSON] CreateObjectBody :> Post '[JSON] CreateObjectResponse))
type LookupObject = "objects" :> (Capture "objId" ObjId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupObjectResponse))))
type PatchObject = "objects" :> (Capture "objId" ObjId :> (Credentials :> (ReqBody '[JSON] PatchObjectBody :> Patch '[JSON] PatchObjectResponse)))
type DeleteObject = "objects" :> (Capture "objId" ObjId :> (Credentials :> Delete '[JSON] ()))
type LookupPatch = "objects" :> (Capture "objId" ObjId :> ("patches" :> (Capture "revId" RevId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupPatchResponse))))))
type ObjectChanges = "objects" :> (Capture "objId" ObjId :> ("changes" :> (Credentials :> Raw)))
type CreateRelease = "objects" :> (Capture "objId" ObjId :> ("releases" :> (Credentials :> (ReqBody '[JSON] CreateReleaseBody :> Post '[JSON] CreateReleaseResponse))))
type LookupRelease = "objects" :> (Capture "objId" ObjId :> ("releases" :> (Capture "revId" RevId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupReleaseResponse))))))
type LookupLatestRelease = "objects" :> (Capture "objId" ObjId :> ("releases" :> ("_latest" :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupLatestReleaseResponse))))))
type Feed = "feed" :> (Credentials :> Raw)
type ChangeSecret = "secret" :> (Credentials :> (ReqBody '[JSON] ChangeSecretBody :> Post '[JSON] ()))
type CreateSession = "session" :> (ReqBody '[JSON] CreateSessionBody :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie] CreateSessionResponse))
type LookupSession = "session" :> (SessionId :> Get '[JSON] (Headers '[Header "Set-Cookie" SetCookie] LookupSessionResponse))
type DeleteSession = "session" :> (SessionId :> Delete '[JSON] (Headers '[Header "Set-Cookie" SetCookie] ()))
type UploadBlob = "blobs" :> (Credentials :> (Header "Content-Type" Text :> (ReqBody '[OctetStream] BlobContent :> Post '[JSON] UploadBlobResponse)))
type LookupBlob = "blobs" :> (Capture "blobId" BlobId :> (Credentials :> Get '[JSON] LookupBlobResponse))
type LookupBlobContent = "blobs" :> (Capture "blobId" BlobId :> ("content" :> (Credentials :> Get '[OctetStream] (Headers '[Header "Content-Type" Text] BlobContent))))
type CacheValidationToken = Header "If-None-Match" Text
type Cacheable a = Headers '[Header "Cache-Control" Text, Header "ETag" Text] a
data CreateObjectBody = CreateObjectBody {
- cobType :: !Text
- cobContent :: !Value
}
data CreateObjectResponse = CreateObjectResponse {
- corId :: !ObjId
- corType :: !Text
- corContent :: !Value
}
data LookupObjectResponse = LookupObjectResponse {
- lorId :: !ObjId
- lorType :: !Text
- lorCreatedAt :: !UTCTime
- lorCreatedBy :: !ObjId
- lorRevisionId :: !RevId
- lorContent :: !Value
}
data PatchObjectBody = PatchObjectBody {
- pobRevisionId :: !RevId
- pobOperations :: ![Operation]
}
data PatchObjectResponse = PatchObjectResponse {
- porPreviousPatches :: ![Patch]
- porNumProcessedOperations :: !Int
- porResultingPatches :: ![Patch]
}
data ObjectChangeNotification = PatchNotification !Patch
type LookupPatchResponse = Patch
data CreateReleaseBody = CreateReleaseBody {
}
data CreateReleaseResponse = CreateReleaseResponse {
}
data LookupReleaseResponse = LookupReleaseResponse {
}
data LookupLatestReleaseResponse = LookupLatestReleaseResponse {
}
data CreateSessionBody = CreateSessionBody {
- csbLogin :: !SecretId
- csbSecret :: !Text
}
data CreateSessionResponse = CreateSessionResponse {
- csrSessionId :: !SessionId
- csrSessionObjId :: !ObjId
}
data LookupSessionResponse = LookupSessionResponse {
- lsrSessionId :: !SessionId
- lsrSessionObjId :: !ObjId
}
data ChangeFeedSubscription = IncludeObjectChanges ObjId
data ChangeSecretBody = ChangeSecretBody {
- csbNewSecret :: !Text
}
newtype BlobContent = BlobContent ByteString
data UploadBlobResponse = UploadBlobResponse {
- ubrId :: !BlobId
- ubrSize :: !Int
- ubrContentType :: !Text
}
data LookupBlobResponse = LookupBlobResponse {
- lbrId :: !BlobId
- lbrSize :: !Int
- lbrContentType :: !Text
}
data Credentials
- = CredAnonymous
- | CredSessionId !SessionId

Documentation

The complete Avers API as a data type.

type CreateObject = "objects" :> (Credentials :> (ReqBody '[JSON] CreateObjectBody :> Post '[JSON] CreateObjectResponse)) #

The complete Avers API

type LookupObject = "objects" :> (Capture "objId" ObjId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupObjectResponse)))) #

type PatchObject = "objects" :> (Capture "objId" ObjId :> (Credentials :> (ReqBody '[JSON] PatchObjectBody :> Patch '[JSON] PatchObjectResponse))) #

type DeleteObject = "objects" :> (Capture "objId" ObjId :> (Credentials :> Delete '[JSON] ())) #

type LookupPatch = "objects" :> (Capture "objId" ObjId :> ("patches" :> (Capture "revId" RevId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupPatchResponse)))))) #

type ObjectChanges = "objects" :> (Capture "objId" ObjId :> ("changes" :> (Credentials :> Raw))) #

type CreateRelease = "objects" :> (Capture "objId" ObjId :> ("releases" :> (Credentials :> (ReqBody '[JSON] CreateReleaseBody :> Post '[JSON] CreateReleaseResponse)))) #

type LookupRelease = "objects" :> (Capture "objId" ObjId :> ("releases" :> (Capture "revId" RevId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupReleaseResponse)))))) #

type LookupLatestRelease = "objects" :> (Capture "objId" ObjId :> ("releases" :> ("_latest" :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupLatestReleaseResponse)))))) #

type Feed = "feed" :> (Credentials :> Raw) #

type ChangeSecret = "secret" :> (Credentials :> (ReqBody '[JSON] ChangeSecretBody :> Post '[JSON] ())) #

type CreateSession = "session" :> (ReqBody '[JSON] CreateSessionBody :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie] CreateSessionResponse)) #

type LookupSession = "session" :> (SessionId :> Get '[JSON] (Headers '[Header "Set-Cookie" SetCookie] LookupSessionResponse)) #

type DeleteSession = "session" :> (SessionId :> Delete '[JSON] (Headers '[Header "Set-Cookie" SetCookie] ())) #

type UploadBlob = "blobs" :> (Credentials :> (Header "Content-Type" Text :> (ReqBody '[OctetStream] BlobContent :> Post '[JSON] UploadBlobResponse))) #

type LookupBlob = "blobs" :> (Capture "blobId" BlobId :> (Credentials :> Get '[JSON] LookupBlobResponse)) #

type LookupBlobContent = "blobs" :> (Capture "blobId" BlobId :> ("content" :> (Credentials :> Get '[OctetStream] (Headers '[Header "Content-Type" Text] BlobContent)))) #

type CacheValidationToken = Header "If-None-Match" Text #

The cache validator token when passed in the request. The server will use it to determine if the cached response on the client can be reused or not.

type Cacheable a = Headers '[Header "Cache-Control" Text, Header "ETag" Text] a #

Includes Cache-Control and ETag headers in the response to mark it as cacheable by the client.

data CreateObjectBody #

Constructors

CreateObjectBody
Fields cobType :: !Text cobContent :: !Value

Instances

Generic CreateObjectBody #
Instance details Defined in Avers.API.Types Associated Types type Rep CreateObjectBody :: Type -> Type # Methods from :: CreateObjectBody -> Rep CreateObjectBody x # to :: Rep CreateObjectBody x -> CreateObjectBody #
FromJSON CreateObjectBody #
Instance details Defined in Avers.API.Types Methods parseJSON :: Value -> Parser CreateObjectBody # parseJSONList :: Value -> Parser [CreateObjectBody] #
type Rep CreateObjectBody #
Instance details Defined in Avers.API.Types type Rep CreateObjectBody = D1 (MetaData "CreateObjectBody" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "CreateObjectBody" PrefixI True) (S1 (MetaSel (Just "cobType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "cobContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Value)))

data CreateObjectResponse #

Constructors

CreateObjectResponse
Fields corId :: !ObjId corType :: !Text corContent :: !Value

Instances

Generic CreateObjectResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep CreateObjectResponse :: Type -> Type # Methods from :: CreateObjectResponse -> Rep CreateObjectResponse x # to :: Rep CreateObjectResponse x -> CreateObjectResponse #
ToJSON CreateObjectResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: CreateObjectResponse -> Value # toEncoding :: CreateObjectResponse -> Encoding # toJSONList :: [CreateObjectResponse] -> Value # toEncodingList :: [CreateObjectResponse] -> Encoding #
type Rep CreateObjectResponse #
Instance details Defined in Avers.API.Types type Rep CreateObjectResponse = D1 (MetaData "CreateObjectResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "CreateObjectResponse" PrefixI True) (S1 (MetaSel (Just "corId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId) :: (S1 (MetaSel (Just "corType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "corContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Value))))

data LookupObjectResponse #

Constructors

LookupObjectResponse
Fields lorId :: !ObjId lorType :: !Text lorCreatedAt :: !UTCTime lorCreatedBy :: !ObjId lorRevisionId :: !RevId lorContent :: !Value

Instances

Generic LookupObjectResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep LookupObjectResponse :: Type -> Type # Methods from :: LookupObjectResponse -> Rep LookupObjectResponse x # to :: Rep LookupObjectResponse x -> LookupObjectResponse #
ToJSON LookupObjectResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: LookupObjectResponse -> Value # toEncoding :: LookupObjectResponse -> Encoding # toJSONList :: [LookupObjectResponse] -> Value # toEncodingList :: [LookupObjectResponse] -> Encoding #
type Rep LookupObjectResponse #
Instance details Defined in Avers.API.Types type Rep LookupObjectResponse = D1 (MetaData "LookupObjectResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "LookupObjectResponse" PrefixI True) ((S1 (MetaSel (Just "lorId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId) :: (S1 (MetaSel (Just "lorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "lorCreatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UTCTime))) :: (S1 (MetaSel (Just "lorCreatedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId) :: (S1 (MetaSel (Just "lorRevisionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RevId) :*: S1 (MetaSel (Just "lorContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Value)))))

data PatchObjectBody #

Constructors

PatchObjectBody
Fields pobRevisionId :: !RevId The `RevId` against which the client created the operations. This may be a bit behind if some other client submitted patches in parallel. pobOperations :: ![Operation] The operations which the client wants to store in the database.

Instances

Generic PatchObjectBody #
Instance details Defined in Avers.API.Types Associated Types type Rep PatchObjectBody :: Type -> Type # Methods from :: PatchObjectBody -> Rep PatchObjectBody x # to :: Rep PatchObjectBody x -> PatchObjectBody #
FromJSON PatchObjectBody #
Instance details Defined in Avers.API.Types Methods parseJSON :: Value -> Parser PatchObjectBody # parseJSONList :: Value -> Parser [PatchObjectBody] #
type Rep PatchObjectBody #
Instance details Defined in Avers.API.Types type Rep PatchObjectBody = D1 (MetaData "PatchObjectBody" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "PatchObjectBody" PrefixI True) (S1 (MetaSel (Just "pobRevisionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RevId) :*: S1 (MetaSel (Just "pobOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Operation])))

data PatchObjectResponse #

Constructors

PatchObjectResponse

Fields

porPreviousPatches :: ![Patch]
Patches which were already in the database. The submitted ops were rebased on top of these.
porNumProcessedOperations :: !Int
The number of operations which were processed. This may be smaller than the number of submitted ops if the processing failed somewhere in the middle. The client can then decide what to do with those which were not accepted.
porResultingPatches :: ![Patch]
Out of the submitted operations, these are the patches which were actually applied and stored in the database. This list may be shorter if some operations were dropped (because redundant or conflicting).

Instances

Generic PatchObjectResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep PatchObjectResponse :: Type -> Type # Methods from :: PatchObjectResponse -> Rep PatchObjectResponse x # to :: Rep PatchObjectResponse x -> PatchObjectResponse #
ToJSON PatchObjectResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: PatchObjectResponse -> Value # toEncoding :: PatchObjectResponse -> Encoding # toJSONList :: [PatchObjectResponse] -> Value # toEncodingList :: [PatchObjectResponse] -> Encoding #
type Rep PatchObjectResponse #
Instance details Defined in Avers.API.Types type Rep PatchObjectResponse = D1 (MetaData "PatchObjectResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "PatchObjectResponse" PrefixI True) (S1 (MetaSel (Just "porPreviousPatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Patch]) :: (S1 (MetaSel (Just "porNumProcessedOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: S1 (MetaSel (Just "porResultingPatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Patch]))))

data ObjectChangeNotification #

Constructors

PatchNotification !Patch

A new patch was created.

Instances

Generic ObjectChangeNotification #
Instance details Defined in Avers.API.Types Associated Types type Rep ObjectChangeNotification :: Type -> Type # Methods from :: ObjectChangeNotification -> Rep ObjectChangeNotification x # to :: Rep ObjectChangeNotification x -> ObjectChangeNotification #
ToJSON ObjectChangeNotification #
Instance details Defined in Avers.API.Types Methods toJSON :: ObjectChangeNotification -> Value # toEncoding :: ObjectChangeNotification -> Encoding # toJSONList :: [ObjectChangeNotification] -> Value # toEncodingList :: [ObjectChangeNotification] -> Encoding #
type Rep ObjectChangeNotification #
Instance details Defined in Avers.API.Types type Rep ObjectChangeNotification = D1 (MetaData "ObjectChangeNotification" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "PatchNotification" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Patch)))

type LookupPatchResponse = Patch #

data CreateReleaseBody #

Constructors

CreateReleaseBody

Instances

Generic CreateReleaseBody #
Instance details Defined in Avers.API.Types Associated Types type Rep CreateReleaseBody :: Type -> Type # Methods from :: CreateReleaseBody -> Rep CreateReleaseBody x # to :: Rep CreateReleaseBody x -> CreateReleaseBody #
FromJSON CreateReleaseBody #
Instance details Defined in Avers.API.Types Methods parseJSON :: Value -> Parser CreateReleaseBody # parseJSONList :: Value -> Parser [CreateReleaseBody] #
type Rep CreateReleaseBody #
Instance details Defined in Avers.API.Types type Rep CreateReleaseBody = D1 (MetaData "CreateReleaseBody" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "CreateReleaseBody" PrefixI False) (U1 :: Type -> Type))

data CreateReleaseResponse #

Constructors

CreateReleaseResponse

Instances

Generic CreateReleaseResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep CreateReleaseResponse :: Type -> Type # Methods from :: CreateReleaseResponse -> Rep CreateReleaseResponse x # to :: Rep CreateReleaseResponse x -> CreateReleaseResponse #
ToJSON CreateReleaseResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: CreateReleaseResponse -> Value # toEncoding :: CreateReleaseResponse -> Encoding # toJSONList :: [CreateReleaseResponse] -> Value # toEncodingList :: [CreateReleaseResponse] -> Encoding #
type Rep CreateReleaseResponse #
Instance details Defined in Avers.API.Types type Rep CreateReleaseResponse = D1 (MetaData "CreateReleaseResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "CreateReleaseResponse" PrefixI False) (U1 :: Type -> Type))

data LookupReleaseResponse #

Constructors

LookupReleaseResponse

Instances

Generic LookupReleaseResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep LookupReleaseResponse :: Type -> Type # Methods from :: LookupReleaseResponse -> Rep LookupReleaseResponse x # to :: Rep LookupReleaseResponse x -> LookupReleaseResponse #
ToJSON LookupReleaseResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: LookupReleaseResponse -> Value # toEncoding :: LookupReleaseResponse -> Encoding # toJSONList :: [LookupReleaseResponse] -> Value # toEncodingList :: [LookupReleaseResponse] -> Encoding #
type Rep LookupReleaseResponse #
Instance details Defined in Avers.API.Types type Rep LookupReleaseResponse = D1 (MetaData "LookupReleaseResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "LookupReleaseResponse" PrefixI False) (U1 :: Type -> Type))

data LookupLatestReleaseResponse #

Constructors

LookupLatestReleaseResponse

Instances

Generic LookupLatestReleaseResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep LookupLatestReleaseResponse :: Type -> Type # Methods from :: LookupLatestReleaseResponse -> Rep LookupLatestReleaseResponse x # to :: Rep LookupLatestReleaseResponse x -> LookupLatestReleaseResponse #
ToJSON LookupLatestReleaseResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: LookupLatestReleaseResponse -> Value # toEncoding :: LookupLatestReleaseResponse -> Encoding # toJSONList :: [LookupLatestReleaseResponse] -> Value # toEncodingList :: [LookupLatestReleaseResponse] -> Encoding #
type Rep LookupLatestReleaseResponse #
Instance details Defined in Avers.API.Types type Rep LookupLatestReleaseResponse = D1 (MetaData "LookupLatestReleaseResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "LookupLatestReleaseResponse" PrefixI False) (U1 :: Type -> Type))

data CreateSessionBody #

Constructors

CreateSessionBody
Fields csbLogin :: !SecretId csbSecret :: !Text

Instances

Generic CreateSessionBody #
Instance details Defined in Avers.API.Types Associated Types type Rep CreateSessionBody :: Type -> Type # Methods from :: CreateSessionBody -> Rep CreateSessionBody x # to :: Rep CreateSessionBody x -> CreateSessionBody #
FromJSON CreateSessionBody #
Instance details Defined in Avers.API.Types Methods parseJSON :: Value -> Parser CreateSessionBody # parseJSONList :: Value -> Parser [CreateSessionBody] #
type Rep CreateSessionBody #
Instance details Defined in Avers.API.Types type Rep CreateSessionBody = D1 (MetaData "CreateSessionBody" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "CreateSessionBody" PrefixI True) (S1 (MetaSel (Just "csbLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SecretId) :*: S1 (MetaSel (Just "csbSecret") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

data CreateSessionResponse #

Constructors

CreateSessionResponse
Fields csrSessionId :: !SessionId csrSessionObjId :: !ObjId

Instances

Generic CreateSessionResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep CreateSessionResponse :: Type -> Type # Methods from :: CreateSessionResponse -> Rep CreateSessionResponse x # to :: Rep CreateSessionResponse x -> CreateSessionResponse #
ToJSON CreateSessionResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: CreateSessionResponse -> Value # toEncoding :: CreateSessionResponse -> Encoding # toJSONList :: [CreateSessionResponse] -> Value # toEncodingList :: [CreateSessionResponse] -> Encoding #
type Rep CreateSessionResponse #
Instance details Defined in Avers.API.Types type Rep CreateSessionResponse = D1 (MetaData "CreateSessionResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "CreateSessionResponse" PrefixI True) (S1 (MetaSel (Just "csrSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SessionId) :*: S1 (MetaSel (Just "csrSessionObjId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId)))

data LookupSessionResponse #

Constructors

LookupSessionResponse
Fields lsrSessionId :: !SessionId lsrSessionObjId :: !ObjId

Instances

Generic LookupSessionResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep LookupSessionResponse :: Type -> Type # Methods from :: LookupSessionResponse -> Rep LookupSessionResponse x # to :: Rep LookupSessionResponse x -> LookupSessionResponse #
ToJSON LookupSessionResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: LookupSessionResponse -> Value # toEncoding :: LookupSessionResponse -> Encoding # toJSONList :: [LookupSessionResponse] -> Value # toEncodingList :: [LookupSessionResponse] -> Encoding #
type Rep LookupSessionResponse #
Instance details Defined in Avers.API.Types type Rep LookupSessionResponse = D1 (MetaData "LookupSessionResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "LookupSessionResponse" PrefixI True) (S1 (MetaSel (Just "lsrSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SessionId) :*: S1 (MetaSel (Just "lsrSessionObjId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId)))

data ChangeFeedSubscription #

Constructors

IncludeObjectChanges ObjId

Instances

FromJSON ChangeFeedSubscription #
Instance details Defined in Avers.API.Types Methods parseJSON :: Value -> Parser ChangeFeedSubscription # parseJSONList :: Value -> Parser [ChangeFeedSubscription] #

data ChangeSecretBody #

Constructors

ChangeSecretBody
Fields csbNewSecret :: !Text

Instances

Generic ChangeSecretBody #
Instance details Defined in Avers.API.Types Associated Types type Rep ChangeSecretBody :: Type -> Type # Methods from :: ChangeSecretBody -> Rep ChangeSecretBody x # to :: Rep ChangeSecretBody x -> ChangeSecretBody #
FromJSON ChangeSecretBody #
Instance details Defined in Avers.API.Types Methods parseJSON :: Value -> Parser ChangeSecretBody # parseJSONList :: Value -> Parser [ChangeSecretBody] #
type Rep ChangeSecretBody #
Instance details Defined in Avers.API.Types type Rep ChangeSecretBody = D1 (MetaData "ChangeSecretBody" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "ChangeSecretBody" PrefixI True) (S1 (MetaSel (Just "csbNewSecret") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

newtype BlobContent #

Constructors

BlobContent ByteString

Instances

MimeRender OctetStream BlobContent #
Instance details Defined in Avers.API.Types Methods mimeRender :: Proxy OctetStream -> BlobContent -> ByteString #
MimeUnrender OctetStream BlobContent #
Instance details Defined in Avers.API.Types Methods mimeUnrender :: Proxy OctetStream -> ByteString -> Either String BlobContent # mimeUnrenderWithType :: Proxy OctetStream -> MediaType -> ByteString -> Either String BlobContent #

data UploadBlobResponse #

Constructors

UploadBlobResponse
Fields ubrId :: !BlobId ubrSize :: !Int ubrContentType :: !Text

Instances

Generic UploadBlobResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep UploadBlobResponse :: Type -> Type # Methods from :: UploadBlobResponse -> Rep UploadBlobResponse x # to :: Rep UploadBlobResponse x -> UploadBlobResponse #
ToJSON UploadBlobResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: UploadBlobResponse -> Value # toEncoding :: UploadBlobResponse -> Encoding # toJSONList :: [UploadBlobResponse] -> Value # toEncodingList :: [UploadBlobResponse] -> Encoding #
type Rep UploadBlobResponse #
Instance details Defined in Avers.API.Types type Rep UploadBlobResponse = D1 (MetaData "UploadBlobResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "UploadBlobResponse" PrefixI True) (S1 (MetaSel (Just "ubrId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BlobId) :: (S1 (MetaSel (Just "ubrSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: S1 (MetaSel (Just "ubrContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

data LookupBlobResponse #

Constructors

LookupBlobResponse
Fields lbrId :: !BlobId lbrSize :: !Int lbrContentType :: !Text

Instances

Generic LookupBlobResponse #
Instance details Defined in Avers.API.Types Associated Types type Rep LookupBlobResponse :: Type -> Type # Methods from :: LookupBlobResponse -> Rep LookupBlobResponse x # to :: Rep LookupBlobResponse x -> LookupBlobResponse #
ToJSON LookupBlobResponse #
Instance details Defined in Avers.API.Types Methods toJSON :: LookupBlobResponse -> Value # toEncoding :: LookupBlobResponse -> Encoding # toJSONList :: [LookupBlobResponse] -> Value # toEncodingList :: [LookupBlobResponse] -> Encoding #
type Rep LookupBlobResponse #
Instance details Defined in Avers.API.Types type Rep LookupBlobResponse = D1 (MetaData "LookupBlobResponse" "Avers.API.Types" "avers-api-0.1.0-dY1Titi6yu6O8MG4uEAw5" False) (C1 (MetaCons "LookupBlobResponse" PrefixI True) (S1 (MetaSel (Just "lbrId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BlobId) :: (S1 (MetaSel (Just "lbrSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: S1 (MetaSel (Just "lbrContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

data Credentials #

Credentials are used to authenticate the client. It can be a SessionId (extracted from the session cookie).

Later we may add support for token based authentication. Then we extend this into a sumtype covering all the possible ways how credentials can be passed along with the request.

Constructors

CredAnonymous
CredSessionId !SessionId