fix(api): fix plan update & rate card mapping

* feat(api): fix PUT plan body type & remove timestamps from nested models * fix(api): fix plan update & rate card mapping
openmeterio · Nov 18, 2024 · 62c1165 · 62c1165
1 parent 18f7a67
commit 62c1165
Show file tree

Hide file tree

Showing 16 changed files with 2,143 additions and 2,145 deletions.
diff --git a/api/api.gen.go b/api/api.gen.go
diff --git a/api/client/go/client.gen.go b/api/client/go/client.gen.go
diff --git a/api/client/node/schemas/openapi.ts b/api/client/node/schemas/openapi.ts
diff --git a/api/client/web/src/client/openapi.ts b/api/client/web/src/client/openapi.ts
diff --git a/api/openapi.cloud.yaml b/api/openapi.cloud.yaml
diff --git a/api/openapi.yaml b/api/openapi.yaml
diff --git a/api/spec/src/productcatalog/plan.tsp b/api/spec/src/productcatalog/plan.tsp
@@ -97,14 +97,34 @@ model Plan {
  */
 @friendlyName("PlanPhase")
 model PlanPhase {
-  ...OmitProperties<Resource, "id">;
-
   /**
-   * Unique key among the plan phases. Used to reference the phase in the subscription & plan.
+   * A semi-unique identifier for the resource.
    */
   @visibility("read", "create")
+  @summary("Key")
   key: Key;
 
+  /**
+   * Human-readable name for the resource. Between 1 and 256 characters.
+   */
+  @summary("Display name")
+  @minLength(1)
+  @maxLength(256)
+  name: string;
+
+  /**
+   * Optional description of the resource. Maximum 1024 characters.
+   */
+  @maxLength(1024)
+  @summary("Description")
+  description?: string;
+
+  /**
+   * Additional metadata for the resource.
+   */
+  @summary("Metadata")
+  metadata?: Metadata | null;
+
   /**
    * The rate cards of the plan.
    */

diff --git a/api/spec/src/productcatalog/ratecards.tsp b/api/spec/src/productcatalog/ratecards.tsp
@@ -17,15 +17,41 @@ enum RateCardType {
  */
 @friendlyName("RateCardBase")
 model RateCardBase<T extends RateCardType> {
-  ...OmitProperties<UniqueResource, "id">;
-
   /**
    * The type of the RateCard.
    */
   @visibility("read", "create", "update")
   @summary("RateCard type")
   type: T;
 
+  /**
+   * A semi-unique identifier for the resource.
+   */
+  @visibility("read", "create")
+  @summary("Key")
+  key: Key;
+
+  /**
+   * Human-readable name for the resource. Between 1 and 256 characters.
+   */
+  @summary("Display name")
+  @minLength(1)
+  @maxLength(256)
+  name: string;
+
+  /**
+   * Optional description of the resource. Maximum 1024 characters.
+   */
+  @maxLength(1024)
+  @summary("Description")
+  description?: string;
+
+  /**
+   * Additional metadata for the resource.
+   */
+  @summary("Metadata")
+  metadata?: Metadata | null;
+
   /**
    * The feature the customer is entitled to use.
    */

diff --git a/api/spec/src/productcatalog/routes.tsp b/api/spec/src/productcatalog/routes.tsp
@@ -1,3 +1,5 @@
+import "../rest.tsp";
+
 namespace OpenMeter.ProductCatalog;
 
 using TypeSpec.Http;
@@ -11,7 +13,7 @@ interface Plans {
   /**
    * List all plans.
    */
-  @get
+  @list
   @operationId("listPlans")
   @summary("List plans")
   @extension("x-internal", true)
@@ -56,7 +58,7 @@ interface Plans {
   @extension("x-internal", true)
   create(@body request: TypeSpec.Rest.Resource.ResourceCreateModel<Plan>): {
     @statusCode _: 201;
-    @bodyRoot body: Plan;
+    @body body: Plan;
   } | OpenMeter.CommonErrors;
 
   /**
@@ -68,7 +70,7 @@ interface Plans {
   @extension("x-internal", true)
   update(
     @path planId: ULID,
-    @body request: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Plan>,
+    @body request: TypeSpec.Rest.Resource.ResourceReplaceModel<Plan>,
   ): Plan | OpenMeter.NotFoundError | OpenMeter.CommonErrors;
 
   /**
@@ -111,7 +113,6 @@ interface Plans {
    */
   @post
   @route("/{planId}/publish")
-  @sharedRoute
   @operationId("publishPlan")
   @summary("Publish plan")
   @extension("x-internal", true)
@@ -124,7 +125,6 @@ interface Plans {
    */
   @post
   @route("/{planId}/archive")
-  @sharedRoute
   @operationId("archivePlan")
   @summary("Archive plan version")
   @extension("x-internal", true)
@@ -138,7 +138,6 @@ interface Plans {
    */
   @post
   @route("/{planIdOrKey}/next")
-  @sharedRoute
   @operationId("nextPlan")
   @summary("New draft plan")
   @extension("x-internal", true)
@@ -148,7 +147,7 @@ interface Plans {
     planIdOrKey: PlanIdOrKey,
   ): {
     @statusCode _: 201;
-    @bodyRoot body: Plan;
+    @body body: Plan;
   } | OpenMeter.NotFoundError | OpenMeter.CommonErrors;
 }
 

diff --git a/api/spec/src/query.tsp b/api/spec/src/query.tsp
@@ -21,6 +21,7 @@ model QueryPagination {
   @query
   @minValue(1)
   @example(1)
+  @pageIndex
   page?: integer = 1;
 
   /**
@@ -32,6 +33,7 @@ model QueryPagination {
   @minValue(1)
   @maxValue(1000)
   @example(100)
+  @pageSize
   pageSize?: integer = 100;
 }
 
@@ -122,5 +124,6 @@ model PaginatedResponse<T> {
   /**
    * The items in the current page.
    */
+  @pageItems
   items: T[];
 }
diff --git a/api/spec/src/rest.tsp b/api/spec/src/rest.tsp
@@ -0,0 +1,11 @@
+import "@typespec/rest";
+
+namespace TypeSpec.Rest.Resource {
+  /**
+   * Resource update operation model.
+   * @template Resource The resource model to update with replace.
+   */
+  @friendlyName("{name}ReplaceUpdate", Resource)
+  model ResourceReplaceModel<Resource extends {}>
+    is UpdateableProperties<DefaultKeyVisibility<Resource, "read">>;
+}
diff --git a/api/spec/src/types.tsp b/api/spec/src/types.tsp
@@ -110,7 +110,7 @@ model Resource {
    * Additional metadata for the resource.
    */
   @summary("Metadata")
-  metadata?: Metadata; // FIXME: linter error for: = #{};
+  metadata?: Metadata | null;
 
   ...ResourceTimestamps;
 }

diff --git a/openmeter/productcatalog/plan/adapter/plan.go b/openmeter/productcatalog/plan/adapter/plan.go
@@ -434,6 +434,7 @@ func (a *adapter) UpdatePlan(ctx context.Context, params plan.UpdatePlanInput) (
 		if len(diffResult.Update) > 0 {
 			for _, updateInput := range diffResult.Update {
 				updateInput.Namespace = params.Namespace
+				updateInput.PlanID = p.ID
 
 				phase, err := a.UpdatePhase(ctx, updateInput)
 				if err != nil {