feat(api): add plan addon types and operations

Author: rolosp

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

@@ -39,7 +39,7 @@ interface FeatureOperations {
   create(
     @body
     feature: Shared.CreateRequest<Feature>,
-  ): Shared.PagePaginatedResponse<Feature> | Common.ErrorResponses;
+  ): Shared.CreateResponse<Feature> | Common.ErrorResponses;
 
   /**
    * Get a feature by id.

api/spec/packages/aip/src/konnect.tsp

@@ -121,10 +121,17 @@ interface LLMCostPricesEndpoints extends LLMCost.LLMCostPricesOperations {}
 interface LLMCostOverridesEndpoints
   extends LLMCost.LLMCostOverridesOperations {}
 
-@route("/openmeter/product-catalog/prices")
+@route("/openmeter/plans")
 @tag(Shared.ProductCatalogTag)
-interface ProductCatalogEndpoints
-  extends ProductCatalog.ProductCatalogOperations {}
+interface PlansEndpoints extends ProductCatalog.PlanOperations {}
+
+@route("/openmeter/addons")
+@tag(Shared.ProductCatalogTag)
+interface AddonsEndpoints extends ProductCatalog.AddonOperations {}
+
+@route("/openmeter/plans/{planId}/addons")
+@tag(Shared.ProductCatalogTag)
+interface PlanAddonEndpoints extends ProductCatalog.PlanAddonOperations {}
 
 /**
  * The system account access token is meant for automations and integrations that are not directly associated with a human identity.

api/spec/packages/aip/src/openmeter.tsp

@@ -123,7 +123,14 @@ interface LLMCostPricesEndpoints extends LLMCost.LLMCostPricesOperations {}
 interface LLMCostOverridesEndpoints
   extends LLMCost.LLMCostOverridesOperations {}
 
-@route("/openmeter/product-catalog")
+@route("/openmeter/plans")
 @tag(Shared.ProductCatalogTag)
-interface ProductCatalogEndpoints
-  extends ProductCatalog.ProductCatalogOperations {}
+interface PlansEndpoints extends ProductCatalog.PlanOperations {}
+
+@route("/openmeter/addons")
+@tag(Shared.ProductCatalogTag)
+interface AddonsEndpoints extends ProductCatalog.AddonOperations {}
+
+@route("/openmeter/plans/{planId}/addons")
+@tag(Shared.ProductCatalogTag)
+interface PlanAddonEndpoints extends ProductCatalog.PlanAddonOperations {}

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

@@ -3,3 +3,4 @@ import "./unitconfig.tsp";
 import "./ratecard.tsp";
 import "./operations.tsp";
 import "./addons.tsp";
+import "./planaddon.tsp";

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

@@ -3,22 +3,23 @@ import "@typespec/rest";
 import "@typespec/openapi";
 import "@typespec/openapi3";
 import "../common/error.tsp";
+import "../common/pagination.tsp";
 import "../common/parameters.tsp";
 import "../shared/index.tsp";
 import "./ratecard.tsp";
 import "./plan.tsp";
+import "./planaddon.tsp";
 
 using TypeSpec.Http;
 using TypeSpec.OpenAPI;
 
 namespace ProductCatalog;
 
-interface ProductCatalogOperations {
+interface PlanOperations {
   /**
-   *  List all plans.
+   * List all plans.
    */
   @get
-  @route("/plans")
   @operationId("list-plans")
   @summary("List plans")
   @extension(Shared.PrivateExtension, true)
@@ -29,46 +30,42 @@ interface ProductCatalogOperations {
   ): Shared.PagePaginatedResponse<Plan> | Common.ErrorResponses;
 
   /**
-   *  Create a new plan.
+   * Create a new plan.
    */
   @post
-  @route("/plans")
   @operationId("create-plan")
   @summary("Create a new plan.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   createPlan(
-    @body
-    plan: Shared.CreateRequest<Plan>,
+    @body plan: Shared.CreateRequest<Plan>,
   ): Shared.CreateResponse<Plan> | Common.ErrorResponses;
 
   /**
-   *  Upsert a plan by id.
+   * Upsert a plan by id.
    */
   @put
-  @route("/plans/{planId}")
+  @route("/{planId}")
   @operationId("upsert-plan")
   @summary("Upsert a plan by id.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   upsertPlan(
     @path planId: Shared.ULID,
-
-    @body
-    plan: Shared.UpsertRequest<Plan>,
+    @body plan: Shared.UpsertRequest<Plan>,
   ):
     | Shared.UpsertResponse<Plan>
     | Common.ErrorResponses
     | Common.Gone
     | Common.NotFound;
 
   /**
-   *  Get a plan by id.
+   * Get a plan by id.
    */
   @get
-  @route("/plans/{planId}")
+  @route("/{planId}")
   @operationId("get-plan")
   @summary("Get a plan by id.")
   @extension(Shared.PrivateExtension, true)
@@ -81,10 +78,10 @@ interface ProductCatalogOperations {
     | Common.NotFound;
 
   /**
-   * Delete plan by id.
+   * Delete a plan by id.
    */
   @delete
-  @route("/plans/{planId}")
+  @route("/{planId}")
   @operationId("delete-plan")
   @summary("Delete a plan by id.")
   @extension(Shared.PrivateExtension, true)
@@ -98,7 +95,7 @@ interface ProductCatalogOperations {
    * Archive a plan version.
    */
   @post
-  @route("/plans/{planId}/archive")
+  @route("/{planId}/archive")
   @operationId("archive-plan")
   @summary("Archive a plan version.")
   @extension(Shared.PrivateExtension, true)
@@ -112,21 +109,22 @@ interface ProductCatalogOperations {
    * Publish a plan version.
    */
   @post
-  @route("/plans/{planId}/publish")
-  @operationId("archive-plan")
+  @route("/{planId}/publish")
+  @operationId("publish-plan")
   @summary("Publish a plan version.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   publishPlan(
     @path planId: Shared.ULID,
   ): Shared.UpdateResponse<Plan> | Common.ErrorResponses | Common.NotFound;
+}
 
+interface AddonOperations {
   /**
-   *  List all add-ons.
+   * List all add-ons.
    */
   @get
-  @route("/addons")
   @operationId("list-addons")
   @summary("List all add-ons.")
   @extension(Shared.PrivateExtension, true)
@@ -137,46 +135,42 @@ interface ProductCatalogOperations {
   ): Shared.PagePaginatedResponse<Addon> | Common.ErrorResponses;
 
   /**
-   *  List all add-ons.
+   * Create a new add-on.
    */
   @post
-  @route("/addons")
   @operationId("create-addon")
-  @summary("Create a new add-on")
+  @summary("Create a new add-on.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   createAddon(
-    @body
-    addon: Shared.CreateRequest<Addon>,
+    @body addon: Shared.CreateRequest<Addon>,
   ): Shared.CreateResponse<Addon> | Common.ErrorResponses;
 
   /**
-   *  Upsert add-on by id.
+   * Upsert add-on by id.
    */
   @put
-  @route("/addons/{addonId}")
+  @route("/{addonId}")
   @operationId("upsert-addon")
-  @summary("Upsert add-on by id")
+  @summary("Upsert add-on by id.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   upsertAddon(
     @path addonId: Shared.ULID,
-
-    @body
-    addon: Shared.UpsertRequest<Addon>,
+    @body addon: Shared.UpsertRequest<Addon>,
   ):
     | Shared.UpsertResponse<Addon>
     | Common.ErrorResponses
     | Common.Gone
     | Common.NotFound;
 
   /**
-   *  Get add-on by id.
+   * Get add-on by id.
    */
   @get
-  @route("/addons/{addonId}")
+  @route("/{addonId}")
   @operationId("get-addon")
   @summary("Get add-on by id.")
   @extension(Shared.PrivateExtension, true)
@@ -192,7 +186,7 @@ interface ProductCatalogOperations {
    * Soft delete add-on by id.
    */
   @delete
-  @route("/addons/{addonId}")
+  @route("/{addonId}")
   @operationId("delete-addon")
   @summary("Soft delete add-on by id.")
   @extension(Shared.PrivateExtension, true)
@@ -203,30 +197,106 @@ interface ProductCatalogOperations {
   ): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
 
   /**
-   *  Archive a add-on version.
+   * Archive an add-on version.
    */
   @post
-  @route("/addons/{addonId}/archive")
+  @route("/{addonId}/archive")
   @operationId("archive-addon")
-  @summary("Archive a add-on version.")
+  @summary("Archive an add-on version.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   archiveAddon(
     @path addonId: Shared.ULID,
-  ): Shared.UpdateResponse<Addon> | Common.ErrorResponses;
+  ): Shared.UpdateResponse<Addon> | Common.ErrorResponses | Common.NotFound;
 
   /**
-   *  Publish an add-on version.
+   * Publish an add-on version.
    */
   @post
-  @route("/addons/{addonId}/publish")
+  @route("/{addonId}/publish")
   @operationId("publish-addon")
   @summary("Publish an add-on version.")
   @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   publishAddon(
     @path addonId: Shared.ULID,
-  ): Shared.UpdateResponse<Addon> | Common.ErrorResponses;
+  ): Shared.UpdateResponse<Addon> | Common.ErrorResponses | Common.NotFound;
+}
+
+interface PlanAddonOperations {
+  /**
+   * List add-ons associated with a plan.
+   */
+  @get
+  @operationId("list-plan-addons")
+  @summary("List add-ons for a plan.")
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
+  listPlanAddons(
+    @path planId: Shared.ULID,
+    ...Common.PagePaginationQuery,
+  ): Shared.PagePaginatedResponse<PlanAddon> | Common.ErrorResponses;
+
+  /**
+   * Add an add-on to a plan.
+   */
+  @post
+  @operationId("create-plan-addon")
+  @summary("Add an add-on to a plan.")
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
+  createPlanAddon(
+    @path planId: Shared.ULID,
+    @body plan_addon: Shared.CreateRequest<PlanAddon>,
+  ): Shared.CreateResponse<PlanAddon> | Common.ErrorResponses;
+
+  /**
+   * Get an add-on association for a plan.
+   */
+  @get
+  @route("/{planAddonId}")
+  @operationId("get-plan-addon")
+  @summary("Get an add-on association for a plan.")
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
+  getPlanAddon(
+    @path planId: Shared.ULID,
+    @path planAddonId: Shared.ULID,
+  ): Shared.GetResponse<PlanAddon> | Common.ErrorResponses | Common.NotFound;
+
+  /**
+   * Update an add-on association for a plan.
+   */
+  @put
+  @route("/{planAddonId}")
+  @operationId("upsert-plan-addon")
+  @summary("Update an add-on association for a plan.")
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
+  upsertPlanAddon(
+    @path planId: Shared.ULID,
+    @path planAddonId: Shared.ULID,
+    @body plan_addon: Shared.UpsertRequest<PlanAddon>,
+  ): Shared.UpsertResponse<PlanAddon> | Common.ErrorResponses | Common.NotFound;
+
+  /**
+   * Remove an add-on from a plan.
+   */
+  @delete
+  @route("/{planAddonId}")
+  @operationId("delete-plan-addon")
+  @summary("Remove an add-on from a plan.")
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
+  deletePlanAddon(
+    @path planId: Shared.ULID,
+    @path planAddonId: Shared.ULID,
+  ): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
 }