about summary refs log blame commit diff
path: root/src/API.hs
blob: caf42727db863956b1380027282c23d8c3578484 (plain) (tree)
1
2
3
4
5
6
7
8
9
                          
                              


                                                                                
                
                  
                 
 
                           

                                                                                
                                                       
                                                                 
 


                         
                                             

                                                    



                                                     



                         
                           



                                                     
                           


                                  
                  
                           
                                    
                                    

                      


                                                 
                                   
                      
                  
                           

                                      

                    
                           
                                  



                                                  
                                                                               


                                                                              



                                                      



                                                 
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE TypeOperators #-}
--------------------------------------------------------------------------------
module API where
--------------------------------------------------------------------------------
import Data.Text
import Servant.API
import Web.Cookie

import qualified Types as T
--------------------------------------------------------------------------------

-- | Once authenticated, users receive a SessionCookie.
type SessionCookie = Header' '[Required] "Cookie" T.SessionCookie

type API =
      -- accounts: Create
           "accounts"
           :> Header "Cookie" T.SessionCookie
           :> ReqBody '[JSON] T.CreateAccountRequest
           :> Post '[JSON] NoContent
      :<|> "verify"
           :> QueryParam' '[Required] "username" Text
           :> QueryParam' '[Required] "secret" Text
           :> Get '[JSON] NoContent
      -- accounts: Read
      -- accounts: Update
      -- accounts: Delete
      :<|> "accounts"
           :> SessionCookie
           :> QueryParam' '[Required] "username" Text
           :> Delete '[JSON] NoContent
      -- accounts: List
      :<|> "accounts"
           :> SessionCookie
           :> Get '[JSON] [T.User]

      -- trips: Create
      :<|> "trips"
           :> SessionCookie
           :> ReqBody '[JSON] T.Trip
           :> Post '[JSON] NoContent
      -- trips: Read
      -- trips: Update
      :<|> "trips"
           :> SessionCookie
           :> ReqBody '[JSON] T.UpdateTripRequest
           :> Put '[JSON] NoContent
      -- trips: Delete
      :<|> "trips"
           :> SessionCookie
           :> ReqBody '[JSON] T.TripPK
           :> Delete '[JSON] NoContent
      -- trips: List
      :<|> "trips"
           :> SessionCookie
           :> Get '[JSON] [T.Trip]

      -- Miscellaneous
      :<|> "login"
           :> ReqBody '[JSON] T.AccountCredentials
           :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie] T.Session)
      :<|> "logout"
           :> SessionCookie
           :> Get '[JSON] (Headers '[Header "Set-Cookie" SetCookie] NoContent)
      :<|> "unfreeze"
           :> SessionCookie
           :> ReqBody '[JSON] T.UnfreezeAccountRequest
           :> Post '[JSON] NoContent
      :<|> "invite"
           :> SessionCookie
           :> ReqBody '[JSON] T.InviteUserRequest
           :> Post '[JSON] NoContent