Add some comments

Emyrk · Emyrk · commit b76f373ae1dc · 2022-05-03T12:37:47.000-05:00
diff --git a/coderd/httpmw/authorize.go b/coderd/httpmw/authorize.go
@@ -20,7 +20,7 @@ func Authorize(logger slog.Logger, auth *rbac.RegoAuthorizer, action rbac.Action
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
 			roles := UserRoles(r)
-			object := authObject(r)
+			object := rbacObject(r)
 
 			if object.Type == "" {
 				panic("developer error: auth object has no type")
@@ -72,7 +72,7 @@ func Authorize(logger slog.Logger, auth *rbac.RegoAuthorizer, action rbac.Action
 type authObjectKey struct{}
 
 // APIKey returns the API key from the ExtractAPIKey handler.
-func authObject(r *http.Request) rbac.Object {
+func rbacObject(r *http.Request) rbac.Object {
 	obj, ok := r.Context().Value(authObjectKey{}).(rbac.Object)
 	if !ok {
 		panic("developer error: auth object middleware not provided")
diff --git a/coderd/rbac/builtin.go b/coderd/rbac/builtin.go
@@ -146,9 +146,11 @@ func IsOrgRole(roleName string) (string, bool) {
 }
 
 // OrganizationRoles lists all roles that can be applied to an organization user
-// in the given organization.
+// in the given organization. This is the list of available roles,
+// and specific to an organization.
+//
 // This should be a list in a database, but until then we build
-// 	the list from the builtins.
+// the list from the builtins.
 func OrganizationRoles(organizationID uuid.UUID) []string {
 	var roles []string
 	for _, roleF := range builtInRoles {
@@ -166,8 +168,10 @@ func OrganizationRoles(organizationID uuid.UUID) []string {
 }
 
 // SiteRoles lists all roles that can be applied to a user.
+// This is the list of available roles, and not specific to a user
+//
 // This should be a list in a database, but until then we build
-// 	the list from the builtins.
+// the list from the builtins.
 func SiteRoles() []string {
 	var roles []string
 	for role := range builtInRoles {
