refactor: use consistent case for IDs

Author: a-cordier

.golangci.yml

@@ -253,7 +253,7 @@ issues:
   max-same-issues: 50
 
   exclude:
-    - ".*(Id|Api|Url|Http).* should be .*(ID|API|URL|HTTP).*"
+    - ".*(Api|Url|Http).* should be .*(API|URL|HTTP).*"
 
   exclude-rules:
     - source: "^//\\s*go:generate\\s"

api/model/api/base/member.go

@@ -22,7 +22,7 @@ type Member struct {
 	// Member source ID
 	// +kubebuilder:validation:Required
 	// +kubebuilder:example:=user@email.com
-	SourceId string `json:"sourceId"`
+	SourceID string `json:"sourceId"`
 	// Member display name
 	DisplayName string `json:"displayName,omitempty"`
 	// The API role associated with this Member
@@ -33,15 +33,15 @@ type Member struct {
 func NewGraviteeMember(username, role string) *Member {
 	return &Member{
 		Source:   "gravitee",
-		SourceId: username,
+		SourceID: username,
 		Role:     role,
 	}
 }
 
 func NewMemoryMember(username, role string) *Member {
 	return &Member{
 		Source:   "memory",
-		SourceId: username,
+		SourceID: username,
 		Role:     role,
 	}
 }

api/model/api/base/page.go

@@ -26,7 +26,7 @@ type PageSource struct {
 type AccessControl struct {
 	// +kubebuilder:validation:Required
 	// The ID denied or granted by the access control (currently only group names are supported)
-	ReferenceId string `json:"referenceId,omitempty"`
+	ReferenceID string `json:"referenceId,omitempty"`
 	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:Enum=GROUP;
 	// The type of reference denied or granted by the access control

api/model/api/base/plan.go

@@ -30,11 +30,11 @@ type PlanValidation string
 
 type Plan struct {
 	// Plan ID
-	Id string `json:"id,omitempty"`
+	ID string `json:"id,omitempty"`
 	// The plan Cross ID.
 	// This field is used to identify plans defined for an API
 	// that has been promoted between different environments.
-	CrossId string `json:"crossId,omitempty"`
+	CrossID string `json:"crossId,omitempty"`
 	// Plan Description
 	Description string `json:"description"`
 	// List of plan tags
@@ -71,11 +71,11 @@ func (plan *Plan) WithStatus(status PlanStatus) *Plan {
 }
 
 func (plan *Plan) WithID(id string) *Plan {
-	plan.Id = id
+	plan.ID = id
 	return plan
 }
 
 func (plan *Plan) WithCrossID(id string) *Plan {
-	plan.CrossId = id
+	plan.CrossID = id
 	return plan
 }

api/model/api/base/primary_owner.go

@@ -17,7 +17,7 @@ package base
 type PrimaryOwner struct {
 	// +kubebuilder:validation:Required
 	// PrimaryOwner ID
-	Id string `json:"id,omitempty"`
+	ID string `json:"id,omitempty"`
 	// +kubebuilder:validation:Optional
 	// PrimaryOwner email
 	Email string `json:"email,omitempty"`

api/model/api/v2/plan.go

@@ -28,7 +28,7 @@ type Consumer struct {
 	// Consumer type (possible values TAG)
 	ConsumerType ConsumerType `json:"consumerType,omitempty"`
 	// Consumer ID
-	ConsumerId string `json:"consumerId,omitempty"`
+	ConsumerID string `json:"consumerId,omitempty"`
 }
 
 type Plan struct {

api/model/api/v4/api.go

@@ -18,7 +18,6 @@ package v4
 import (
 	"fmt"
 	"net/url"
-	"strings"
 
 	"github.com/gravitee-io/gravitee-kubernetes-operator/api/model/api/base"
 	"github.com/gravitee-io/gravitee-kubernetes-operator/pkg/types/k8s/custom"
@@ -223,8 +222,12 @@ func parseListener(l Listener) []string {
 		{
 			paths := make([]string, 0)
 			for _, path := range t.Paths {
-				p := fmt.Sprintf("%s/%s", path.Host, path.Path)
-				paths = append(paths, strings.ReplaceAll(p, "//", "/"))
+				if path.Host != "" {
+					p := fmt.Sprintf("%s/%s", path.Host, path.Path)
+					paths = append(paths, p)
+				} else {
+					paths = append(paths, path.Path)
+				}
 			}
 			return paths
 		}

api/model/application/application.go

@@ -21,15 +21,15 @@ type AppKeyMode string
 type SimpleSettings struct {
 	// Application Type
 	AppType string `json:"type"`
-	// ClientId is the client id of the application
-	ClientId string `json:"client_id,omitempty"`
+	// ClientID is the client id of the application
+	ClientID string `json:"client_id,omitempty"`
 }
 
 type OAuthClientSettings struct {
 	// Oauth client application type
 	ApplicationType string `json:"application_type"`
 	// Oauth client id
-	ClientId string `json:"client_id,omitempty"`
+	ClientID string `json:"client_id,omitempty"`
 	// Oauth client secret
 	ClientSecret string `json:"client_secret,omitempty"`
 	// Oauth client uri
@@ -77,8 +77,8 @@ type Application struct {
 	Description string `json:"description,omitempty"`
 	// Application Type
 	Type string `json:"type,omitempty"`
-	// The ClientId identifying the application. This field is required when subscribing to an OAUTH2 / JWT plan.
-	ClientId string `json:"clientId,omitempty"`
+	// The ClientID identifying the application. This field is required when subscribing to an OAUTH2 / JWT plan.
+	ClientID string `json:"clientId,omitempty"`
 	// List of application Redirect Uris
 	RedirectUris []string `json:"redirectUris,omitempty"`
 

api/model/management/context.go

@@ -30,10 +30,10 @@ type Context struct {
 	BaseUrl string `json:"baseUrl"`
 	// An existing organization id targeted by the context on the management API instance.
 	// +kubebuilder:validation:Required
-	OrgId string `json:"organizationId"`
+	OrgID string `json:"organizationId"`
 	// An existing environment id targeted by the context within the organization.
 	// +kubebuilder:validation:Required
-	EnvId string `json:"environmentId"`
+	EnvID string `json:"environmentId"`
 	// Auth defines the authentication method used to connect to the API Management.
 	// Can be either basic authentication credentials, a bearer token
 	// or a reference to a kubernetes secret holding one of these two configurations.
@@ -46,14 +46,14 @@ func (c *Context) GetAuth() custom.Auth {
 	return c.Auth
 }
 
-// GetEnv implements custom.Context.
-func (c *Context) GetEnv() string {
-	return c.EnvId
+// GetEnvID implements custom.Context.
+func (c *Context) GetEnvID() string {
+	return c.EnvID
 }
 
-// GetOrg implements custom.Context.
-func (c *Context) GetOrg() string {
-	return c.OrgId
+// GetOrgID implements custom.Context.
+func (c *Context) GetOrgID() string {
+	return c.OrgID
 }
 
 // GetSecretRef implements custom.Context.

api/v1alpha1/apiv2definition_types.go

@@ -96,15 +96,15 @@ func (spec *ApiDefinitionV2Spec) SetDefinitionContext() {
 	}
 }
 
-func (api *ApiDefinition) EnvID() string {
+func (api *ApiDefinition) GetEnvID() string {
 	return api.Status.EnvID
 }
 
-func (api *ApiDefinition) ID() string {
+func (api *ApiDefinition) GetID() string {
 	return api.Status.ID
 }
 
-func (api *ApiDefinition) OrgID() string {
+func (api *ApiDefinition) GetOrgID() string {
 	return api.Status.OrgID
 }
 
@@ -143,17 +143,17 @@ func (api *ApiDefinition) GetDefinition() custom.ApiDefinition {
 func (api *ApiDefinition) PopulateIDs(_ custom.Context) {
 	api.Spec.ID = api.pickID()
 	api.Spec.CrossID = api.pickCrossID()
-	api.generateEmptyPlanCrossIds()
+	api.generateEmptyPlanCrossIDs()
 	api.generatePageIDs()
 }
 
-// For each plan, generate a CrossId from Api Id & Plan Name if not defined.
-func (api *ApiDefinition) generateEmptyPlanCrossIds() {
+// For each plan, generate a Cross id from Api id & Plan Name if not defined.
+func (api *ApiDefinition) generateEmptyPlanCrossIDs() {
 	plans := api.Spec.Plans
 
 	for _, plan := range plans {
-		if plan.CrossId == "" {
-			plan.CrossId = uuid.FromStrings(api.Spec.ID, separator, plan.Name)
+		if plan.CrossID == "" {
+			plan.CrossID = uuid.FromStrings(api.Spec.ID, separator, plan.Name)
 		}
 	}
 }