add variable and method comments
This commit is contained in:
@@ -4,10 +4,13 @@ import (
|
||||
"go.equinixmetal.net/infra9-metal-bridge/internal/metal/models"
|
||||
)
|
||||
|
||||
// Roles contains a list of roles.
|
||||
type Roles []string
|
||||
|
||||
// Memberships contains a list of memberships
|
||||
type Memberships []*Membership
|
||||
|
||||
// ToDetailsWithOrganizationDetails convers the memberships to generic membership models with organization details.
|
||||
func (m Memberships) ToDetailsWithOrganizationDetails(orgDetails *models.OrganizationDetails) []*models.Membership[models.OrganizationDetails] {
|
||||
memberships := make([]*models.Membership[models.OrganizationDetails], len(m))
|
||||
|
||||
@@ -28,6 +31,7 @@ func (m Memberships) ToDetailsWithOrganizationDetails(orgDetails *models.Organiz
|
||||
return memberships
|
||||
}
|
||||
|
||||
// ToDetailsWithProjectDetails convers the memberships to generic membership models with project details.
|
||||
func (m Memberships) ToDetailsWithProjectDetails(projDetails *models.ProjectDetails) []*models.Membership[models.ProjectDetails] {
|
||||
memberships := make([]*models.Membership[models.ProjectDetails], len(m))
|
||||
|
||||
@@ -48,6 +52,7 @@ func (m Memberships) ToDetailsWithProjectDetails(projDetails *models.ProjectDeta
|
||||
return memberships
|
||||
}
|
||||
|
||||
// Membership contains membership information.
|
||||
type Membership struct {
|
||||
client *Client
|
||||
|
||||
@@ -57,6 +62,7 @@ type Membership struct {
|
||||
User *User `json:"user"`
|
||||
}
|
||||
|
||||
// ToDetailsWithOrganizationDetails convers the membership to generic membership model with organization details.
|
||||
func (m *Membership) ToDetailsWithOrganizationDetails(orgDetails *models.OrganizationDetails) *models.Membership[models.OrganizationDetails] {
|
||||
if m.ID == "" {
|
||||
return nil
|
||||
@@ -70,6 +76,7 @@ func (m *Membership) ToDetailsWithOrganizationDetails(orgDetails *models.Organiz
|
||||
}
|
||||
}
|
||||
|
||||
// ToDetailsWithOrganizationDetails convers the membership to generic membership model with organization details.
|
||||
func (m *Membership) ToDetailsWithProjectDetails(projDetails *models.ProjectDetails) *models.Membership[models.ProjectDetails] {
|
||||
if m.ID == "" {
|
||||
return nil
|
||||
|
||||
Reference in New Issue
Block a user