fix(api): v3 resource mixin required created_at and updated_at (#4295)

Author: tothandras

api/spec/packages/aip/src/currencies/cost-bases/cost-basis.tsp

@@ -34,5 +34,5 @@ model CostBasis {
    * An ISO-8601 timestamp representation of entity creation date.
    */
   @visibility(Lifecycle.Read)
-  created_at?: Shared.DateTime;
+  created_at: Shared.DateTime;
 }

api/spec/packages/aip/src/currencies/currency.tsp

@@ -114,5 +114,5 @@ model CurrencyCustom {
    * An ISO-8601 timestamp representation of the custom currency creation date.
    */
   @visibility(Lifecycle.Read)
-  created_at?: Shared.DateTime;
+  created_at: Shared.DateTime;
 }

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

@@ -68,7 +68,10 @@ interface CustomerChargesOperations {
     filter?: ListCustomerChargesParamsFilter,
 
     /**
-     * Expands
+     * Expand full objects for referenced entities.
+     *
+     * Supported values are:
+     * - `real_time_usage`: Expand the charge's real-time usage.
      */
     @query(#{ name: "expand", explode: true })
     expand?: ChargesExpand[],

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

@@ -141,11 +141,6 @@ model GetCreditBalanceParamsFilter {
    * Filter credit balance by currency.
    */
   currency?: Currencies.CurrencyCode;
-
-  /**
-   * Filter by specific feature.
-   */
-  feature?: Shared.ResourceKey;
 }
 
 interface CustomerCreditBalancesOperations {

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

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

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

@@ -34,7 +34,7 @@ interface FeatureOperations {
   @operationId("list-features")
   @summary("List features")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   list(
     ...Common.PagePaginationQuery,
 
@@ -68,7 +68,7 @@ interface FeatureOperations {
   @operationId("create-feature")
   @summary("Create feature")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   create(
     @body
     feature: Shared.CreateRequest<Feature>,
@@ -82,7 +82,7 @@ interface FeatureOperations {
   @operationId("get-feature")
   @summary("Get feature")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   get(@path featureId: Shared.ULID):
     | Shared.GetResponse<Feature>
     | Common.ErrorResponses
@@ -98,7 +98,7 @@ interface FeatureOperations {
   @operationId("update-feature")
   @summary("Update feature")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   update(
     @path featureId: Shared.ULID,
     @body feature: FeatureUpdateRequest,
@@ -112,7 +112,7 @@ interface FeatureOperations {
   @operationId("delete-feature")
   @summary("Delete feature")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   delete(
     @path featureId: Shared.ULID,
   ): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
@@ -123,7 +123,7 @@ interface FeatureCostOperations {
    * Query the cost of a feature.
    */
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   @post
   @route("/query")
   @operationId("query-feature-cost")

api/spec/packages/aip/src/llmcost/prices.tsp

@@ -77,11 +77,11 @@ model Price {
 
   /** Creation timestamp. */
   @visibility(Lifecycle.Read)
-  created_at?: Shared.DateTime;
+  created_at: Shared.DateTime;
 
   /** Last update timestamp. */
   @visibility(Lifecycle.Read)
-  updated_at?: Shared.DateTime;
+  updated_at: Shared.DateTime;
 }
 
 /**

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

@@ -88,7 +88,7 @@ interface MetersOperations {
    * Update a meter.
    */
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   @put
   @operationId("update-meter")
   @summary("Update meter")
@@ -124,7 +124,7 @@ interface MetersQueryOperations {
    * is in the query's `group_by_dimensions`.
    */
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   @post
   @operationId("query-meter")
   @summary("Query meter")
@@ -136,7 +136,7 @@ interface MetersQueryOperations {
 
   #suppress "@openmeter/api-spec-aip/operation-summary" "Avoid duplicating the summary in OpenAPI yaml"
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   @opExample(
     #{
       returnType: #{

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

@@ -38,7 +38,7 @@ interface PlanOperations {
   @operationId("list-plans")
   @summary("List plans")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   listPlans(
     ...Common.PagePaginationQuery,
 
@@ -68,7 +68,7 @@ interface PlanOperations {
   @operationId("create-plan")
   @summary("Create plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   createPlan(
     @body plan: Shared.CreateRequest<Plan>,
   ): Shared.CreateResponse<Plan> | Common.ErrorResponses;
@@ -81,7 +81,7 @@ interface PlanOperations {
   @operationId("update-plan")
   @summary("Update plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   updatePlan(
     @path planId: Shared.ULID,
     @body plan: Shared.UpsertRequest<Plan>,
@@ -99,7 +99,7 @@ interface PlanOperations {
   @operationId("get-plan")
   @summary("Get plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   getPlan(@path planId: Shared.ULID):
     | Shared.GetResponse<Plan>
     | Common.ErrorResponses
@@ -114,7 +114,7 @@ interface PlanOperations {
   @operationId("delete-plan")
   @summary("Delete plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   deletePlan(
     @path planId: Shared.ULID,
   ): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
@@ -127,7 +127,7 @@ interface PlanOperations {
   @operationId("archive-plan")
   @summary("Archive plan version")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   archivePlan(
     @path planId: Shared.ULID,
   ): Shared.UpdateResponse<Plan> | Common.ErrorResponses | Common.NotFound;
@@ -140,7 +140,7 @@ interface PlanOperations {
   @operationId("publish-plan")
   @summary("Publish plan version")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   publishPlan(
     @path planId: Shared.ULID,
   ): Shared.UpdateResponse<Plan> | Common.ErrorResponses | Common.NotFound;
@@ -171,7 +171,7 @@ interface AddonOperations {
   @operationId("list-addons")
   @summary("List add-ons")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   listAddons(
     ...Common.PagePaginationQuery,
 
@@ -204,7 +204,7 @@ interface AddonOperations {
   @operationId("create-addon")
   @summary("Create add-on")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   createAddon(
     @body addon: Shared.CreateRequest<Addon>,
   ): Shared.CreateResponse<Addon> | Common.ErrorResponses;
@@ -217,7 +217,7 @@ interface AddonOperations {
   @operationId("update-addon")
   @summary("Update add-on")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   updateAddon(
     @path addonId: Shared.ULID,
     @body addon: Shared.UpsertRequest<Addon>,
@@ -235,7 +235,7 @@ interface AddonOperations {
   @operationId("get-addon")
   @summary("Get add-on")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   getAddon(@path addonId: Shared.ULID):
     | Shared.GetResponse<Addon>
     | Common.ErrorResponses
@@ -250,7 +250,7 @@ interface AddonOperations {
   @operationId("delete-addon")
   @summary("Soft delete add-on")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   deleteAddon(
     @path addonId: Shared.ULID,
   ): Shared.DeleteResponse | Common.ErrorResponses | Common.NotFound;
@@ -263,7 +263,7 @@ interface AddonOperations {
   @operationId("archive-addon")
   @summary("Archive add-on version")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   archiveAddon(
     @path addonId: Shared.ULID,
   ): Shared.UpdateResponse<Addon> | Common.ErrorResponses | Common.NotFound;
@@ -276,7 +276,7 @@ interface AddonOperations {
   @operationId("publish-addon")
   @summary("Publish add-on version")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   publishAddon(
     @path addonId: Shared.ULID,
   ): Shared.UpdateResponse<Addon> | Common.ErrorResponses | Common.NotFound;
@@ -290,7 +290,7 @@ interface PlanAddonOperations {
   @operationId("list-plan-addons")
   @summary("List add-ons for plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   listPlanAddons(
     @path planId: Shared.ULID,
     ...Common.PagePaginationQuery,
@@ -303,7 +303,7 @@ interface PlanAddonOperations {
   @operationId("create-plan-addon")
   @summary("Add add-on to plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   createPlanAddon(
     @path planId: Shared.ULID,
     @body plan_addon: Shared.CreateRequest<PlanAddon>,
@@ -317,7 +317,7 @@ interface PlanAddonOperations {
   @operationId("get-plan-addon")
   @summary("Get add-on association for plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   getPlanAddon(
     @path planId: Shared.ULID,
     @path planAddonId: Shared.ULID,
@@ -331,7 +331,7 @@ interface PlanAddonOperations {
   @operationId("update-plan-addon")
   @summary("Update add-on association for plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   updatePlanAddon(
     @path planId: Shared.ULID,
     @path planAddonId: Shared.ULID,
@@ -346,7 +346,7 @@ interface PlanAddonOperations {
   @operationId("delete-plan-addon")
   @summary("Remove add-on from plan")
   @extension(Shared.UnstableExtension, true)
-  @extension(Shared.PrivateExtension, true)
+  @extension(Shared.InternalExtension, true)
   deletePlanAddon(
     @path planId: Shared.ULID,
     @path planAddonId: Shared.ULID,

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

@@ -59,9 +59,8 @@ model Plan {
 
   /**
    * Whether pro-rating is enabled for this plan.
-   *
-   * TODO: WIP — pro-rating mode and exact semantics will be defined in a later iteration.
    */
+  // TODO: WIP — pro-rating mode and exact semantics will be defined in a later iteration.
   @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update)
   @summary("Pro-rating enabled")
   pro_rating_enabled?: boolean = true;