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