Docs support

backend/src/API/Channels.hs

@@ -1,41 +1,47 @@
-{-# Language DataKinds #-}
-{-# Language TypeFamilies #-}
-{-# Language TypeOperators #-}
-{-# Language NoImplicitPrelude #-}
-{-# Language MultiParamTypeClasses #-}
-{-# Language OverloadedStrings #-}
-{-# Language TemplateHaskell #-}
-{-# Language QuasiQuotes #-}
-{-# Language RecordWildCards #-}
-{-# Language DeriveGeneric #-}
-{-# Language FlexibleInstances #-}
-{-# Language TypeApplications #-}
-{-# Language DataKinds #-}
-{-# Language DuplicateRecordFields #-}
-{-# Language NamedFieldPuns #-}
+{-# LANGUAGE DataKinds             #-}
+{-# LANGUAGE DeriveGeneric         #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE FlexibleInstances     #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE NamedFieldPuns        #-}
+{-# LANGUAGE NoImplicitPrelude     #-}
+{-# LANGUAGE OverloadedStrings     #-}
+{-# LANGUAGE QuasiQuotes           #-}
+{-# LANGUAGE RecordWildCards       #-}
+{-# LANGUAGE TemplateHaskell       #-}
+{-# LANGUAGE TypeApplications      #-}
+{-# LANGUAGE TypeFamilies          #-}
+{-# LANGUAGE TypeOperators         #-}
 module API.Channels (API, handler, JsonChannel(..)) where
 
-import ClassyPrelude
-import Control.Lens
-import Control.Monad.Catch (throwM, MonadThrow)
-import Control.Monad.Logger
-import Data.Aeson
-import Data.Generics.Product
-import Database
-import Database.Channel
-import Servant
-import Servant.Auth as SA
-import Server.Auth
-import Types
+import           ClassyPrelude
+import           Control.Lens
+import           Control.Monad.Catch   (MonadThrow, throwM)
+import           Control.Monad.Logger
+import           Data.Aeson
+import           Data.Generics.Product
+import           Database
+import           Database.Channel
+import           Servant
+import           Servant.Auth          as SA
+import qualified Servant.Docs          as Docs
+import           Server.Auth
+import           Types
 
-data JsonChannel = JsonChannel { channel :: Text
+data JsonChannel = JsonChannel { channel    :: Text
                                , visibility :: Visibility }
                  deriving (Show, Generic)
 data UpdateChannel = UpdateChannel { identifier :: ChannelID
-                                   , channel :: Text
+                                   , channel    :: Text
                                    , visibility :: Visibility }
                  deriving (Show, Generic)
 
+instance Docs.ToSample JsonChannel where
+  toSamples _ = [("Channel", JsonChannel "channel" Private)]
+
+instance Docs.ToSample UpdateChannel where
+  toSamples _ = [("Channel", UpdateChannel 13 "channel" Private)]
+
 instance ToJSON JsonChannel
 instance FromJSON JsonChannel
 instance ToJSON UpdateChannel
@@ -43,6 +49,9 @@ instance FromJSON UpdateChannel
 
 type API = Auth '[SA.BasicAuth, SA.Cookie, SA.JWT] SafeUser :> BaseAPI
 
+instance Docs.ToCapture (Capture "channel_id" ChannelID) where
+  toCapture _ = Docs.DocCapture "channel_id" "The channel id"
+
 type BaseAPI = "channels" :> ReqBody '[JSON] JsonChannel :> Post '[JSON] UpdateChannel
           :<|> "channels" :> Capture "channel_id" ChannelID :> ReqBody '[JSON] UpdateChannel :> Put '[JSON] UpdateChannel
           :<|> "channels" :> Get '[JSON] [JsonChannel]