feat(spec): V3 visibility and summary updates

Author: tothandras

api/spec/packages/aip/src/customers/charges/operations.tsp

@@ -37,6 +37,9 @@ interface CustomerChargesOperations {
    *
    * Returns the customer's charges that are represented as either flat fee or usage-based charges.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @get
   @operationId("list-customer-charges")
   @summary("List customer charges")

api/spec/packages/aip/src/customers/credits/operations.tsp

@@ -36,6 +36,9 @@ interface CustomerCreditGrantsOperations {
    * Create a new credit grant.
    * A credit grant represents an allocation of prepaid credits to a customer.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @post
   @operationId("create-credit-grant")
   @summary("Create a new credit grant")
@@ -47,6 +50,9 @@ interface CustomerCreditGrantsOperations {
   /**
    * Get a credit grant.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @get
   @operationId("get-credit-grant")
   @summary("Get a credit grant")
@@ -58,6 +64,9 @@ interface CustomerCreditGrantsOperations {
   /**
    * List credit grants.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @get
   @operationId("list-credit-grants")
   @summary("List credit grants")
@@ -110,6 +119,9 @@ interface CustomerCreditGrantExternalSettlementOperations {
    * Use this endpoint to synchronize the payment state of an external payment
    * with the system so that revenue recognition and credit availability work as expected.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @post
   @operationId("update-credit-grant-external-settlement")
   @summary("Update credit grant external settlement status")
@@ -140,6 +152,9 @@ interface CustomerCreditBalancesOperations {
   /**
    * Get a credit balance.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @get
   @operationId("get-customer-credit-balance")
   @summary("Get a customer's credit balance")
@@ -177,6 +192,9 @@ interface CustomerCreditTransactionOperations {
    * funded credits and consumed credits.
    * Transactions are returned in reverse chronological order by default.
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @get
   @operationId("list-credit-transactions")
   @summary("List credit transactions")
@@ -199,6 +217,9 @@ interface CustomerCreditAdjustmentsOperations {
    * Supported use-cases:
    * - Usage correction
    */
+  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @post
   @operationId("create-credit-adjustment")
   @summary("Create a credit adjustment")

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

@@ -71,6 +71,8 @@ interface EventsOperations {
   /**
    * List ingested events.
    */
+  @extension(Shared.UnstableExtension, true)
+  @extension(Shared.InternalExtension, true)
   @get
   @operationId("list-metering-events")
   @summary("List metering events")

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

@@ -33,7 +33,6 @@ interface FeatureOperations {
   @get
   @operationId("list-features")
   @summary("List features")
-  @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   list(
@@ -67,8 +66,7 @@ interface FeatureOperations {
    */
   @post
   @operationId("create-feature")
-  @summary("Create a feature.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Create feature")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   create(
@@ -82,8 +80,7 @@ interface FeatureOperations {
   @get
   @route("/{featureId}")
   @operationId("get-feature")
-  @summary("Get a feature by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Get feature")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   get(@path featureId: Shared.ULID):
@@ -99,8 +96,7 @@ interface FeatureOperations {
   @patch
   @route("/{featureId}")
   @operationId("update-feature")
-  @summary("Update a feature by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Update feature")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   update(
@@ -114,8 +110,7 @@ interface FeatureOperations {
   @delete
   @route("/{featureId}")
   @operationId("delete-feature")
-  @summary("Delete a feature by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Delete feature")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   delete(
@@ -127,7 +122,6 @@ interface FeatureCostOperations {
   /**
    * Query the cost of a feature.
    */
-  @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   @post

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

@@ -48,6 +48,10 @@ using TypeSpec.OpenAPI;
 @tagMetadata(Shared.TaxTag, #{ description: Shared.TaxDescription })
 @tagMetadata(Shared.FeaturesTag, #{ description: Shared.FeaturesDescription })
 @tagMetadata(Shared.LLMCostTag, #{ description: Shared.LLMCostDescription })
+@tagMetadata(
+  Shared.ProductCatalogTag,
+  #{ description: Shared.ProductCatalogDescription }
+)
 @useAuth(systemAccountAccessToken | personalAccessToken | konnectAccessToken)
 namespace MeteringAndBilling;
 
@@ -160,6 +164,18 @@ interface LLMCostPricesEndpoints extends LLMCost.LLMCostPricesOperations {}
 interface LLMCostOverridesEndpoints
   extends LLMCost.LLMCostOverridesOperations {}
 
+@route("/openmeter/plans")
+@tag(Shared.ProductCatalogTag)
+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/meters/operations.tsp

@@ -72,7 +72,6 @@ interface MetersOperations {
   /**
    * Update a meter.
    */
-  @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   @put
@@ -109,7 +108,6 @@ interface MetersQueryOperations {
    * The three `customer_*` columns are emitted together only when `customer_id`
    * is in the query's `group_by_dimensions`.
    */
-  @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   @post
@@ -122,7 +120,6 @@ interface MetersQueryOperations {
   } | Common.NotFound | Common.ErrorResponses;
 
   #suppress "@openmeter/api-spec-aip/operation-summary" "Avoid duplicating the summary in OpenAPI yaml"
-  @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   @opExample(

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

@@ -37,7 +37,6 @@ interface PlanOperations {
   @get
   @operationId("list-plans")
   @summary("List plans")
-  @extension(Shared.PrivateExtension, true)
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   listPlans(
@@ -67,8 +66,7 @@ interface PlanOperations {
    */
   @post
   @operationId("create-plan")
-  @summary("Create a new plan.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Create plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   createPlan(
@@ -81,8 +79,7 @@ interface PlanOperations {
   @put
   @route("/{planId}")
   @operationId("update-plan")
-  @summary("Update a plan by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Update plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   updatePlan(
@@ -100,8 +97,7 @@ interface PlanOperations {
   @get
   @route("/{planId}")
   @operationId("get-plan")
-  @summary("Get a plan by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Get plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   getPlan(@path planId: Shared.ULID):
@@ -116,8 +112,7 @@ interface PlanOperations {
   @delete
   @route("/{planId}")
   @operationId("delete-plan")
-  @summary("Delete a plan by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Delete plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   deletePlan(
@@ -130,8 +125,7 @@ interface PlanOperations {
   @post
   @route("/{planId}/archive")
   @operationId("archive-plan")
-  @summary("Archive a plan version.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Archive plan version")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   archivePlan(
@@ -144,8 +138,7 @@ interface PlanOperations {
   @post
   @route("/{planId}/publish")
   @operationId("publish-plan")
-  @summary("Publish a plan version.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Publish plan version")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   publishPlan(
@@ -176,8 +169,7 @@ interface AddonOperations {
    */
   @get
   @operationId("list-addons")
-  @summary("List all add-ons.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("List add-ons")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   listAddons(
@@ -210,8 +202,7 @@ interface AddonOperations {
    */
   @post
   @operationId("create-addon")
-  @summary("Create a new add-on.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Create add-on")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   createAddon(
@@ -224,8 +215,7 @@ interface AddonOperations {
   @put
   @route("/{addonId}")
   @operationId("update-addon")
-  @summary("Update an add-on by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Update add-on")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   updateAddon(
@@ -243,8 +233,7 @@ interface AddonOperations {
   @get
   @route("/{addonId}")
   @operationId("get-addon")
-  @summary("Get add-on by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Get add-on")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   getAddon(@path addonId: Shared.ULID):
@@ -259,8 +248,7 @@ interface AddonOperations {
   @delete
   @route("/{addonId}")
   @operationId("delete-addon")
-  @summary("Soft delete add-on by id.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Soft delete add-on")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   deleteAddon(
@@ -273,8 +261,7 @@ interface AddonOperations {
   @post
   @route("/{addonId}/archive")
   @operationId("archive-addon")
-  @summary("Archive an add-on version.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Archive add-on version")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   archiveAddon(
@@ -287,8 +274,7 @@ interface AddonOperations {
   @post
   @route("/{addonId}/publish")
   @operationId("publish-addon")
-  @summary("Publish an add-on version.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Publish add-on version")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   publishAddon(
@@ -302,8 +288,7 @@ interface PlanAddonOperations {
    */
   @get
   @operationId("list-plan-addons")
-  @summary("List add-ons for a plan.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("List add-ons for plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   listPlanAddons(
@@ -316,8 +301,7 @@ interface PlanAddonOperations {
    */
   @post
   @operationId("create-plan-addon")
-  @summary("Add an add-on to a plan.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Add add-on to plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   createPlanAddon(
@@ -331,8 +315,7 @@ interface PlanAddonOperations {
   @get
   @route("/{planAddonId}")
   @operationId("get-plan-addon")
-  @summary("Get an add-on association for a plan.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Get add-on association for plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   getPlanAddon(
@@ -346,8 +329,7 @@ interface PlanAddonOperations {
   @put
   @route("/{planAddonId}")
   @operationId("update-plan-addon")
-  @summary("Update an add-on association for a plan.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Update add-on association for plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   updatePlanAddon(
@@ -362,8 +344,7 @@ interface PlanAddonOperations {
   @delete
   @route("/{planAddonId}")
   @operationId("delete-plan-addon")
-  @summary("Remove an add-on from a plan.")
-  @extension(Shared.PrivateExtension, true)
+  @summary("Remove add-on from plan")
   @extension(Shared.UnstableExtension, true)
   @extension(Shared.InternalExtension, true)
   deletePlanAddon(