Add component filtering via input filter (#574)

* Add  method for constructing service queries with ad hoc filters

Author: derek-etherton-opslevel

.changes/unreleased/Feature-20250717-082310.yaml

@@ -0,0 +1,4 @@
+kind: Feature
+body: Add `ListServicesWithInputFilter` method for constructing service queries with
+  ad hoc filters.
+time: 2025-07-17T08:23:10.305942-07:00

enum.go

@@ -2857,44 +2857,56 @@ var AllPayloadSortEnum = []string{
 type PredicateKeyEnum string
 
 var (
-	PredicateKeyEnumAliases         PredicateKeyEnum = "aliases"           // Filter by Alias attached to this service, if any
-	PredicateKeyEnumComponentTypeID PredicateKeyEnum = "component_type_id" // Filter by the `component_type` field
-	PredicateKeyEnumCreationSource  PredicateKeyEnum = "creation_source"   // Filter by the creation source
-	PredicateKeyEnumDomainID        PredicateKeyEnum = "domain_id"         // Filter by Domain that includes the System this service is assigned to, if any
-	PredicateKeyEnumFilterID        PredicateKeyEnum = "filter_id"         // Filter by another filter
-	PredicateKeyEnumFramework       PredicateKeyEnum = "framework"         // Filter by `framework` field
-	PredicateKeyEnumGroupIDs        PredicateKeyEnum = "group_ids"         // Filter by group hierarchy. Will return resources who's owner is in the group ancestry chain
-	PredicateKeyEnumLanguage        PredicateKeyEnum = "language"          // Filter by `language` field
-	PredicateKeyEnumLifecycleIndex  PredicateKeyEnum = "lifecycle_index"   // Filter by `lifecycle` field
-	PredicateKeyEnumName            PredicateKeyEnum = "name"              // Filter by `name` field
-	PredicateKeyEnumOwnerID         PredicateKeyEnum = "owner_id"          // Filter by `owner` field
-	PredicateKeyEnumOwnerIDs        PredicateKeyEnum = "owner_ids"         // Filter by `owner` hierarchy. Will return resources who's owner is in the team ancestry chain
-	PredicateKeyEnumProduct         PredicateKeyEnum = "product"           // Filter by `product` field
-	PredicateKeyEnumProperties      PredicateKeyEnum = "properties"        // Filter by custom-defined properties
-	PredicateKeyEnumRepositoryIDs   PredicateKeyEnum = "repository_ids"    // Filter by Repository that this service is attached to, if any
-	PredicateKeyEnumSystemID        PredicateKeyEnum = "system_id"         // Filter by System that this service is assigned to, if any
-	PredicateKeyEnumTags            PredicateKeyEnum = "tags"              // Filter by `tags` field
-	PredicateKeyEnumTierIndex       PredicateKeyEnum = "tier_index"        // Filter by `tier` field
+	PredicateKeyEnumAliases           PredicateKeyEnum = "aliases"            // Filter by Alias attached to this service, if any
+	PredicateKeyEnumAlertStatus       PredicateKeyEnum = "alert_status"       // Filter by alert status field
+	PredicateKeyEnumComponentTypeID   PredicateKeyEnum = "component_type_id"  // Filter by the `component_type` field
+	PredicateKeyEnumCreationSource    PredicateKeyEnum = "creation_source"    // Filter by the creation source
+	PredicateKeyEnumDeployEnvironment PredicateKeyEnum = "deploy_environment" // Filter by the existence of a deploy to an environment
+	PredicateKeyEnumDomainID          PredicateKeyEnum = "domain_id"          // Filter by Domain that includes the System this service is assigned to, if any
+	PredicateKeyEnumFilterID          PredicateKeyEnum = "filter_id"          // Filter by another filter
+	PredicateKeyEnumFramework         PredicateKeyEnum = "framework"          // Filter by `framework` field
+	PredicateKeyEnumGroupIDs          PredicateKeyEnum = "group_ids"          // Filter by group hierarchy. Will return resources who's owner is in the group ancestry chain
+	PredicateKeyEnumLanguage          PredicateKeyEnum = "language"           // Filter by `language` field
+	PredicateKeyEnumLevelIndex        PredicateKeyEnum = "level_index"        // Filter by level field
+	PredicateKeyEnumLifecycleIndex    PredicateKeyEnum = "lifecycle_index"    // Filter by `lifecycle` field
+	PredicateKeyEnumName              PredicateKeyEnum = "name"               // Filter by `name` field
+	PredicateKeyEnumOwnerID           PredicateKeyEnum = "owner_id"           // Filter by `owner` field
+	PredicateKeyEnumOwnerIDs          PredicateKeyEnum = "owner_ids"          // Filter by `owner` hierarchy. Will return resources who's owner is in the team ancestry chain
+	PredicateKeyEnumProduct           PredicateKeyEnum = "product"            // Filter by `product` field
+	PredicateKeyEnumProperties        PredicateKeyEnum = "properties"         // Filter by custom-defined properties
+	PredicateKeyEnumProperty          PredicateKeyEnum = "property"           // Filter by a custom-defined property value
+	PredicateKeyEnumRelationship      PredicateKeyEnum = "relationship"       // Filter by the existence of a relationship to another catalog component
+	PredicateKeyEnumRepositoryIDs     PredicateKeyEnum = "repository_ids"     // Filter by Repository that this service is attached to, if any
+	PredicateKeyEnumSystemID          PredicateKeyEnum = "system_id"          // Filter by System that this service is assigned to, if any
+	PredicateKeyEnumTag               PredicateKeyEnum = "tag"                // Filter by tag field
+	PredicateKeyEnumTags              PredicateKeyEnum = "tags"               // Filter by `tags` field
+	PredicateKeyEnumTierIndex         PredicateKeyEnum = "tier_index"         // Filter by `tier` field
 )
 
 // All PredicateKeyEnum as []string
 var AllPredicateKeyEnum = []string{
 	string(PredicateKeyEnumAliases),
+	string(PredicateKeyEnumAlertStatus),
 	string(PredicateKeyEnumComponentTypeID),
 	string(PredicateKeyEnumCreationSource),
+	string(PredicateKeyEnumDeployEnvironment),
 	string(PredicateKeyEnumDomainID),
 	string(PredicateKeyEnumFilterID),
 	string(PredicateKeyEnumFramework),
 	string(PredicateKeyEnumGroupIDs),
 	string(PredicateKeyEnumLanguage),
+	string(PredicateKeyEnumLevelIndex),
 	string(PredicateKeyEnumLifecycleIndex),
 	string(PredicateKeyEnumName),
 	string(PredicateKeyEnumOwnerID),
 	string(PredicateKeyEnumOwnerIDs),
 	string(PredicateKeyEnumProduct),
 	string(PredicateKeyEnumProperties),
+	string(PredicateKeyEnumProperty),
+	string(PredicateKeyEnumRelationship),
 	string(PredicateKeyEnumRepositoryIDs),
 	string(PredicateKeyEnumSystemID),
+	string(PredicateKeyEnumTag),
 	string(PredicateKeyEnumTags),
 	string(PredicateKeyEnumTierIndex),
 }

service.go

@@ -46,6 +46,16 @@ type Service struct {
 	Properties *ServicePropertiesConnection `graphql:"-"`
 }
 
+// ServiceFilterInput is the input object for filtering services.
+type ServiceFilterInput struct {
+	Key           PredicateKeyEnum      `json:"key,omitempty"`
+	Arg           string                `json:"arg,omitempty"`
+	Type          PredicateTypeEnum     `json:"type,omitempty"`
+	Connective    *ConnectiveEnum       `json:"connective,omitempty" yaml:"connective,omitempty" example:"and"` // The logical operator to be used in conjunction with predicates (Optional)
+	Predicates    *[]ServiceFilterInput `json:"predicates,omitempty" yaml:"predicates,omitempty" example:"[]"`  // The list of predicates used to select which services apply to the filter (Optional)
+	CaseSensitive bool                  `json:"caseSensitive"`
+}
+
 // Returns unique identifiers created by OpsLevel, values in Aliases but not ManagedAliases
 func (service *Service) UniqueIdentifiers() []string {
 	uniqueIdentifiers := []string{}
@@ -553,6 +563,39 @@ func (client *Client) ListServicesWithFramework(framework string, variables *Pay
 	return &q.Account.Services, nil
 }
 
+func (client *Client) ListServicesWithInputFilter(filter ServiceFilterInput, variables *PayloadVariables) (*ServiceConnection, error) {
+	var q struct {
+		Account struct {
+			Services ServiceConnection `graphql:"services(filter: $filter, after: $after, first: $first)"`
+		}
+	}
+	if variables == nil {
+		variables = client.InitialPageVariablesPointer()
+	}
+	(*variables)["filter"] = []ServiceFilterInput{filter} // GraphQL expects an array of filters
+
+	if err := client.Query(&q, *variables, WithName("ServiceListWithInputFilter")); err != nil {
+		return nil, err
+	}
+
+	if q.Account.Services.PageInfo.HasNextPage {
+		(*variables)["after"] = q.Account.Services.PageInfo.End
+		resp, err := client.ListServicesWithInputFilter(filter, variables)
+		if err != nil {
+			return nil, err
+		}
+		for _, node := range resp.Nodes {
+			if err := node.Hydrate(client); err != nil {
+				return nil, err
+			}
+			q.Account.Services.Nodes = append(q.Account.Services.Nodes, node)
+		}
+		q.Account.Services.PageInfo = resp.PageInfo
+	}
+	q.Account.Services.TotalCount = len(q.Account.Services.Nodes)
+	return &q.Account.Services, nil
+}
+
 func (client *Client) ListServicesWithLanguage(language string, variables *PayloadVariables) (*ServiceConnection, error) {
 	var q struct {
 		Account struct {