Update ord_* prefix examples to sub_* (#1864)

* Update ord_cnl_ to sub_cnl_ * Update ord_itm_ to sub_itm_ * Update ord_pau_ to sub_pau_ * Update ord_rct_ to sub_rct_ * Update ord_usg_ to sub_usg_ * Update ord_ to sub_ * Change back sub_ to ord_ prefix * Update description of the subscription item * Update sub_itm_ to sub_ prefix * Update ULID prefix * Update one-time-sale example prefix to ots_ * Update openapi/components/schemas/OneTimeSale.yaml * Update one-time sale example * Update example of the one-time sale
Rebilly · May 3, 2024 · a715f89 · a715f89
1 parent ee5b5ba
commit a715f89
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 15 deletions.
diff --git a/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml b/openapi/components/requestBodies/Webhooks/SubscriptionAndSubscriptionPause.yaml
@@ -9,7 +9,7 @@ content:
         subscriptionPauseId:
           type: string
           description: ID of the subscription pause.
-          example: ord_pau_01H085J3ZR1WKD120D73D7N4C9
+          example: sub_pau_01H085J3ZR1WKD120D73D7N4C9
         eventType:
           type: string
           description: Type of webhook event.

diff --git a/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml b/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml
@@ -8,8 +8,8 @@ content:
           example: sub_01HRF27SATGE4Z6PBJE6PD8328
         subscriptionItemId:
           type: string
-          description: ID of the order item.
-          example: ord_itm_01GYJPRKHBD6ZYHH897QCJMBS4
+          description: ID of the subscription item.
+          example: sub_01HW2V1Y3A6QPM1NX4WCYHFSRS
         planId:
           type: string
           description: ID of the plan.

diff --git a/openapi/components/requestBodies/storefront/PatchOrder.yaml b/openapi/components/requestBodies/storefront/PatchOrder.yaml
@@ -31,9 +31,9 @@ content:
             properties:
               itemId:
                 type: string
-                description: ID of order item.
+                description: ID of the subscription item.
                 maxLength: 50
-                example: ord_itm_0YV7DENSVGDBW9S71XZNNYYQ0X
+                example: sub_01HW2V1Y3A6QPM1NX4WCYHFSRS
               limits:
                 type: [ 'object', 'null' ]
                 description: |-

diff --git a/openapi/components/schemas/OneTimeSale.yaml b/openapi/components/schemas/OneTimeSale.yaml
@@ -7,10 +7,10 @@ required:
 properties:
   id:
     type: string
-    description: ID of the order.
+    description: ID of the one-time sale.
     readOnly: true
     maxLength: 50
-    example: pur_01HRF26JK5Y6TEZ9MR014HW27Z
+    example: ots_01HRF27SATGE4Z6PBJE6PD8328
   orderId:
     type: string
     description: ID of the order (experimental).

diff --git a/openapi/components/schemas/StorefrontOneTimeSale.yaml b/openapi/components/schemas/StorefrontOneTimeSale.yaml
@@ -2,10 +2,10 @@ type: object
 properties:
   id:
     type: string
-    description: ID of the order.
+    description: ID of the one-time sale.
     readOnly: true
     maxLength: 50
-    example: pur_01HRF26JK5Y6TEZ9MR014HW27Z
+    example: ots_01HRF27SATGE4Z6PBJE6PD8328
   orderType:
     description: |-
       Specifies the type of order.

diff --git a/openapi/components/schemas/SubscriptionCancellation.yaml b/openapi/components/schemas/SubscriptionCancellation.yaml
@@ -8,7 +8,7 @@ properties:
     description: ID of the cancellation.
     readOnly: true
     maxLength: 50
-    example: ord_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV
+    example: sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV
   subscriptionId:
     type: string
     description: ID of the canceled subscription order.

diff --git a/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml b/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml
@@ -7,7 +7,6 @@ properties:
     description: ID of the order item.
     readOnly: true
     maxLength: 50
-    example: ord_itm_0YVJ6172Q2CXW9VP7KJMKHCMMX
   planId:
     description: ID of the plan.
     deprecated: true

diff --git a/openapi/components/schemas/SubscriptionPause.yaml b/openapi/components/schemas/SubscriptionPause.yaml
@@ -8,7 +8,7 @@ properties:
     description: ID of the subscription pause.
     readOnly: true
     maxLength: 50
-    example: ord_pau_01H085J3ZR1WKD120D73D7N4C9
+    example: sub_pau_01H085J3ZR1WKD120D73D7N4C9
   subscriptionId:
     type: string
     description: ID of the paused subscription.

diff --git a/openapi/components/schemas/SubscriptionReactivation.yaml b/openapi/components/schemas/SubscriptionReactivation.yaml
@@ -7,7 +7,7 @@ properties:
     description: ID of the reactivation.
     readOnly: true
     maxLength: 50
-    example: ord_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0
+    example: sub_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0
   subscriptionId:
     type: string
     description: ID of the reactivated subscription.
@@ -18,7 +18,7 @@ properties:
     description: ID of the related cancellation.
     readOnly: true
     maxLength: 50
-    example: ord_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV
+    example: sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV
   description:
     description: Description of the reactivation reason in free form.
     type:

diff --git a/openapi/components/schemas/Usage.yaml b/openapi/components/schemas/Usage.yaml
@@ -9,7 +9,7 @@ properties:
     readOnly: true
     description: ID of the usage record.
     maxLength: 50
-    example: ord_usg_0YVJ636B95DNA9M3B1638HXBCQ
+    example: sub_usg_0YVJ636B95DNA9M3B1638HXBCQ
   subscriptionId:
     type: string
     description: ID of the subscription for which a usage is reported.