doc(edge_services): review wording (#1494)

Author: scaleway-bot

packages/clients/src/api/edge_services/v1alpha1/api.gen.ts

@@ -831,8 +831,10 @@ export class API extends ParentAPI {
     })
 
   /**
-   * Gives information on current edge-services subscription plan and used
-   * resources with associated price.
+   * Gives information on the currently selected Edge Services subscription
+   * plan, resource usage and associated billing information for this calendar
+   * month (including whether consumption falls within or exceeds the currently
+   * selected subscription plan.).
    *
    * @param request - The request {@link GetBillingRequest}
    * @returns A Promise of GetBillingResponse

packages/clients/src/api/edge_services/v1alpha1/types.gen.ts

@@ -283,7 +283,7 @@ export interface PlanDetails {
   planName: PlanName
   /** Amount of egress data from cache included in subscription plan. */
   packageGb: number
-  /** Number of pipeline included in subscription plan. */
+  /** Number of pipelines included in subscription plan. */
   pipelineLimit: number
 }
 
@@ -509,23 +509,39 @@ export type GetBillingRequest = {
 }
 
 export interface GetBillingResponse {
-  /** Information on the current edge-service subscription plan. */
+  /**
+   * Information on the currently-selected, active Edge Services subscription
+   * plan.
+   */
   currentPlan?: PlanDetails
   /** Price of the current subscription plan. */
   planCost?: Money
-  /** Total number of pipeline currently configured. */
+  /** Total number of pipelines currently configured. */
   pipelineNumber: number
-  /** Cost to date of the pipelines not included in the plans. */
+  /**
+   * Cost to date (this month) of pipelines not included in the subscription
+   * plan.
+   */
   extraPipelinesCost?: Money
-  /** Total amount of data egressed from cache in current subscription plan. */
+  /**
+   * Total amount of data egressed from the cache (this month), included in the
+   * active subscription plan.
+   */
   currentPlanCacheUsage: number
-  /** Total amount of data egressed from cache not included in the plans. */
+  /**
+   * Total amount of data egressed from cache (this month), not included in the
+   * active subscription plan.
+   */
   extraCacheUsage: number
-  /** Cost to date of the data egressed from cache not included in the plans. */
+  /**
+   * Cost to date (this month) of the data egressed from the cache that is not
+   * included in the active subscription plan.
+   */
   extraCacheCost?: Money
   /**
-   * Total cost to date of edge-service product for the month including current
-   * plan, previous plans, extra pipelines and extra egress cache data.
+   * Total cost to date (this month) of all Edge Services resources including
+   * active subscription plan, previously active plans, extra pipelines and
+   * extra egress cache data.
    */
   totalCost?: Money
 }