fix: mandate enum prefixes for generated APIs (#1688)

This disables the heuristics of oapi codegen thus we get stable names.

api/codegen.yaml

@@ -7,4 +7,5 @@ compatibility:
   apply-chi-middleware-first-to-last: true
   # See: https://github.com/oapi-codegen/oapi-codegen/issues/778
   disable-required-readonly-as-pointer: true
+  always-prefix-enum-values: true
 output: ./api.gen.go

api/openapi.yaml

@@ -4325,7 +4325,7 @@ components:
       required: false
       description: The order direction.
       schema:
-        $ref: '#/components/schemas/Order'
+        $ref: '#/components/schemas/SortOrder'
       explode: false
     EntitlementOrderByOrdering.orderBy:
       name: orderBy
@@ -4341,7 +4341,7 @@ components:
       required: false
       description: The order direction.
       schema:
-        $ref: '#/components/schemas/Order'
+        $ref: '#/components/schemas/SortOrder'
       explode: false
     FeatureOrderByOrdering.orderBy:
       name: orderBy
@@ -4357,7 +4357,7 @@ components:
       required: false
       description: The order direction.
       schema:
-        $ref: '#/components/schemas/Order'
+        $ref: '#/components/schemas/SortOrder'
       explode: false
     GrantOrderByOrdering.orderBy:
       name: orderBy
@@ -4485,7 +4485,7 @@ components:
       required: false
       description: The order direction.
       schema:
-        $ref: '#/components/schemas/Order'
+        $ref: '#/components/schemas/SortOrder'
       explode: false
     NotificationChannelOrderByOrdering.orderBy:
       name: orderBy
@@ -4501,7 +4501,7 @@ components:
       required: false
       description: The order direction.
       schema:
-        $ref: '#/components/schemas/Order'
+        $ref: '#/components/schemas/SortOrder'
       explode: false
     NotificationEventOrderByOrdering.orderBy:
       name: orderBy
@@ -4517,7 +4517,7 @@ components:
       required: false
       description: The order direction.
       schema:
-        $ref: '#/components/schemas/Order'
+        $ref: '#/components/schemas/SortOrder'
       explode: false
     NotificationRuleOrderByOrdering.orderBy:
       name: orderBy
@@ -4728,7 +4728,7 @@ components:
           readOnly: true
         status:
           allOf:
-            - $ref: '#/components/schemas/OpenMeter.App.AppStatus'
+            - $ref: '#/components/schemas/AppStatus'
           description: Status of the app connection.
           readOnly: true
       description: |-
@@ -4804,6 +4804,12 @@ components:
           maxItems: 1000
           description: The items in the page.
       description: A page of results.
+    AppStatus:
+      type: string
+      enum:
+        - ready
+        - unauthorized
+      description: App installed status.
     BadRequestProblemResponse:
       type: object
       allOf:
@@ -6465,15 +6471,18 @@ components:
       description: A page of results.
     MeasureUsageFrom:
       oneOf:
-        - $ref: '#/components/schemas/MeasureUsageFromEnum'
+        - $ref: '#/components/schemas/MeasureUsageFromPreset'
         - $ref: '#/components/schemas/MeasureUsageFromTime'
       description: Measure usage from
-    MeasureUsageFromEnum:
+    MeasureUsageFromPreset:
       type: string
       enum:
         - CURRENT_PERIOD_START
         - NOW
       description: Start of measurement options
+      x-enum-varnames:
+        - CurrentPeriodStart
+        - Now
     MeasureUsageFromTime:
       type: string
       format: date-time
@@ -6731,6 +6740,8 @@ components:
       enum:
         - WEBHOOK
       description: Type of the notification channel.
+      x-enum-varnames:
+        - Webhook
     NotificationChannelWebhook:
       type: object
       required:
@@ -6988,15 +6999,10 @@ components:
         - channel
       properties:
         state:
-          type: string
-          enum:
-            - SUCCESS
-            - FAILED
-            - SENDING
-            - PENDING
+          allOf:
+            - $ref: '#/components/schemas/NotificationEventDeliveryStatusState'
           example: SUCCESS
           description: Delivery state of the notification event to the channel.
-          title: Delivery State
           readOnly: true
         reason:
           type: string
@@ -7018,6 +7024,20 @@ components:
           title: Notification Channel
           readOnly: true
       description: The delivery status of the notification event.
+    NotificationEventDeliveryStatusState:
+      type: string
+      enum:
+        - SUCCESS
+        - FAILED
+        - SENDING
+        - PENDING
+      description: The delivery state of the notification event to the channel.
+      title: Delivery State
+      x-enum-varnames:
+        - Success
+        - Failed
+        - Sending
+        - Pending
     NotificationEventOrderBy:
       type: string
       enum:
@@ -7215,14 +7235,21 @@ components:
           description: Value of the threshold.
           title: Threshold Value
         type:
-          type: string
-          enum:
-            - PERCENT
-            - NUMBER
+          allOf:
+            - $ref: '#/components/schemas/NotificationRuleBalanceThresholdValueType'
           example: NUMBER
           description: Type of the threshold.
-          title: Threshold Type
       description: Threshold value with multiple supported types.
+    NotificationRuleBalanceThresholdValueType:
+      type: string
+      enum:
+        - PERCENT
+        - NUMBER
+      description: Type of the rule in the balance threshold specification.
+      title: Notification balance threshold type
+      x-enum-varnames:
+        - Percent
+        - Number
     NotificationRuleCreateRequest:
       type: object
       allOf:
@@ -7273,36 +7300,11 @@ components:
         - server_error
         - temporarily_unavailable
       description: OAuth2 authorization code grant error types.
-    OpenMeter.App.AppStatus:
-      type: string
-      enum:
-        - ready
-        - unauthorized
-      description: App installed status.
-    OpenMeter.App.StripePaymentIntentStatus:
-      type: string
-      enum:
-        - canceled
-        - processing
-        - requires_action
-        - requires_confirmation
-        - requires_payment_method
-        - succeeded
-      description: Stripe payment intent status.
     OpenMeter.App.Type:
       type: string
       enum:
         - stripe
       description: Type of the app.
-    Order:
-      type: string
-      enum:
-        - ASC
-        - DESC
-      description: The order direction.
-      x-enum-varnames:
-        - SortOrderASC
-        - SortOrderDESC
     Period:
       type: object
       required:
@@ -7448,6 +7450,12 @@ components:
       allOf:
         - $ref: '#/components/schemas/UnexpectedProblemResponse'
       description: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
+    SortOrder:
+      type: string
+      enum:
+        - ASC
+        - DESC
+      description: The order direction.
     StripeApp:
       type: object
       required:
@@ -7512,7 +7520,7 @@ components:
           readOnly: true
         status:
           allOf:
-            - $ref: '#/components/schemas/OpenMeter.App.AppStatus'
+            - $ref: '#/components/schemas/AppStatus'
           description: Status of the app connection.
           readOnly: true
         type:
@@ -7559,6 +7567,16 @@ components:
       enum:
         - setup
       description: Stripe CheckoutSession.mode
+    StripePaymentIntentStatus:
+      type: string
+      enum:
+        - canceled
+        - processing
+        - requires_action
+        - requires_confirmation
+        - requires_payment_method
+        - succeeded
+      description: Stripe payment intent status.
     StripeSetupIntent:
       type: object
       required:
@@ -7572,7 +7590,7 @@ components:
           description: The setup intent id.
         status:
           allOf:
-            - $ref: '#/components/schemas/OpenMeter.App.StripePaymentIntentStatus'
+            - $ref: '#/components/schemas/StripePaymentIntentStatus'
           description: The setup intent status.
         payment_method:
           type: string

api/spec/src/app/app.tsp

@@ -98,6 +98,7 @@ model AppBase {
 /**
  * App installed status.
  */
+@friendlyName("AppStatus")
 enum AppStatus {
   /**
    * The app is ready to be used.

api/spec/src/app/stripe.tsp

@@ -347,6 +347,7 @@ model StripeSetupIntent {
 /**
  * Stripe payment intent status.
  */
+@friendlyName("StripePaymentIntentStatus")
 enum StripePaymentIntentStatus {
   Canceled: "canceled",
   Processing: "processing",

api/spec/src/entitlements/entitlements.tsp

@@ -337,8 +337,9 @@ model EntitlementStatic {
 /**
  * Start of measurement options
  */
-@friendlyName("MeasureUsageFromEnum")
-enum MeasureUsageFromEnum {
+@friendlyName("MeasureUsageFromPreset")
+@extension("x-enum-varnames", ["CurrentPeriodStart", "Now"])
+enum MeasureUsageFromPreset {
   #suppress "@openmeter/api-spec/casing" "Use existing values"
   CURRENT_PERIOD_START: "CURRENT_PERIOD_START",
   #suppress "@openmeter/api-spec/casing" "Use existing values"
@@ -354,6 +355,6 @@ scalar MeasureUsageFromTime extends DateTime;
 @friendlyName("MeasureUsageFrom")
 @oneOf
 union MeasureUsageFrom {
-  `enum`: MeasureUsageFromEnum,
+  preset: MeasureUsageFromPreset,
   time: MeasureUsageFromTime,
 }

api/spec/src/notification/channel.tsp

@@ -12,6 +12,7 @@ namespace OpenMeter.Notification;
  * Type of the notification channel.
  */
 @friendlyName("NotificationChannelType")
+@extension("x-enum-varnames", ["Webhook"])
 enum NotificationChannelType {
   #suppress "@openmeter/api-spec/casing" "Ignore due to backward compatibility"
   webhook: "WEBHOOK",

api/spec/src/notification/event.tsp

@@ -26,9 +26,8 @@ model NotificationEventDeliveryStatus {
    * Delivery state of the notification event to the channel.
    */
   @visibility("read")
-  @summary("Delivery State")
-  @example("SUCCESS")
-  state: "SUCCESS" | "FAILED" | "SENDING" | "PENDING";
+  @example(NotificationEventDeliveryStatusState.Success)
+  state: NotificationEventDeliveryStatusState;
 
   /**
    * The reason of the last deliverry state update.
@@ -54,6 +53,19 @@ model NotificationEventDeliveryStatus {
   channel: NotificationChannelMeta;
 }
 
+/**
+ * The delivery state of the notification event to the channel.
+ */
+@friendlyName("NotificationEventDeliveryStatusState")
+@summary("Delivery State")
+@extension("x-enum-varnames", ["Success", "Failed", "Sending", "Pending"])
+enum NotificationEventDeliveryStatusState {
+  Success: "SUCCESS",
+  Failed: "FAILED",
+  Sending: "SENDING",
+  Pending: "PENDING",
+}
+
 /**
  * The delivery status of the notification event.
  */

api/spec/src/notification/rule.tsp

@@ -85,9 +85,19 @@ model NotificationRuleBalanceThresholdValue {
    * Type of the threshold.
    */
   @visibility("read", "create", "update")
-  @summary("Threshold Type")
-  @example("NUMBER")
-  type: "PERCENT" | "NUMBER";
+  @example(NotificationRuleBalanceThresholdValueType.NUMBER)
+  type: NotificationRuleBalanceThresholdValueType;
+}
+
+/**
+ * Type of the rule in the balance threshold specification.
+ */
+@summary("Notification balance threshold type")
+@friendlyName("NotificationRuleBalanceThresholdValueType")
+@extension("x-enum-varnames", ["Percent", "Number"])
+enum NotificationRuleBalanceThresholdValueType {
+  PERCENT,
+  NUMBER,
 }
 
 /**

api/spec/src/query.tsp

@@ -71,8 +71,8 @@ model QueryOrdering<T> {
    * The order direction.
    */
   @query
-  @example(Order.ASC)
-  order?: Order;
+  @example(SortOrder.ASC)
+  order?: SortOrder;
 
   /**
    * The order by field.
@@ -88,9 +88,8 @@ model QueryOrdering<T> {
 /**
  * The order direction.
  */
-@friendlyName("Order")
-@extension("x-enum-varnames", ["SortOrderASC", "SortOrderDESC"])
-enum Order {
+@friendlyName("SortOrder")
+enum SortOrder {
   #suppress "@openmeter/api-spec/casing" "Use existing values"
   ASC: "ASC",
   #suppress "@openmeter/api-spec/casing" "Use existing values"