servant-auth-token-api 0.4.1.1 → 0.4.2.0
raw patch · 3 files changed
+15/−1 lines, 3 filesPVP: major bump suggested
API removals or changes: PVP suggests a major version bump
API changes (from Hackage documentation)
- Servant.API.Auth.Token: type AuthAPI = AuthSigninMethod :<|> (AuthSigninGetCodeMethod :<|> (AuthSigninPostCodeMethod :<|> (AuthTouchMethod :<|> (AuthTokenInfoMethod :<|> (AuthSignoutMethod :<|> (AuthSignupMethod :<|> (AuthUsersMethod :<|> (AuthGetUserMethod :<|> (AuthPatchUserMethod :<|> (AuthPutUserMethod :<|> (AuthDeleteUserMethod :<|> (AuthRestoreMethod :<|> (AuthGetSingleUseCodes :<|> (AuthGetGroupMethod :<|> (AuthPostGroupMethod :<|> (AuthPutGroupMethod :<|> (AuthPatchGroupMethod :<|> (AuthDeleteGroupMethod :<|> (AuthGroupsMethod :<|> (AuthCheckPermissionsMethod :<|> AuthGetUserIdMethod))))))))))))))))))))
+ Servant.API.Auth.Token: type AuthAPI = AuthSigninMethod :<|> (AuthSigninGetCodeMethod :<|> (AuthSigninPostCodeMethod :<|> (AuthTouchMethod :<|> (AuthTokenInfoMethod :<|> (AuthSignoutMethod :<|> (AuthSignupMethod :<|> (AuthUsersMethod :<|> (AuthGetUserMethod :<|> (AuthPatchUserMethod :<|> (AuthPutUserMethod :<|> (AuthDeleteUserMethod :<|> (AuthRestoreMethod :<|> (AuthGetSingleUseCodes :<|> (AuthGetGroupMethod :<|> (AuthPostGroupMethod :<|> (AuthPutGroupMethod :<|> (AuthPatchGroupMethod :<|> (AuthDeleteGroupMethod :<|> (AuthGroupsMethod :<|> (AuthCheckPermissionsMethod :<|> (AuthGetUserIdMethod :<|> AuthFindUserByLogin)))))))))))))))))))))
Files
- CHANGELOG.md +5/−0
- servant-auth-token-api.cabal +1/−1
- src/Servant/API/Auth/Token.hs +9/−0
CHANGELOG.md view
@@ -1,3 +1,8 @@+0.4.2.0+=======++* Add `AuthFindUserByLogin` endpoint.+ 0.4.1.0 =======
servant-auth-token-api.cabal view
@@ -1,5 +1,5 @@ name: servant-auth-token-api-version: 0.4.1.1+version: 0.4.2.0 synopsis: Servant based API for token based authorisation description: Please see README.md homepage: https://github.com/ncrashed/servant-auth-token-api#readme
src/Servant/API/Auth/Token.hs view
@@ -446,6 +446,7 @@ :<|> AuthGroupsMethod :<|> AuthCheckPermissionsMethod :<|> AuthGetUserIdMethod+ :<|> AuthFindUserByLogin -- | How to get a token, expire of 'Nothing' means -- some default value (server config).@@ -664,6 +665,13 @@ :> TokenHeader' '["auth-userid"] :> Get '[JSON] (OnlyId UserId) +-- | Allows to find user info by login, requires 'authInfoPerm' permission.+-- Throws 404 if cannot find account with such login.+type AuthFindUserByLogin = "auth" :> "user" :> "bylogin"+ :> QueryParam "login" Login+ :> TokenHeader' '["auth-info"]+ :> Get '[JSON] RespUserInfo+ -- | Proxy type for auth API, used to pass the type-level info into -- client/docs generation functions authAPI :: Proxy AuthAPI@@ -733,6 +741,7 @@ <> mkExtra (Proxy :: Proxy AuthGroupsMethod) "Get list of user groups, requires 'authInfoPerm' for token " <> mkExtra (Proxy :: Proxy AuthCheckPermissionsMethod) "Check persistence of passed permissions of the token, requires 'authCheckPerm' for token" <> mkExtra (Proxy :: Proxy AuthGetUserIdMethod) "Get ID of owner of specified token, requires 'authUserIdPerm'"+ <> mkExtra (Proxy :: Proxy AuthFindUserByLogin) "Find user info by login, requires 'authInfoPerm'" mkExtra p s = extraInfo p $ defAction & notes <>~ [ DocNote "Description" [s] ]