Include parameter validation is a maintenance problem for new valid include options

admin_organization.go

@@ -233,26 +233,5 @@ func (s *adminOrganizations) Delete(ctx context.Context, organization string) er
 }
 
 func (o *AdminOrganizationListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateAdminOrgIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateAdminOrgIncludeParams(params []AdminOrgIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case AdminOrgOwners:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }

admin_run.go

@@ -127,10 +127,6 @@ func (o *AdminRunsListOptions) valid() error {
 		return err
 	}
 
-	if err := validateAdminRunIncludeParams(o.Include); err != nil {
-		return err
-	}
-
 	return nil
 }
 
@@ -170,16 +166,3 @@ func validateAdminRunFilterParams(runStatus string) error {
 
 	return nil
 }
-
-func validateAdminRunIncludeParams(params []AdminRunIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case AdminRunWorkspace, AdminRunWorkspaceOrg, AdminRunWorkspaceOrgOwners:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
-	return nil
-}

admin_user.go

@@ -235,25 +235,5 @@ func (a *adminUsers) Disable2FA(ctx context.Context, userID string) (*AdminUser,
 }
 
 func (o *AdminUserListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateAdminUserIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateAdminUserIncludeParams(params []AdminUserIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case AdminUserOrgs:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
 	return nil
 }

admin_workspace.go

@@ -144,26 +144,5 @@ func (s *adminWorkspaces) Delete(ctx context.Context, workspaceID string) error
 }
 
 func (o *AdminWorkspaceListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateAdminWSIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateAdminWSIncludeParams(params []AdminWorkspaceIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case AdminWorkspaceOrg, AdminWorkspaceCurrentRun, AdminWorkspaceOrgOwners:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }

agent_pool.go

@@ -292,36 +292,9 @@ func (o AgentPoolUpdateOptions) valid() error {
 }
 
 func (o *AgentPoolReadOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-	if err := validateAgentPoolIncludeParams(o.Include); err != nil {
-		return err
-	}
-
 	return nil
 }
 
 func (o *AgentPoolListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-	if err := validateAgentPoolIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateAgentPoolIncludeParams(params []AgentPoolIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case AgentPoolWorkspaces:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }

configuration_version.go

@@ -302,39 +302,10 @@ func (s *configurationVersions) Archive(ctx context.Context, cvID string) error
 }
 
 func (o *ConfigurationVersionReadOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateConfigVerIncludeParams(o.Include); err != nil {
-		return err
-	}
-
 	return nil
 }
 
 func (o *ConfigurationVersionListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateConfigVerIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateConfigVerIncludeParams(params []ConfigVerIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case ConfigVerIngressAttributes, ConfigVerRun:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }
 

docs/CONTRIBUTING.md

@@ -255,9 +255,6 @@ func (s *example) List(ctx context.Context, organization string, options *Exampl
 	if !validStringID(&organization) {
 		return nil, ErrInvalidOrg
 	}
-	if err := options.valid(); err != nil {
-		return nil, err
-	}
 
 	u := fmt.Sprintf("organizations/%s/examples", url.QueryEscape(organization))
 	req, err := s.client.NewRequest("GET", u, options)
@@ -284,9 +281,6 @@ func (s *example) ReadWithOptions(ctx context.Context, exampleID string, options
 	if !validStringID(&exampleID) {
 		return nil, ErrInvalidExampleID
 	}
-	if err := options.valid(); err != nil {
-		return nil, err
-	}
 
 	u := fmt.Sprintf("examples/%s", url.QueryEscape(exampleID))
 	req, err := s.client.NewRequest("GET", u, options)
@@ -366,41 +360,6 @@ func (o *ExampleCreateOptions) valid() error {
 
 	return nil
 }
-
-func (o *ExampleListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-	if err := validateExampleIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func (o *ExampleReadOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-	if err := validateExampleIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateExampleIncludeParams(params []ExampleIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case ExampleOrganization, ExampleRun:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
-	return nil
-}
 ```
 
 ## Rebasing a fork to trigger CI (Maintainers Only)

oauth_client.go

@@ -286,26 +286,5 @@ func (o OAuthClientCreateOptions) valid() error {
 }
 
 func (o *OAuthClientListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateOauthClientIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateOauthClientIncludeParams(params []OAuthClientIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case OauthClientOauthTokens:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }

organization_membership.go

@@ -215,10 +215,6 @@ func (o *OrganizationMembershipListOptions) valid() error {
 		return nil
 	}
 
-	if err := validateOrgMembershipIncludeParams(o.Include); err != nil {
-		return err
-	}
-
 	if err := validateOrgMembershipEmailParams(o.Emails); err != nil {
 		return err
 	}
@@ -227,23 +223,6 @@ func (o *OrganizationMembershipListOptions) valid() error {
 }
 
 func (o OrganizationMembershipReadOptions) valid() error {
-	if err := validateOrgMembershipIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateOrgMembershipIncludeParams(params []OrgMembershipIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case OrgMembershipUser, OrgMembershipTeam:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }
 

organization_membership_integration_test.go

@@ -253,7 +253,7 @@ func TestOrganizationMembershipsReadWithOptions(t *testing.T) {
 		require.NoError(t, err)
 	})
 
-	t.Run("without invalid include option", func(t *testing.T) {
+	t.Run("with invalid include option", func(t *testing.T) {
 		_, err := client.OrganizationMemberships.ReadWithOptions(ctx, memTest.ID, OrganizationMembershipReadOptions{
 			Include: []OrgMembershipIncludeOpt{"users"},
 		})

policy_check.go

@@ -239,26 +239,5 @@ func (s *policyChecks) Logs(ctx context.Context, policyCheckID string) (io.Reade
 }
 
 func (o *PolicyCheckListOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validatePolicyCheckIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validatePolicyCheckIncludeParams(params []PolicyCheckIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case PolicyCheckRunWorkspace, PolicyCheckRun:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }

policy_set.go

@@ -658,26 +658,5 @@ func (o PolicySetAddProjectsOptions) valid() error {
 }
 
 func (o *PolicySetReadOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validatePolicySetIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validatePolicySetIncludeParams(params []PolicySetIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case PolicySetPolicies, PolicySetWorkspaces, PolicySetCurrentVersion, PolicySetNewestVersion, PolicySetWorkspaceExclusions, PolicySetProjects:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }

registry_no_code_module.go

@@ -244,26 +244,5 @@ func (o *RegistryNoCodeModuleUpdateOptions) valid() error {
 }
 
 func (o *RegistryNoCodeModuleReadOptions) valid() error {
-	if o == nil {
-		return nil // nothing to validate
-	}
-
-	if err := validateNoCodeIncludeParams(o.Include); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func validateNoCodeIncludeParams(params []RegistryNoCodeModuleIncludeOpt) error {
-	for _, p := range params {
-		switch p {
-		case RegistryNoCodeIncludeVariableOptions:
-			// do nothing
-		default:
-			return ErrInvalidIncludeValue
-		}
-	}
-
 	return nil
 }