Update graph API references and comments

Author: ShocOne

apihandlers/github/github_api_handler.go

@@ -0,0 +1,11 @@
+// github_api_handler.go
+package github
+
+import "github.com/deploymenttheory/go-api-http-client/logger"
+
+// GitHubHandler implements the APIHandler interface for the GitHub API.
+type GitHubAPIHandler struct {
+	OverrideBaseDomain string        // OverrideBaseDomain is used to override the base domain for URL construction.
+	InstanceName       string        // InstanceName is the name of the GitHub instance.
+	Logger             logger.Logger // Logger is the structured logger used for logging.
+}

apihandlers/github/github_api_handler_constants.go

@@ -0,0 +1,55 @@
+// github_handler_constants.go
+package github
+
+// Endpoint constants represent the URL suffixes used for GitHub token interactions.
+const (
+	APIName                            = "github"                                       // APIName: represents the name of the API.
+	DefaultBaseDomain                  = "api.github.com"                               // DefaultBaseDomain: represents the base domain for the github instance.
+	OAuthTokenEndpoint                 = "github.com/login/oauth/access_token"          // OAuthTokenEndpoint: The endpoint to obtain an OAuth token.
+	BearerTokenEndpoint                = ""                                             // BearerTokenEndpoint: The endpoint to obtain a bearer token.
+	TokenRefreshEndpoint               = "github.com/login/oauth/access_token"          // TokenRefreshEndpoint: The endpoint to refresh an existing token.
+	TokenInvalidateEndpoint            = "api.github.com/applications/:client_id/token" // TokenInvalidateEndpoint: The endpoint to invalidate an active token.
+	BearerTokenAuthenticationSupport   = false                                          // BearerTokenAuthSuppport: A boolean to indicate if the API supports bearer token authentication.
+	OAuthAuthenticationSupport         = true                                           // OAuthAuthSuppport: A boolean to indicate if the API supports OAuth authentication.
+	OAuthWithCertAuthenticationSupport = true                                           // OAuthWithCertAuthSuppport: A boolean to indicate if the API supports OAuth with client certificate authentication.
+)
+
+// GetDefaultBaseDomain returns the default base domain used for constructing API URLs to the http client.
+func (g *GitHubAPIHandler) GetDefaultBaseDomain() string {
+	return DefaultBaseDomain
+}
+
+// GetOAuthTokenEndpoint returns the endpoint for obtaining an OAuth token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetOAuthTokenEndpoint() string {
+	return OAuthTokenEndpoint
+}
+
+// GetBearerTokenEndpoint returns the endpoint for obtaining a bearer token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetBearerTokenEndpoint() string {
+	return BearerTokenEndpoint
+}
+
+// GetTokenRefreshEndpoint returns the endpoint for refreshing an existing token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetTokenRefreshEndpoint() string {
+	return TokenRefreshEndpoint
+}
+
+// GetTokenInvalidateEndpoint returns the endpoint for invalidating an active token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetTokenInvalidateEndpoint() string {
+	return TokenInvalidateEndpoint
+}
+
+// GetAPIBearerTokenAuthenticationSupportStatus returns a boolean indicating if bearer token authentication is supported in the api handler.
+func (g *GitHubAPIHandler) GetAPIBearerTokenAuthenticationSupportStatus() bool {
+	return BearerTokenAuthenticationSupport
+}
+
+// GetAPIOAuthAuthenticationSupportStatus returns a boolean indicating if OAuth authentication is supported in the api handler.
+func (g *GitHubAPIHandler) GetAPIOAuthAuthenticationSupportStatus() bool {
+	return OAuthAuthenticationSupport
+}
+
+// GetAPIOAuthWithCertAuthenticationSupportStatus returns a boolean indicating if OAuth with client certificate authentication is supported in the api handler.
+func (g *GitHubAPIHandler) GetAPIOAuthWithCertAuthenticationSupportStatus() bool {
+	return OAuthWithCertAuthenticationSupport
+}

apihandlers/graph/graph_api_exceptions.go

@@ -34,11 +34,11 @@ func init() {
 	// Load the default configuration from an embedded resource.
 	err := loadAPIExceptionsConfiguration()
 	if err != nil {
-		log.Fatalf("Error loading Jamf Pro API exceptions configuration: %s", err)
+		log.Fatalf("Error loading Microsoft Graph API exceptions configuration: %s", err)
 	}
 }
 
-// loadAPIExceptionsConfiguration reads and unmarshals the jamfpro_api_exceptions_configuration JSON data from an embedded file
+// loadAPIExceptionsConfiguration reads and unmarshals the graph_api_exceptions_configuration JSON data from an embedded file
 // into the configMap variable, which holds the exceptions configuration for endpoint-specific headers.
 func loadAPIExceptionsConfiguration() error {
 	// Unmarshal the embedded default configuration into the global configMap.

apihandlers/graph/graph_api_handler.go

@@ -3,9 +3,9 @@ package graph
 
 import "github.com/deploymenttheory/go-api-http-client/logger"
 
-// GraphAPIHandler implements the APIHandler interface for the Jamf Pro API.
+// GraphAPIHandler implements the APIHandler interface for the graph Pro API.
 type GraphAPIHandler struct {
 	OverrideBaseDomain string        // OverrideBaseDomain is used to override the base domain for URL construction.
-	InstanceName       string        // InstanceName is the name of the Jamf instance.
+	InstanceName       string        // InstanceName is the name of the graph instance.
 	Logger             logger.Logger // Logger is the structured logger used for logging.
 }

apihandlers/graph/graph_api_handler_constants.go

@@ -1,10 +1,10 @@
 // graph_api_handler_constants.go
 package graph
 
-// Endpoint constants represent the URL suffixes used for Jamf API token interactions.
+// Endpoint constants represent the URL suffixes used for graph API token interactions.
 const (
 	APIName                            = "microsoft graph"     // APIName: represents the name of the API.
-	DefaultBaseDomain                  = "graph.microsoft.com" // DefaultBaseDomain: represents the base domain for the jamf instance.
+	DefaultBaseDomain                  = "graph.microsoft.com" // DefaultBaseDomain: represents the base domain for the graph instance.
 	OAuthTokenEndpoint                 = "graph.microsoft.com" // OAuthTokenEndpoint: The endpoint to obtain an OAuth token.
 	BearerTokenEndpoint                = "graph.microsoft.com" // BearerTokenEndpoint: The endpoint to obtain a bearer token.
 	TokenRefreshEndpoint               = "graph.microsoft.com" // TokenRefreshEndpoint: The endpoint to refresh an existing token.

apihandlers/graph/graph_api_url.go

@@ -17,15 +17,15 @@ func (g *GraphAPIHandler) SetBaseDomain() string {
 	return DefaultBaseDomain
 }
 
-// ConstructAPIResourceEndpoint constructs the full URL for a Jamf API resource endpoint path and logs the URL.
+// ConstructAPIResourceEndpoint constructs the full URL for a graph API resource endpoint path and logs the URL.
 func (g *GraphAPIHandler) ConstructAPIResourceEndpoint(instanceName string, endpointPath string, log logger.Logger) string {
 	urlBaseDomain := g.SetBaseDomain()
 	url := fmt.Sprintf("https://%s%s%s", instanceName, urlBaseDomain, endpointPath)
 	g.Logger.Debug(fmt.Sprintf("Constructed %s API resource endpoint URL", APIName), zap.String("URL", url))
 	return url
 }
 
-// ConstructAPIAuthEndpoint constructs the full URL for a Jamf API auth endpoint path and logs the URL.
+// ConstructAPIAuthEndpoint constructs the full URL for a graph API auth endpoint path and logs the URL.
 func (g *GraphAPIHandler) ConstructAPIAuthEndpoint(instanceName string, endpointPath string, log logger.Logger) string {
 	urlBaseDomain := g.SetBaseDomain()
 	url := fmt.Sprintf("https://%s%s%s", instanceName, urlBaseDomain, endpointPath)

apihandlers/jamfpro/jamfpro_api_handler.go

@@ -1,3 +1,5 @@
+// jamfpro_api_handler.go
+
 package jamfpro
 
 import "github.com/deploymenttheory/go-api-http-client/logger"