feat(subscription-addon-v3): implement get subscription addon v3 endpoint

Author: borosr

api/spec/packages/aip/src/subscriptions/index.tsp

@@ -2,3 +2,4 @@ import "./subscription.tsp";
 import "./subscriptionaddon.tsp";
 import "./operations.tsp";
 import "./reference.tsp";
+import "./subscriptionaddon.tsp";

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

@@ -174,4 +174,18 @@ interface SubscriptionAddonOperations {
     @query(#{ name: "sort" })
     sort?: Common.SortQuery,
   ): Shared.PagePaginatedResponse<SubscriptionAddon> | Common.NotFound | Common.ErrorResponses;
+
+  /**
+   * Get an add-on association for a subscription.
+   */
+  @get
+  @route("/{subscriptionAddonId}")
+  @operationId("get-subscription-addon")
+  @summary("Get add-on association for subscription")
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
+  getAddon(
+    @path subscriptionId: Shared.ULID,
+    @path subscriptionAddonId: Shared.ULID,
+  ): Shared.GetResponse<SubscriptionAddon> | Common.ErrorResponses | Common.NotFound;
 }

api/v3/api.gen.go

@@ -0,0 +1,54 @@
+package subscriptionaddons
+
+import (
+	"context"
+	"net/http"
+
+	apiv3 "github.com/openmeterio/openmeter/api/v3"
+	subscriptionaddon "github.com/openmeterio/openmeter/openmeter/subscription/addon"
+	"github.com/openmeterio/openmeter/pkg/framework/commonhttp"
+	"github.com/openmeterio/openmeter/pkg/framework/transport/httptransport"
+	"github.com/openmeterio/openmeter/pkg/models"
+)
+
+type (
+	GetSubscriptionAddonRequest = subscriptionaddon.GetSubscriptionAddonInput
+	GetSubscriptionAddonParams  struct {
+		SubscriptionID      string
+		SubscriptionAddonID string
+	}
+	GetSubscriptionAddonResponse = apiv3.SubscriptionAddon
+	GetSubscriptionAddonHandler  httptransport.HandlerWithArgs[GetSubscriptionAddonRequest, GetSubscriptionAddonResponse, GetSubscriptionAddonParams]
+)
+
+func (h *handler) GetSubscriptionAddons() GetSubscriptionAddonHandler {
+	return httptransport.NewHandlerWithArgs(
+		func(ctx context.Context, r *http.Request, params GetSubscriptionAddonParams) (GetSubscriptionAddonRequest, error) {
+			ns, err := h.resolveNamespace(ctx)
+			if err != nil {
+				return GetSubscriptionAddonRequest{}, err
+			}
+
+			return GetSubscriptionAddonRequest{
+				NamespacedID: models.NamespacedID{
+					Namespace: ns,
+					ID:        params.SubscriptionAddonID,
+				},
+				SubscriptionID: params.SubscriptionID,
+			}, nil
+		},
+		func(ctx context.Context, request GetSubscriptionAddonRequest) (GetSubscriptionAddonResponse, error) {
+			a, err := h.addonService.Get(ctx, request)
+			if err != nil {
+				return GetSubscriptionAddonResponse{}, err
+			}
+
+			return toAPISubscriptionAddon(*a)
+		},
+		commonhttp.JSONResponseEncoderWithStatus[GetSubscriptionAddonResponse](http.StatusOK),
+		httptransport.AppendOptions(
+			h.options,
+			httptransport.WithOperationName("get-subscription-addon"),
+		)...,
+	)
+}

api/v3/handlers/subscriptions/subscriptionaddons/get.go

@@ -9,22 +9,23 @@ import (
 
 type Handler interface {
 	ListSubscriptionAddons() ListSubscriptionAddonsHandler
+	GetSubscriptionAddons() GetSubscriptionAddonHandler
 }
 
 type handler struct {
-	resolveNamespace         func(ctx context.Context) (string, error)
-	subscriptionAddonService subscriptionaddon.Service
-	options                  []httptransport.HandlerOption
+	resolveNamespace func(ctx context.Context) (string, error)
+	addonService     subscriptionaddon.Service
+	options          []httptransport.HandlerOption
 }
 
 func New(
 	resolveNamespace func(ctx context.Context) (string, error),
-	subscriptionAddonService subscriptionaddon.Service,
+	addonService subscriptionaddon.Service,
 	options ...httptransport.HandlerOption,
 ) Handler {
 	return &handler{
-		resolveNamespace:         resolveNamespace,
-		subscriptionAddonService: subscriptionAddonService,
-		options:                  options,
+		resolveNamespace: resolveNamespace,
+		addonService:     addonService,
+		options:          options,
 	}
 }

api/v3/handlers/subscriptions/subscriptionaddons/handler.go

@@ -85,7 +85,7 @@ func (h *handler) ListSubscriptionAddons() ListSubscriptionAddonsHandler {
 			}, nil
 		},
 		func(ctx context.Context, req ListSubscriptionAddonsRequest) (ListSubscriptionAddonsResponse, error) {
-			res, err := h.subscriptionAddonService.List(ctx, req.SubscriptionID.Namespace, req.Input)
+			res, err := h.addonService.List(ctx, req.SubscriptionID.Namespace, req.Input)
 			if err != nil {
 				return ListSubscriptionAddonsResponse{}, fmt.Errorf("failed to list subscription addons: %w", err)
 			}

api/v3/handlers/subscriptions/subscriptionaddons/list.go

@@ -2592,6 +2592,41 @@ paths:
           $ref: '#/components/responses/NotFound'
       tags:
         - OpenMeter Subscriptions
+  /openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}:
+    get:
+      operationId: get-subscription-addon
+      summary: Get add-on association for subscription
+      description: Get an add-on association for a subscription.
+      parameters:
+        - name: subscriptionId
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/ULID'
+        - name: subscriptionAddonId
+          in: path
+          required: true
+          schema:
+            $ref: '#/components/schemas/ULID'
+      responses:
+        '200':
+          description: SubscriptionAddon response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SubscriptionAddon'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+      tags:
+        - OpenMeter Subscriptions
+      x-internal: true
+      x-unstable: true
   /openmeter/subscriptions/{subscriptionId}/cancel:
     post:
       operationId: cancel-subscription

api/v3/openapi.yaml

@@ -109,13 +109,21 @@ func (s *Server) ChangeSubscription(w http.ResponseWriter, r *http.Request, subs
 	s.subscriptionsHandler.ChangeSubscription().With(subscriptionId).ServeHTTP(w, r)
 }
 
+// Subscription Addons
 func (s *Server) ListSubscriptionAddons(w http.ResponseWriter, r *http.Request, subscriptionId api.ULID, params api.ListSubscriptionAddonsParams) {
 	s.subscriptionAddonsHandler.ListSubscriptionAddons().With(subscriptionaddonshandler.ListSubscriptionAddonsParams{
 		SubscriptionID: subscriptionId,
 		Params:         params,
 	}).ServeHTTP(w, r)
 }
 
+func (s *Server) GetSubscriptionAddon(w http.ResponseWriter, r *http.Request, subscriptionId api.ULID, subscriptionAddonId api.ULID) {
+	s.subscriptionAddonsHandler.GetSubscriptionAddons().With(subscriptionaddonshandler.GetSubscriptionAddonParams{
+		SubscriptionID:      subscriptionId,
+		SubscriptionAddonID: subscriptionAddonId,
+	}).ServeHTTP(w, r)
+}
+
 // Apps
 
 func (s *Server) ListApps(w http.ResponseWriter, r *http.Request, params api.ListAppsParams) {

api/v3/server/routes.go

@@ -208,6 +208,10 @@ func (c *Config) Validate() error {
 		errs = append(errs, errors.New("addon service is required"))
 	}
 
+	if c.SubscriptionAddonService == nil {
+		errs = append(errs, errors.New("subscription addon service is required"))
+	}
+
 	return errors.Join(errs...)
 }
 

api/v3/server/server.go

@@ -1680,7 +1680,7 @@ func (n NoopSubscriptionAddonService) ChangeQuantity(ctx context.Context, subscr
 	return nil, nil
 }
 
-func (n NoopSubscriptionAddonService) Get(ctx context.Context, addonId models.NamespacedID) (*subscriptionaddon.SubscriptionAddon, error) {
+func (n NoopSubscriptionAddonService) Get(ctx context.Context, params subscriptionaddon.GetSubscriptionAddonInput) (*subscriptionaddon.SubscriptionAddon, error) {
 	return nil, nil
 }