webgear-openapi-1.0.0: src/WebGear/OpenApi/Trait/Auth/Basic.hs

{-# OPTIONS_GHC -Wno-orphans #-}

-- | OpenApi implementation of 'BasicAuth'' trait.
module WebGear.OpenApi.Trait.Auth.Basic where

import Data.OpenApi
import Data.Proxy (Proxy (..))
import Data.String (fromString)
import GHC.TypeLits (KnownSymbol, symbolVal)
import WebGear.Core.Request (Request)
import WebGear.Core.Trait (Attribute, Get (..), Linked, TraitAbsence (Absence))
import WebGear.Core.Trait.Auth.Basic (BasicAuth' (..))
import WebGear.OpenApi.Handler (DocNode (DocSecurityScheme), OpenApiHandler (..), singletonNode)

instance (TraitAbsence (BasicAuth' x scheme m e a) Request, KnownSymbol scheme) => Get (OpenApiHandler m) (BasicAuth' x scheme m e a) Request where
  {-# INLINEABLE getTrait #-}
  getTrait ::
    BasicAuth' x scheme m e a ->
    OpenApiHandler m (Linked ts Request) (Either (Absence (BasicAuth' x scheme m e a) Request) (Attribute (BasicAuth' x scheme m e a) Request))
  getTrait _ =
    let schemeName = "http" <> fromString (symbolVal (Proxy @scheme))
        securityScheme =
          SecurityScheme
            { _securitySchemeType = SecuritySchemeHttp HttpSchemeBasic
            , _securitySchemeDescription = Nothing
            }
     in OpenApiHandler $ singletonNode (DocSecurityScheme schemeName securityScheme)