Safe Haskell	None
Language	Haskell2010

PostgREST.ApiRequest

Description

Synopsis

data ApiRequest = ApiRequest {
- iAction :: Action
- iRange :: HashMap ByteString NonnegRange
- iTopLevelRange :: NonnegRange
- iTarget :: Target
- iAccepts :: [ContentType]
- iPayload :: Maybe PayloadJSON
- iPreferRepresentation :: PreferRepresentation
- iPreferParameters :: Maybe PreferParameters
- iPreferCount :: Maybe PreferCount
- iPreferResolution :: Maybe PreferResolution
- iFilters :: [(Text, Text)]
- iLogic :: [(Text, Text)]
- iSelect :: Maybe Text
- iOnConflict :: Maybe Text
- iColumns :: Maybe Text
- iOrder :: [(Text, Text)]
- iCanonicalQS :: ByteString
- iJWT :: Text
- iHeaders :: [(Text, Text)]
- iCookies :: [(Text, Text)]
- iPath :: ByteString
- iMethod :: ByteString
- iProfile :: Maybe Schema
- iSchema :: Schema
}
data InvokeMethod
- = InvHead
- | InvGet
- | InvPost
data ContentType
- = CTApplicationJSON
- | CTSingularJSON
- | CTTextCSV
- | CTTextPlain
- | CTOpenAPI
- | CTOctetStream
- | CTAny
- | CTOther ByteString
data Action
- = ActionCreate
- | ActionRead {
  - isHead :: Bool
  }
- | ActionUpdate
- | ActionDelete
- | ActionSingleUpsert
- | ActionInvoke InvokeMethod
- | ActionInfo
- | ActionInspect {
  - isHead :: Bool
  }
data Target
- = TargetIdent QualifiedIdentifier
- | TargetProc {
  - tpQi :: QualifiedIdentifier
  - tpIsRootSpec :: Bool
  }
- | TargetDefaultSpec {
  - tdsSchema :: Schema
  }
- | TargetUnknown [Text]
mutuallyAgreeable :: [ContentType] -> [ContentType] -> Maybe ContentType
userApiRequest :: NonEmpty Schema -> Maybe Text -> Request -> RequestBody -> Either ApiRequestError ApiRequest

Documentation

data ApiRequest Source #

Describes what the user wants to do. This data type is a translation of the raw elements of an HTTP request into domain specific language. There is no guarantee that the intent is sensible, it is up to a later stage of processing to determine if it is an action we are able to perform.

Constructors

ApiRequest

Fields

iAction :: Action
Similar but not identical to HTTP verb, e.g. Create/Invoke both POST
iRange :: HashMap ByteString NonnegRange
Requested range of rows within response
iTopLevelRange :: NonnegRange
Requested range of rows from the top level
iTarget :: Target
The target, be it calling a proc or accessing a table
iAccepts :: [ContentType]
Content types the client will accept, [CTAny] if no Accept header
iPayload :: Maybe PayloadJSON
Data sent by client and used for mutation actions
iPreferRepresentation :: PreferRepresentation
If client wants created items echoed back
iPreferParameters :: Maybe PreferParameters
How to pass parameters to a stored procedure
iPreferCount :: Maybe PreferCount
Whether the client wants a result count
iPreferResolution :: Maybe PreferResolution
Whether the client wants to UPSERT or ignore records on PK conflict
iFilters :: [(Text, Text)]
Filters on the result ("id", "eq.10")
iLogic :: [(Text, Text)]
&and and &or parameters used for complex boolean logic
iSelect :: Maybe Text
&select parameter used to shape the response
iOnConflict :: Maybe Text
&on_conflict parameter used to upsert on specific unique keys
iColumns :: Maybe Text
&columns parameter used to shape the payload
iOrder :: [(Text, Text)]
&order parameters for each level
iCanonicalQS :: ByteString
Alphabetized (canonical) request query string for response URLs
iJWT :: Text
JSON Web Token
iHeaders :: [(Text, Text)]
HTTP request headers
iCookies :: [(Text, Text)]
Request Cookies
iPath :: ByteString
Raw request path
iMethod :: ByteString
Raw request method
iProfile :: Maybe Schema
The request profile for enabling use of multiple schemas. Follows the spec in hhttps:/www.w3.orgTRdx-prof-connegttps:/www.w3.orgTRdx-prof-conneg.
iSchema :: Schema
The request schema. Can vary depending on iProfile.

data InvokeMethod Source #

Constructors

InvHead
InvGet
InvPost

Instances

Eq InvokeMethod Source #
Instance details Defined in PostgREST.ApiRequest Methods (==) :: InvokeMethod -> InvokeMethod -> Bool # (/=) :: InvokeMethod -> InvokeMethod -> Bool #

data ContentType Source #

Enumeration of currently supported response content types

Constructors

CTApplicationJSON
CTSingularJSON
CTTextCSV
CTTextPlain
CTOpenAPI
CTOctetStream
CTAny
CTOther ByteString

Instances

Eq ContentType Source #
Instance details Defined in PostgREST.Types Methods (==) :: ContentType -> ContentType -> Bool # (/=) :: ContentType -> ContentType -> Bool #
Show ContentType Source #
Instance details Defined in PostgREST.Types Methods showsPrec :: Int -> ContentType -> ShowS # show :: ContentType -> String # showList :: [ContentType] -> ShowS #

data Action Source #

Types of things a user wants to do to tablesviewsprocs

Constructors

ActionCreate
ActionRead
Fields isHead :: Bool
ActionUpdate
ActionDelete
ActionSingleUpsert
ActionInvoke InvokeMethod
ActionInfo
ActionInspect
Fields isHead :: Bool

Instances

Eq Action Source #
Instance details Defined in PostgREST.ApiRequest Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #

data Target Source #

The target db object of a user action

Constructors

TargetIdent QualifiedIdentifier
TargetProc
Fields tpQi :: QualifiedIdentifier tpIsRootSpec :: Bool
TargetDefaultSpec
Fields tdsSchema :: Schema
TargetUnknown [Text]

Instances

Eq Target Source #
Instance details Defined in PostgREST.ApiRequest Methods (==) :: Target -> Target -> Bool # (/=) :: Target -> Target -> Bool #

mutuallyAgreeable :: [ContentType] -> [ContentType] -> Maybe ContentType Source #

Find the best match from a list of content types accepted by the client in order of decreasing preference and a list of types producible by the server. If there is no match but the client accepts */* then return the top server pick.

userApiRequest :: NonEmpty Schema -> Maybe Text -> Request -> RequestBody -> Either ApiRequestError ApiRequest Source #

Examines HTTP request and translates it into user intent.