Avers.API

Documentation

type AversCoreAPI = ("objects" :> (Credentials :> (ReqBody '[JSON] CreateObjectBody :> Post '[JSON] CreateObjectResponse))) :<|> (("objects" :> (Capture "objId" ObjId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupObjectResponse))))) :<|> (("objects" :> (Capture "objId" ObjId :> (Credentials :> (ReqBody '[JSON] PatchObjectBody :> Patch '[JSON] PatchObjectResponse)))) :<|> (("objects" :> (Capture "objId" ObjId :> (Credentials :> Delete '[JSON] ()))) :<|> (("objects" :> (Capture "objId" ObjId :> ("patches" :> (Capture "revId" RevId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupPatchResponse))))))) :<|> (("objects" :> (Capture "objId" ObjId :> ("changes" :> (Credentials :> Raw)))) :<|> (("objects" :> (Capture "objId" ObjId :> ("releases" :> (Credentials :> (ReqBody '[JSON] CreateReleaseBody :> Post '[JSON] CreateReleaseResponse))))) :<|> (("objects" :> (Capture "objId" ObjId :> ("releases" :> (Capture "revId" RevId :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupReleaseResponse))))))) :<|> (("objects" :> (Capture "objId" ObjId :> ("releases" :> ("_latest" :> (Credentials :> (CacheValidationToken :> Get '[JSON] (Cacheable LookupLatestReleaseResponse))))))) :<|> (("feed" :> (Credentials :> Raw)) :<|> ("secret" :> (Credentials :> (ReqBody '[JSON] ChangeSecretBody :> Post '[] ()))))))))))))

The Core API to manipulate objects, patches, releases etc.

type AversSessionAPI = ("session" :> (ReqBody '[JSON] CreateSessionBody :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie] CreateSessionResponse))) :<|> (("session" :> (SessionId :> Get '[JSON] (Headers '[Header "Set-Cookie" SetCookie] LookupSessionResponse))) :<|> ("session" :> (SessionId :> Delete '[JSON] (Headers '[Header "Set-Cookie" SetCookie] ()))))

API to create and maintain sessions. Also contains API to change the secret, which is part of the session code.

type AversBlobAPI = ("blobs" :> (Header "Content-Type" Text :> (ReqBody '[OctetStream] ByteString :> Post '[JSON] UploadBlobResponse))) :<|> (("blobs" :> (Capture "blobId" BlobId :> Get '[JSON] LookupBlobResponse)) :<|> ("blobs" :> (Capture "blobId" BlobId :> ("content" :> Get '[OctetStream] (Headers '[Header "Content-Type" Text] ByteString)))))

API to manange blobs

type AversAccountAPI = "signup" :> (ReqBody '[JSON] SignupBody :> Post '[JSON] SignupResponse)

API to manage accounts. These are optional and not really part of Avers, but many applications do have a concept of a user or account, some person which is using the API.

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

Associated Types

type Rep CreateObjectBody :: * -> *

Methods

from :: CreateObjectBody -> Rep CreateObjectBody x

to :: Rep CreateObjectBody x -> CreateObjectBody

FromJSON CreateObjectBody

Methods

parseJSON :: Value -> Parser CreateObjectBody

parseJSONList :: Value -> Parser [CreateObjectBody]

type Rep CreateObjectBody

type Rep CreateObjectBody = D1 (MetaData "CreateObjectBody" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "CreateObjectBody" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "cobType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "cobContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Value))))

data CreateObjectResponse

Constructors

CreateObjectResponse

Fields

• corId :: !ObjId
• corType :: !Text
• corContent :: !Value

Instances

Generic CreateObjectResponse

Associated Types

type Rep CreateObjectResponse :: * -> *

Methods

from :: CreateObjectResponse -> Rep CreateObjectResponse x

to :: Rep CreateObjectResponse x -> CreateObjectResponse

ToJSON CreateObjectResponse

Methods

toJSON :: CreateObjectResponse -> Value

toEncoding :: CreateObjectResponse -> Encoding

toJSONList :: [CreateObjectResponse] -> Value

toEncodingList :: [CreateObjectResponse] -> Encoding

type Rep CreateObjectResponse

type Rep CreateObjectResponse = D1 (MetaData "CreateObjectResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "CreateObjectResponse" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "corId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId)) ((:*:) (S1 (MetaSel (Just Symbol "corType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "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

Associated Types

type Rep LookupObjectResponse :: * -> *

Methods

from :: LookupObjectResponse -> Rep LookupObjectResponse x

to :: Rep LookupObjectResponse x -> LookupObjectResponse

ToJSON LookupObjectResponse

Methods

toJSON :: LookupObjectResponse -> Value

toEncoding :: LookupObjectResponse -> Encoding

toJSONList :: [LookupObjectResponse] -> Value

toEncodingList :: [LookupObjectResponse] -> Encoding

type Rep LookupObjectResponse

type Rep LookupObjectResponse = D1 (MetaData "LookupObjectResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "LookupObjectResponse" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "lorId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId)) ((:*:) (S1 (MetaSel (Just Symbol "lorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "lorCreatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UTCTime)))) ((:*:) (S1 (MetaSel (Just Symbol "lorCreatedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId)) ((:*:) (S1 (MetaSel (Just Symbol "lorRevisionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RevId)) (S1 (MetaSel (Just Symbol "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

Associated Types

type Rep PatchObjectBody :: * -> *

Methods

from :: PatchObjectBody -> Rep PatchObjectBody x

to :: Rep PatchObjectBody x -> PatchObjectBody

FromJSON PatchObjectBody

Methods

parseJSON :: Value -> Parser PatchObjectBody

parseJSONList :: Value -> Parser [PatchObjectBody]

type Rep PatchObjectBody

type Rep PatchObjectBody = D1 (MetaData "PatchObjectBody" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "PatchObjectBody" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "pobRevisionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RevId)) (S1 (MetaSel (Just Symbol "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

Associated Types

type Rep PatchObjectResponse :: * -> *

Methods

from :: PatchObjectResponse -> Rep PatchObjectResponse x

to :: Rep PatchObjectResponse x -> PatchObjectResponse

ToJSON PatchObjectResponse

Methods

toJSON :: PatchObjectResponse -> Value

toEncoding :: PatchObjectResponse -> Encoding

toJSONList :: [PatchObjectResponse] -> Value

toEncodingList :: [PatchObjectResponse] -> Encoding

type Rep PatchObjectResponse

type Rep PatchObjectResponse = D1 (MetaData "PatchObjectResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "PatchObjectResponse" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "porPreviousPatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Patch])) ((:*:) (S1 (MetaSel (Just Symbol "porNumProcessedOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "porResultingPatches") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Patch])))))

data ObjectChangeNotification

Constructors

PatchNotification !Patch

A new patch was created.

Instances

Generic ObjectChangeNotification

Associated Types

type Rep ObjectChangeNotification :: * -> *

Methods

from :: ObjectChangeNotification -> Rep ObjectChangeNotification x

to :: Rep ObjectChangeNotification x -> ObjectChangeNotification

ToJSON ObjectChangeNotification

Methods

toJSON :: ObjectChangeNotification -> Value

toEncoding :: ObjectChangeNotification -> Encoding

toJSONList :: [ObjectChangeNotification] -> Value

toEncodingList :: [ObjectChangeNotification] -> Encoding

type Rep ObjectChangeNotification

type Rep ObjectChangeNotification = D1 (MetaData "ObjectChangeNotification" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "PatchNotification" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Patch)))

type LookupPatchResponse = Patch

data CreateReleaseBody

Constructors

CreateReleaseBody

Instances

Generic CreateReleaseBody

Associated Types

type Rep CreateReleaseBody :: * -> *

Methods

from :: CreateReleaseBody -> Rep CreateReleaseBody x

to :: Rep CreateReleaseBody x -> CreateReleaseBody

FromJSON CreateReleaseBody

Methods

parseJSON :: Value -> Parser CreateReleaseBody

parseJSONList :: Value -> Parser [CreateReleaseBody]

type Rep CreateReleaseBody

type Rep CreateReleaseBody = D1 (MetaData "CreateReleaseBody" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "CreateReleaseBody" PrefixI False) U1)

data CreateReleaseResponse

Constructors

CreateReleaseResponse

Instances

Generic CreateReleaseResponse

Associated Types

type Rep CreateReleaseResponse :: * -> *

Methods

from :: CreateReleaseResponse -> Rep CreateReleaseResponse x

to :: Rep CreateReleaseResponse x -> CreateReleaseResponse

ToJSON CreateReleaseResponse

Methods

toJSON :: CreateReleaseResponse -> Value

toEncoding :: CreateReleaseResponse -> Encoding

toJSONList :: [CreateReleaseResponse] -> Value

toEncodingList :: [CreateReleaseResponse] -> Encoding

type Rep CreateReleaseResponse

type Rep CreateReleaseResponse = D1 (MetaData "CreateReleaseResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "CreateReleaseResponse" PrefixI False) U1)

data LookupReleaseResponse

Constructors

LookupReleaseResponse

Instances

Generic LookupReleaseResponse

Associated Types

type Rep LookupReleaseResponse :: * -> *

Methods

from :: LookupReleaseResponse -> Rep LookupReleaseResponse x

to :: Rep LookupReleaseResponse x -> LookupReleaseResponse

ToJSON LookupReleaseResponse

Methods

toJSON :: LookupReleaseResponse -> Value

toEncoding :: LookupReleaseResponse -> Encoding

toJSONList :: [LookupReleaseResponse] -> Value

toEncodingList :: [LookupReleaseResponse] -> Encoding

type Rep LookupReleaseResponse

type Rep LookupReleaseResponse = D1 (MetaData "LookupReleaseResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "LookupReleaseResponse" PrefixI False) U1)

data LookupLatestReleaseResponse

Constructors

LookupLatestReleaseResponse

Instances

Generic LookupLatestReleaseResponse

Associated Types

type Rep LookupLatestReleaseResponse :: * -> *

Methods

from :: LookupLatestReleaseResponse -> Rep LookupLatestReleaseResponse x

to :: Rep LookupLatestReleaseResponse x -> LookupLatestReleaseResponse

ToJSON LookupLatestReleaseResponse

Methods

toJSON :: LookupLatestReleaseResponse -> Value

toEncoding :: LookupLatestReleaseResponse -> Encoding

toJSONList :: [LookupLatestReleaseResponse] -> Value

toEncodingList :: [LookupLatestReleaseResponse] -> Encoding

type Rep LookupLatestReleaseResponse

type Rep LookupLatestReleaseResponse = D1 (MetaData "LookupLatestReleaseResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "LookupLatestReleaseResponse" PrefixI False) U1)

data CreateSessionBody

Constructors

CreateSessionBody

Fields

• csbLogin :: !SecretId
• csbSecret :: !Text

Instances

Generic CreateSessionBody

Associated Types

type Rep CreateSessionBody :: * -> *

Methods

from :: CreateSessionBody -> Rep CreateSessionBody x

to :: Rep CreateSessionBody x -> CreateSessionBody

FromJSON CreateSessionBody

Methods

parseJSON :: Value -> Parser CreateSessionBody

parseJSONList :: Value -> Parser [CreateSessionBody]

type Rep CreateSessionBody

type Rep CreateSessionBody = D1 (MetaData "CreateSessionBody" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "CreateSessionBody" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "csbLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SecretId)) (S1 (MetaSel (Just Symbol "csbSecret") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

data CreateSessionResponse

Constructors

CreateSessionResponse

Fields

• csrSessionId :: !SessionId
• csrSessionObjId :: !ObjId

Instances

Generic CreateSessionResponse

Associated Types

type Rep CreateSessionResponse :: * -> *

Methods

from :: CreateSessionResponse -> Rep CreateSessionResponse x

to :: Rep CreateSessionResponse x -> CreateSessionResponse

ToJSON CreateSessionResponse

Methods

toJSON :: CreateSessionResponse -> Value

toEncoding :: CreateSessionResponse -> Encoding

toJSONList :: [CreateSessionResponse] -> Value

toEncodingList :: [CreateSessionResponse] -> Encoding

type Rep CreateSessionResponse

type Rep CreateSessionResponse = D1 (MetaData "CreateSessionResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "CreateSessionResponse" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "csrSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SessionId)) (S1 (MetaSel (Just Symbol "csrSessionObjId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId))))

data LookupSessionResponse

Constructors

LookupSessionResponse

Fields

• lsrSessionId :: !SessionId
• lsrSessionObjId :: !ObjId

Instances

Generic LookupSessionResponse

Associated Types

type Rep LookupSessionResponse :: * -> *

Methods

from :: LookupSessionResponse -> Rep LookupSessionResponse x

to :: Rep LookupSessionResponse x -> LookupSessionResponse

ToJSON LookupSessionResponse

Methods

toJSON :: LookupSessionResponse -> Value

toEncoding :: LookupSessionResponse -> Encoding

toJSONList :: [LookupSessionResponse] -> Value

toEncodingList :: [LookupSessionResponse] -> Encoding

type Rep LookupSessionResponse

type Rep LookupSessionResponse = D1 (MetaData "LookupSessionResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "LookupSessionResponse" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "lsrSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SessionId)) (S1 (MetaSel (Just Symbol "lsrSessionObjId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ObjId))))

data ChangeFeedSubscription

Constructors

IncludeObjectChanges ObjId

Instances

FromJSON ChangeFeedSubscription

Methods

parseJSON :: Value -> Parser ChangeFeedSubscription

parseJSONList :: Value -> Parser [ChangeFeedSubscription]

data ChangeSecretBody

Constructors

ChangeSecretBody

Fields

• csbNewSecret :: !Text

Instances

Generic ChangeSecretBody

Associated Types

type Rep ChangeSecretBody :: * -> *

Methods

from :: ChangeSecretBody -> Rep ChangeSecretBody x

to :: Rep ChangeSecretBody x -> ChangeSecretBody

FromJSON ChangeSecretBody

Methods

parseJSON :: Value -> Parser ChangeSecretBody

parseJSONList :: Value -> Parser [ChangeSecretBody]

type Rep ChangeSecretBody

type Rep ChangeSecretBody = D1 (MetaData "ChangeSecretBody" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "ChangeSecretBody" PrefixI True) (S1 (MetaSel (Just Symbol "csbNewSecret") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

data UploadBlobResponse

Constructors

UploadBlobResponse

Instances

Generic UploadBlobResponse

Associated Types

type Rep UploadBlobResponse :: * -> *

Methods

from :: UploadBlobResponse -> Rep UploadBlobResponse x

to :: Rep UploadBlobResponse x -> UploadBlobResponse

type Rep UploadBlobResponse

type Rep UploadBlobResponse = D1 (MetaData "UploadBlobResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "UploadBlobResponse" PrefixI False) U1)

data LookupBlobResponse

Constructors

LookupBlobResponse

Instances

Generic LookupBlobResponse

Associated Types

type Rep LookupBlobResponse :: * -> *

Methods

from :: LookupBlobResponse -> Rep LookupBlobResponse x

to :: Rep LookupBlobResponse x -> LookupBlobResponse

type Rep LookupBlobResponse

type Rep LookupBlobResponse = D1 (MetaData "LookupBlobResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "LookupBlobResponse" PrefixI False) U1)

data SignupBody

Constructors

SignupBody

Instances

Generic SignupBody

Associated Types

type Rep SignupBody :: * -> *

Methods

from :: SignupBody -> Rep SignupBody x

to :: Rep SignupBody x -> SignupBody

FromJSON SignupBody

Methods

parseJSON :: Value -> Parser SignupBody

parseJSONList :: Value -> Parser [SignupBody]

type Rep SignupBody

type Rep SignupBody = D1 (MetaData "SignupBody" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "SignupBody" PrefixI False) U1)

data SignupResponse

Constructors

SignupResponse

Instances

Generic SignupResponse

Associated Types

type Rep SignupResponse :: * -> *

Methods

from :: SignupResponse -> Rep SignupResponse x

to :: Rep SignupResponse x -> SignupResponse

ToJSON SignupResponse

Methods

toJSON :: SignupResponse -> Value

toEncoding :: SignupResponse -> Encoding

toJSONList :: [SignupResponse] -> Value

toEncodingList :: [SignupResponse] -> Encoding

type Rep SignupResponse

type Rep SignupResponse = D1 (MetaData "SignupResponse" "Avers.API.Types" "avers-api-0.0.5-KolJwYQYbYq2FjqIaDnV9w" False) (C1 (MetaCons "SignupResponse" PrefixI False) U1)

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

SessionIdCredential !SessionId