some general cleanup preparing to make more additions

Author: VetSoftKeith

api/auditLog.go

@@ -5,13 +5,18 @@ import (
 	"net/http"
 )
 
+/* Whenever an admin action is performed on the API, an entry is added to the respective guild's audit log.
+You can specify the reason by attaching the X-Audit-Log-Reason request header.
+This header supports url encoded utf8 characters.
+*/
+
 type AuditLog struct {
-	AuditLogEntries []AuditLogEntry `json:"audit_log_entries"`
-	// GuildScheduledEvents []GuildScheduledEvent `json:"guild_scheduled_events"`
-	Integrations []Integration `json:"integrations"`
-	Threads      []Channel     `json:"threads"`
-	Users        []User        `json:"users"`
-	// Webhooks []Webhook `json:"webhooks"`
+	AuditLogEntries      []AuditLogEntry       `json:"audit_log_entries"`
+	GuildScheduledEvents []GuildScheduledEvent `json:"guild_scheduled_events"`
+	Integrations         []Integration         `json:"integrations"`
+	Threads              []Channel             `json:"threads"`
+	Users                []User                `json:"users"`
+	// TODO: Webhooks []Webhook `json:"webhooks"`
 }
 
 type AuditLogEntry struct {
@@ -20,8 +25,8 @@ type AuditLogEntry struct {
 	UserID     *Snowflake         `json:"user_id"`
 	ID         Snowflake          `json:"id"`
 	ActionType AuditLogEvent      `json:"action_type"`
-	Options    OptionalAuditEntry `json:"options"`
-	Reason     string             `json:"reason"`
+	Options    OptionalAuditEntry `json:"options,omitempty"`
+	Reason     string             `json:"reason,omitempty"`
 }
 
 type AuditLogEvent int

api/channel.go

@@ -67,6 +67,7 @@ const (
 
 type VideoQualityMode int
 
+//goland:noinspection GoUnusedConst
 const (
 	Auto VideoQualityMode = iota + 1
 	Full
@@ -106,6 +107,7 @@ type Message struct {
 
 type MessageType int
 
+//goland:noinspection GoUnusedConst,SpellCheckingInspection
 const (
 	Default MessageType = iota
 	RecipientAdd
@@ -126,9 +128,9 @@ const (
 	GuildDiscoveryGracePeriodInitialWarning
 	GuildDiscoveryGracePeriodFinalWarning
 	ThreadCreated
-	Reply                // only in API v8+
-	ChatInputCommand     // only in API v8+
-	ThreadStarterMessage // only in API v9+
+	Reply
+	ChatInputCommand
+	ThreadStarterMessage
 	GuildInviteReminder
 	ContextMenuCommand
 )
@@ -388,25 +390,18 @@ func (c *Channel) String() string {
 	switch c.Type {
 	case GuildText:
 		chanType = "GTC:"
-		break
 	case DM:
 		chanType = "DM:"
-		break
 	case GroupDM:
 		chanType = "GDM:"
-		break
 	case GuildNews:
 		chanType = "GNC:"
-		break
 	case GuildNewsThread:
 		chanType = "GNT:"
-		break
 	case GuildPublicThread:
 		chanType = "GPuT:"
-		break
 	case GuildPrivateThread:
 		chanType = "GPrT:"
-		break
 	}
 
 	return chanType + c.Name + "(" + c.ID.String() + ")"
@@ -463,7 +458,6 @@ func (c *Channel) ModifyChannel(dm *map[string]interface{}, guildChannel *map[st
 			Name: fmt.Sprintf("%v", (*dm)["name"]),
 			Icon: fmt.Sprintf("%v", (*dm)["icon"]),
 		}
-		break
 	case GuildPublicThread:
 		fallthrough
 	case GuildPrivateThread:
@@ -482,8 +476,6 @@ func (c *Channel) ModifyChannel(dm *map[string]interface{}, guildChannel *map[st
 			Name:     fmt.Sprintf("%v", (*dm)["name"]),
 			Archived: archived,
 		}
-		break
-
 	}
 
 	if c.Type == GroupDM {

api/rate_limits.go

@@ -1,7 +1,5 @@
 package api
 
-// Based upon DiscordGo <https://github.com/bwmarrin/discordgo>
-
 import (
 	"math"
 	"net/http"

api/rest.go

@@ -93,9 +93,9 @@ func (r *RateLimiter) requestWithLockedBucket(method, route, contentType string,
 		case <-ctx.Done():
 			switch ctx.Err() {
 			case context.DeadlineExceeded:
-				logging.Debugln(logging.LogPrefixDiscord, "context timeout exceeded")
+				logging.Traceln(logging.LogPrefixDiscord, "context timeout exceeded")
 			case context.Canceled:
-				logging.Debugln(logging.LogPrefixDiscord, "context cancelled; process complete")
+				logging.Traceln(logging.LogPrefixDiscord, "context cancelled; process complete")
 			}
 		}
 	}(ctx)