feat: add filter and sort to billing profile

Author: borosr

api/spec/packages/aip/src/billing/operations.tsp

@@ -13,6 +13,17 @@ using TypeSpec.OpenAPI;
 
 namespace Billing;
 
+/**
+ * Filter options for listing billing profiles.
+ */
+@friendlyName("ListBillingProfilesParamsFilter")
+model ListBillingProfilesParamsFilter {
+  #suppress "@openmeter/api-spec-aip/doc-decorator" "filter field"
+  id?: Common.ULIDFieldFilter;
+  #suppress "@openmeter/api-spec-aip/doc-decorator" "filter field"
+  name?: Common.StringFieldFilter;
+}
+
 interface BillingProfilesOperations {
   /**
    * List billing profiles.
@@ -22,6 +33,29 @@ interface BillingProfilesOperations {
   @summary("List billing profiles")
   list(
     ...Common.PagePaginationQuery,
+
+    /**
+     * Sort billing profiles returned in the response. Supported sort attributes are:
+     *
+     * - `id`
+     * - `name`
+     * - `created_at` (default)
+     * - `updated_at`
+     *
+     * The `asc` suffix is optional as the default sort order is ascending. The `desc`
+     * suffix is used to specify a descending order.
+     */
+    @query(#{ name: "sort" })
+    sort?: Common.SortQuery,
+
+    /**
+     * Filter billing profiles returned in the response.
+     *
+     * To filter billing profiles by name add the following query param:
+     * filter[name]=my-profile
+     */
+    @query(#{ style: "deepObject", explode: true })
+    filter?: ListBillingProfilesParamsFilter,
   ): Shared.PagePaginatedResponse<BillingProfile> | Common.ErrorResponses;
 
   /**

api/v3/api.gen.go

@@ -9,6 +9,8 @@ import (
 
 	api "github.com/openmeterio/openmeter/api/v3"
 	"github.com/openmeterio/openmeter/api/v3/apierrors"
+	"github.com/openmeterio/openmeter/api/v3/filters"
+	"github.com/openmeterio/openmeter/api/v3/request"
 	"github.com/openmeterio/openmeter/api/v3/response"
 	"github.com/openmeterio/openmeter/openmeter/billing"
 	"github.com/openmeterio/openmeter/pkg/framework/commonhttp"
@@ -57,6 +59,35 @@ func (h *handler) ListBillingProfiles() ListBillingProfilesHandler {
 				},
 			}
 
+			if params.Sort != nil {
+				sort, err := request.ParseSortBy(*params.Sort)
+				if err != nil {
+					return ListBillingProfilesRequest{}, apierrors.NewBadRequestError(ctx, err, apierrors.InvalidParameters{
+						{Field: "sort", Reason: err.Error(), Source: apierrors.InvalidParamSourceQuery},
+					})
+				}
+				req.OrderBy = billing.OrderBy(sort.Field)
+				req.Order = sort.Order.ToSortxOrder()
+			}
+
+			if params.Filter != nil {
+				id, err := filters.FromAPIFilterULID(params.Filter.Id)
+				if err != nil {
+					return ListBillingProfilesRequest{}, apierrors.NewBadRequestError(ctx, err, apierrors.InvalidParameters{
+						{Field: "filter[id]", Reason: err.Error(), Source: apierrors.InvalidParamSourceQuery},
+					})
+				}
+				req.ID = id
+
+				name, err := filters.FromAPIFilterString(params.Filter.Name)
+				if err != nil {
+					return ListBillingProfilesRequest{}, apierrors.NewBadRequestError(ctx, err, apierrors.InvalidParameters{
+						{Field: "filter[name]", Reason: err.Error(), Source: apierrors.InvalidParamSourceQuery},
+					})
+				}
+				req.Name = name
+			}
+
 			return req, nil
 		},
 		func(ctx context.Context, request ListBillingProfilesRequest) (ListBillingProfilesResponse, error) {

api/v3/handlers/billingprofiles/list.go

@@ -2377,6 +2377,34 @@ paths:
       description: List billing profiles.
       parameters:
         - $ref: '#/components/parameters/PagePaginationQuery'
+        - name: sort
+          in: query
+          required: false
+          description: |-
+            Sort billing profiles returned in the response. Supported sort attributes are:
+
+            - `id`
+            - `name`
+            - `created_at` (default)
+            - `updated_at`
+
+            The `asc` suffix is optional as the default sort order is ascending. The `desc`
+            suffix is used to specify a descending order.
+          schema:
+            $ref: '#/components/schemas/SortQuery'
+          explode: false
+          style: form
+        - name: filter
+          in: query
+          required: false
+          description: |-
+            Filter billing profiles returned in the response.
+
+            To filter billing profiles by name add the following query param:
+            filter[name]=my-profile
+          schema:
+            $ref: '#/components/schemas/ListBillingProfilesParamsFilter'
+          style: deepObject
       responses:
         '200':
           description: Page paginated response.
@@ -8189,6 +8217,15 @@ components:
           $ref: '#/components/schemas/StringFieldFilterExact'
       additionalProperties: false
       description: Filter options for listing add-ons.
+    ListBillingProfilesParamsFilter:
+      type: object
+      properties:
+        id:
+          $ref: '#/components/schemas/ULIDFieldFilter'
+        name:
+          $ref: '#/components/schemas/StringFieldFilter'
+      additionalProperties: false
+      description: Filter options for listing billing profiles.
     ListChargesParamsFilter:
       type: object
       properties:

api/v3/openapi.yaml

@@ -8,7 +8,6 @@ import (
 
 	"github.com/samber/lo"
 
-	"github.com/openmeterio/openmeter/api"
 	"github.com/openmeterio/openmeter/openmeter/app"
 	"github.com/openmeterio/openmeter/openmeter/billing"
 	"github.com/openmeterio/openmeter/openmeter/customer"
@@ -23,6 +22,7 @@ import (
 	taxcodeadapter "github.com/openmeterio/openmeter/openmeter/taxcode/adapter"
 	"github.com/openmeterio/openmeter/pkg/clock"
 	"github.com/openmeterio/openmeter/pkg/convert"
+	"github.com/openmeterio/openmeter/pkg/filter"
 	"github.com/openmeterio/openmeter/pkg/framework/entutils"
 	"github.com/openmeterio/openmeter/pkg/models"
 	"github.com/openmeterio/openmeter/pkg/pagination"
@@ -160,20 +160,23 @@ func (a *adapter) ListProfiles(ctx context.Context, input billing.ListProfilesIn
 		query = query.Where(billingprofile.DeletedAtIsNil())
 	}
 
+	query = filter.ApplyToQuery(query, input.ID, billingprofile.FieldID)
+	query = filter.ApplyToQuery(query, input.Name, billingprofile.FieldName)
+
 	order := entutils.GetOrdering(sortx.OrderDefault)
 	if !input.Order.IsDefaultValue() {
 		order = entutils.GetOrdering(input.Order)
 	}
 
 	switch input.OrderBy {
-	case api.BillingProfileOrderByCreatedAt:
-		query = query.Order(billingprofile.ByCreatedAt(order...))
-	case api.BillingProfileOrderByUpdatedAt:
-		query = query.Order(billingprofile.ByUpdatedAt(order...))
-	case api.BillingProfileOrderByName:
+	case billing.OrderByID:
+		query = query.Order(billingprofile.ByID(order...))
+	case billing.OrderByName:
 		query = query.Order(billingprofile.ByName(order...))
-	case api.BillingProfileOrderByDefault:
-		query = query.Order(billingprofile.ByDefault(order...))
+	case billing.OrderByUpdatedAt:
+		query = query.Order(billingprofile.ByUpdatedAt(order...))
+	case billing.OrderByCreatedAt, billing.OrderByDefault:
+		fallthrough
 	default:
 		query = query.Order(billingprofile.ByCreatedAt(order...))
 	}

openmeter/billing/adapter/profile.go

@@ -248,7 +248,7 @@ func (h *handler) ListProfiles() ListProfilesHandler {
 			return ListProfilesRequest{
 				Namespace:       ns,
 				IncludeArchived: lo.FromPtrOr(params.IncludeArchived, DefaultIncludeArchived),
-				OrderBy:         lo.FromPtrOr(params.OrderBy, api.BillingProfileOrderByCreatedAt),
+				OrderBy:         billing.OrderBy(lo.FromPtrOr(params.OrderBy, api.BillingProfileOrderByCreatedAt)),
 				Order:           sortx.Order(lo.FromPtrOr(params.Order, api.SortOrderDESC)),
 
 				Page: pagination.Page{

openmeter/billing/httpdriver/profile.go

@@ -12,6 +12,7 @@ import (
 	"github.com/openmeterio/openmeter/openmeter/app"
 	"github.com/openmeterio/openmeter/openmeter/productcatalog"
 	"github.com/openmeterio/openmeter/pkg/datetime"
+	"github.com/openmeterio/openmeter/pkg/filter"
 	"github.com/openmeterio/openmeter/pkg/models"
 	"github.com/openmeterio/openmeter/pkg/pagination"
 	"github.com/openmeterio/openmeter/pkg/sortx"
@@ -366,15 +367,43 @@ type CreateProfileAppsInput = ProfileAppReferences
 
 type ListProfilesResult = pagination.Result[Profile]
 
+type OrderBy string
+
+func (o OrderBy) Values() []OrderBy {
+	return []OrderBy{
+		OrderByCreatedAt,
+		OrderByUpdatedAt,
+		OrderByName,
+	}
+}
+
+func (o OrderBy) Validate() error {
+	if !slices.Contains(o.Values(), o) {
+		return fmt.Errorf("invalid order by: %s", o)
+	}
+	return nil
+}
+
+const (
+	OrderByID        OrderBy = "id"
+	OrderByCreatedAt OrderBy = OrderBy(api.BillingProfileOrderByCreatedAt)
+	OrderByUpdatedAt OrderBy = OrderBy(api.BillingProfileOrderByUpdatedAt)
+	OrderByName      OrderBy = OrderBy(api.BillingProfileOrderByName)
+	OrderByDefault   OrderBy = OrderBy(api.BillingProfileOrderByDefault)
+)
+
 type ListProfilesInput struct {
 	pagination.Page
 
 	Expand ProfileExpand
 
 	Namespace       string
 	IncludeArchived bool
-	OrderBy         api.BillingProfileOrderBy
+	OrderBy         OrderBy
 	Order           sortx.Order
+
+	ID   *filter.FilterULID
+	Name *filter.FilterString
 }
 
 func (i ListProfilesInput) Validate() error {
@@ -386,7 +415,25 @@ func (i ListProfilesInput) Validate() error {
 		return fmt.Errorf("error validating expand: %w", err)
 	}
 
-	return nil
+	var errs []error
+	if i.ID != nil {
+		if err := i.ID.Validate(); err != nil {
+			errs = append(errs, err)
+		}
+	}
+	if i.Name != nil {
+		if err := i.Name.Validate(); err != nil {
+			errs = append(errs, err)
+		}
+	}
+
+	if i.OrderBy != "" {
+		if err := i.OrderBy.Validate(); err != nil {
+			errs = append(errs, err)
+		}
+	}
+
+	return models.NewNillableGenericValidationError(errors.Join(errs...))
 }
 
 type ProfileExpand struct {