chore: mark optional fields

Author: CatalinSnyk

internal/api/api.go

@@ -249,22 +249,15 @@ func (a *snykApiClient) GetSastSettings(orgId string) (*sast_contract.SastRespon
 }
 
 func (a *snykApiClient) GetOrgSettings(orgId string) (*contract.OrgSettingsResponse, error) {
-	endpoint := fmt.Sprintf("%s/v1/org/%s/settings", a.url, url.QueryEscape(orgId))
-	res, err := a.client.Get(endpoint)
-	if err != nil {
-		return nil, fmt.Errorf("unable to retrieve org settings: %w", err)
-	}
-	//goland:noinspection GoUnhandledErrorResult
-	defer res.Body.Close()
-
-	body, err := io.ReadAll(res.Body)
+	endpoint := fmt.Sprintf("/v1/org/%s/settings", url.QueryEscape(orgId))
+	body, err := clientGet(a, endpoint, nil)
 	if err != nil {
 		return nil, fmt.Errorf("unable to retrieve org settings: %w", err)
 	}
 
 	var response contract.OrgSettingsResponse
 	if err = json.Unmarshal(body, &response); err != nil {
-		return nil, fmt.Errorf("unable to retrieve org settings (status: %d): %w", res.StatusCode, err)
+		return nil, err
 	}
 
 	return &response, err

internal/api/contract/OrgSettingsResponse.go

@@ -11,6 +11,6 @@ type OrgRequestAccessSettings struct {
 }
 
 type OrgSettingsResponse struct {
-	Ignores       OrgIgnoreSettings        `json:"ignores"`
-	RequestAccess OrgRequestAccessSettings `json:"requestAccess"`
+	Ignores       *OrgIgnoreSettings        `json:"ignores"`
+	RequestAccess *OrgRequestAccessSettings `json:"requestAccess"`
 }

pkg/local_workflows/ignore_workflow/config.go

@@ -45,7 +45,7 @@ func addCreateIgnoreDefaultConfigurationValues(invocationCtx workflow.Invocation
 }
 
 func getOrgIgnoreApprovalEnabled(engine workflow.Engine) configuration.DefaultValueFunction {
-	return func(existingValue interface{}) (interface{}, error) {
+	return func(_ configuration.Configuration, existingValue interface{}) (interface{}, error) {
 		if existingValue != nil {
 			return existingValue, nil
 		}
@@ -62,6 +62,10 @@ func getOrgIgnoreApprovalEnabled(engine workflow.Engine) configuration.DefaultVa
 			return nil, err
 		}
 
+		if settings.Ignores == nil {
+			return false, nil
+		}
+
 		return settings.Ignores.ApprovalWorkflowEnabled, nil
 	}
 }

pkg/local_workflows/ignore_workflow/ignore_workflow.go

@@ -103,12 +103,17 @@ func ignoreCreateWorkflowEntryPoint(invocationCtx workflow.InvocationContext, _
 	id := invocationCtx.GetWorkflowIdentifier()
 
 	if !config.GetBool(ConfigIgnoreApprovalEnabled) {
+		orgName := config.GetString(configuration.ORGANIZATION_SLUG)
 		return nil, snyk_errors.Error{
-			ID:          "SNYK-CLI-0014",
-			Title:       "Organization setting not enabled",
-			Description: "The feature you are trying to use is not enabled you the current organization. Enable it in the settings or try switching the organization.",
-			Detail:      "",
-			Level:       "fatal",
+			Type:           "https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0016",
+			Title:          "Feature not enabled",
+			Description:    "This feature is disabled for your current organization. You can enable it in the settings or switch to an organization where it's already enabled.",
+			StatusCode:     403,
+			ErrorCode:      "SNYK-CLI-0016",
+			Classification: "ACTIONABLE",
+			Links:          []string{},
+			Level:          "error",
+			Detail:         fmt.Sprintf("The Ignore Approval Workflow feature must be enabled for the %s organization. Enable it in your organization settings: Settings > General > Ignore approval workflow for Snyk Code.", orgName),
 		}
 	}