wolfadex / elm-open-api / OpenApi.SecurityScheme

Corresponds to the Security Scheme Object in the OpenAPI specification.

Types


type SecurityScheme


type SecuritySchemeType
    = ApiKey ({ name : String, in_ : SecuritySchemeIn })
    | Http ({ scheme : String, bearerFormat : Maybe String })
    | MutualTls
    | Oauth2 ({ flows : OpenApi.OauthFlow.OauthFlows })
    | OpenIdConnect ({ openIdConnectUrl : String })


type SecuritySchemeIn
    = Query
    | Header
    | Cookie

Decoding / Encoding

decode : Json.Decode.Decoder SecurityScheme

encode : SecurityScheme -> Json.Encode.Value

Querying

description : SecurityScheme -> Maybe String

type_ : SecurityScheme -> SecuritySchemeType