Update documentation

server/internal/auth/jwt.go

@@ -62,31 +62,17 @@ func NewJWTService(config JWTConfig) (JWTManager, error) {
 	return &jwtService{config: config}, nil
 }
 
-// GenerateAccessToken creates a new access token for a user
-// Parameters:
-// - userID: the ID of the user
-// - role: the role of the user
-// Returns the signed token string or an error
+// GenerateAccessToken creates a new access token for a user with the given userID and role
 func (s *jwtService) GenerateAccessToken(userID int, role string) (string, error) {
 	return s.generateToken(userID, role, AccessToken, s.config.AccessTokenExpiry)
 }
 
-// GenerateRefreshToken creates a new refresh token for a user
-// Parameters:
-// - userID: the ID of the user
-// - role: the role of the user
-// Returns the signed token string or an error
+// GenerateRefreshToken creates a new refresh token for a user with the given userID and role
 func (s *jwtService) GenerateRefreshToken(userID int, role string) (string, error) {
 	return s.generateToken(userID, role, RefreshToken, s.config.RefreshTokenExpiry)
 }
 
 // generateToken is an internal helper function that creates a new JWT token
-// Parameters:
-// - userID: the ID of the user
-// - role: the role of the user
-// - tokenType: the type of token (access or refresh)
-// - expiry: how long the token should be valid
-// Returns the signed token string or an error
 func (s *jwtService) generateToken(userID int, role string, tokenType TokenType, expiry time.Duration) (string, error) {
 	now := time.Now()
 
@@ -113,9 +99,6 @@ func (s *jwtService) generateToken(userID int, role string, tokenType TokenType,
 }
 
 // ValidateToken validates and parses a JWT token
-// Parameters:
-// - tokenString: the token to validate
-// Returns the token claims if valid, or an error if invalid
 func (s *jwtService) ValidateToken(tokenString string) (*Claims, error) {
 	token, err := jwt.ParseWithClaims(tokenString, &Claims{}, func(token *jwt.Token) (interface{}, error) {
 		// Validate the signing method
@@ -136,10 +119,7 @@ func (s *jwtService) ValidateToken(tokenString string) (*Claims, error) {
 	return nil, fmt.Errorf("invalid token claims")
 }
 
-// RefreshAccessToken creates a new access token using a refresh token
-// Parameters:
-// - refreshToken: the refresh token to use
-// Returns a new access token if the refresh token is valid, or an error
+// RefreshAccessToken creates a new access token using a refreshToken
 func (s *jwtService) RefreshAccessToken(refreshToken string) (string, error) {
 	claims, err := s.ValidateToken(refreshToken)
 	if err != nil {

server/internal/auth/middleware.go

@@ -13,10 +13,6 @@ type Middleware struct {
 }
 
 // NewMiddleware creates a new authentication middleware
-// Parameters:
-// - jwtManager: the JWT manager to use for token operations
-// Returns:
-// - *Middleware: the new middleware instance
 func NewMiddleware(jwtManager JWTManager) *Middleware {
 	return &Middleware{
 		jwtManager: jwtManager,
@@ -24,10 +20,6 @@ func NewMiddleware(jwtManager JWTManager) *Middleware {
 }
 
 // Authenticate middleware validates JWT tokens and sets user information in context
-// Parameters:
-// - next: the next handler to call
-// Returns:
-// - http.Handler: the handler function
 func (m *Middleware) Authenticate(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// Extract token from Authorization header
@@ -69,10 +61,6 @@ func (m *Middleware) Authenticate(next http.Handler) http.Handler {
 }
 
 // RequireRole returns a middleware that ensures the user has the required role
-// Parameters:
-// - role: the required role
-// Returns:
-// - func(http.Handler) http.Handler: the middleware function
 func (m *Middleware) RequireRole(role string) func(http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -92,10 +80,6 @@ func (m *Middleware) RequireRole(role string) func(http.Handler) http.Handler {
 }
 
 // RequireWorkspaceAccess returns a middleware that ensures the user has access to the workspace
-// Parameters:
-// - next: the next handler to call
-// Returns:
-// - http.Handler: the handler function
 func (m *Middleware) RequireWorkspaceAccess(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		ctx, ok := context.GetRequestContext(w, r)

server/internal/auth/session.go

@@ -15,10 +15,7 @@ type SessionService struct {
 	jwtManager JWTManager      // JWT Manager for token operations
 }
 
-// NewSessionService creates a new session service
-// Parameters:
-// - db: database connection
-// - jwtManager: JWT service for token operations
+// NewSessionService creates a new session service with the given database and JWT manager
 func NewSessionService(db db.SessionStore, jwtManager JWTManager) *SessionService {
 	return &SessionService{
 		db:         db,
@@ -26,14 +23,7 @@ func NewSessionService(db db.SessionStore, jwtManager JWTManager) *SessionServic
 	}
 }
 
-// CreateSession creates a new user session
-// Parameters:
-// - userID: the ID of the user
-// - role: the role of the user
-// Returns:
-// - session: the created session
-// - accessToken: a new access token
-// - error: any error that occurred
+// CreateSession creates a new user session for a user with the given userID and role
 func (s *SessionService) CreateSession(userID int, role string) (*models.Session, string, error) {
 	// Generate both access and refresh tokens
 	accessToken, err := s.jwtManager.GenerateAccessToken(userID, role)
@@ -69,12 +59,7 @@ func (s *SessionService) CreateSession(userID int, role string) (*models.Session
 	return session, accessToken, nil
 }
 
-// RefreshSession creates a new access token using a refresh token
-// Parameters:
-// - refreshToken: the refresh token to use
-// Returns:
-// - string: a new access token
-// - error: any error that occurred
+// RefreshSession creates a new access token using a refreshToken
 func (s *SessionService) RefreshSession(refreshToken string) (string, error) {
 	// Get session from database first
 	session, err := s.db.GetSessionByRefreshToken(refreshToken)
@@ -97,18 +82,12 @@ func (s *SessionService) RefreshSession(refreshToken string) (string, error) {
 	return s.jwtManager.GenerateAccessToken(claims.UserID, claims.Role)
 }
 
-// InvalidateSession removes a session from the database
-// Parameters:
-// - sessionID: the ID of the session to invalidate
-// Returns:
-// - error: any error that occurred
+// InvalidateSession removes a session with the given sessionID from the database
 func (s *SessionService) InvalidateSession(sessionID string) error {
 	return s.db.DeleteSession(sessionID)
 }
 
 // CleanExpiredSessions removes all expired sessions from the database
-// Returns:
-// - error: any error that occurred
 func (s *SessionService) CleanExpiredSessions() error {
 	return s.db.CleanExpiredSessions()
 }