Skip to main content

utils.go

utils.go - Overview​

  1. Overview

This file defines utility functions and error variables used for authentication and authorization within the query service. It includes functions for validating invite requests, checking email validity, and role validation.

  1. Detailed Documentation

Constants​

  • ErrorEmptyRequest: Error indicating an empty request.
  • ErrorInvalidEmail: Error indicating an invalid email format.
  • ErrorInvalidRole: Error indicating an invalid role.
  • ErrorInvalidInviteToken: Error indicating an invalid invite token.
  • ErrorAskAdmin: Error to show when invite is needed.

Function: isValidRole​

  • Purpose: Checks if a given role is valid.
  • Parameters:
    • role (string): The role to validate.
  • Returns:
    • bool: true if the role is valid (Admin, Editor, or Viewer), false otherwise.

Function: validateInviteRequest​

  • Purpose: Validates an invite request.
  • Parameters:
    • req (*model.InviteRequest): A pointer to the invite request to validate.
  • Returns:
    • error: An error if the request is invalid, or nil if the request is valid. Possible errors include ErrorEmptyRequest, ErrorInvalidEmail, and ErrorInvalidRole.

Function: isValidEmail​

  • Purpose: Checks if a given email is valid.
  • Parameters:
    • email (string): The email to validate.
  • Returns:
    • bool: Returns true always, actual implementation is missing.

Include in Getting Started: NO