Unify ord_ and sub_ prefixes (#1872)

* 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 * Unify ord_ prefixes * Unify sub_itm_ prefix * Update ord_ prefix ULID * Update subscriptionId example * Remove ambiguous example * Update subscriptionId example * Update subscriptionId example * Remove ambiguous example * Update subscriptionId example * Update subscriptionId example * Remove ambiguous example
Rebilly · May 8, 2024 · d990e9e · d990e9e
1 parent 46d40e8
commit d990e9e
Show file tree

Hide file tree

Showing 15 changed files with 12 additions and 15 deletions.
diff --git a/openapi/components/requestBodies/storefront/PostSubscriptionReactivation.yaml b/openapi/components/requestBodies/storefront/PostSubscriptionReactivation.yaml
@@ -6,7 +6,7 @@ properties:
   orderId:
     type: string
     description: ID of the order associated with the reactivation quote.
-    example: ord_01HRF27SATGE4Z6PBJE6PD8328
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   items:
     type: array
     description: Details of items in the subscription.

diff --git a/openapi/components/schemas/Invoice.yaml b/openapi/components/schemas/Invoice.yaml
@@ -19,7 +19,7 @@ properties:
   orderId:
     description: ID of the order (experimental).
     readOnly: true
-    example: ord_01GYJPRKHBD6ZYHH897QCJMBS4
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
     type:
       - 'string'
       - 'null'

diff --git a/openapi/components/schemas/OneTimeSale.yaml b/openapi/components/schemas/OneTimeSale.yaml
@@ -16,7 +16,7 @@ properties:
     description: ID of the order (experimental).
     readOnly: true
     maxLength: 50
-    example: ord_01GYJPRKHBD6ZYHH897QCJMBS4
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderType:
     description: |-
       Specifies the type of order.

diff --git a/openapi/components/schemas/QuoteChangeOrder.yaml b/openapi/components/schemas/QuoteChangeOrder.yaml
@@ -63,7 +63,7 @@ properties:
     description: ID of the related subscription.
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: sub_01HRF27SATGE4Z6PBJE6PD8328
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/QuoteCreateOrder.yaml b/openapi/components/schemas/QuoteCreateOrder.yaml
@@ -66,7 +66,6 @@ properties:
       - 'string'
       - 'null'
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/QuoteReactivateOrder.yaml b/openapi/components/schemas/QuoteReactivateOrder.yaml
@@ -63,7 +63,7 @@ properties:
     description: ID of the related subscription.
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: sub_01HRF27SATGE4Z6PBJE6PD8328
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/QuoteTrialConversionOrder.yaml b/openapi/components/schemas/QuoteTrialConversionOrder.yaml
@@ -63,7 +63,6 @@ properties:
     description: ID of the related order.
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/StorefrontInvoice.yaml b/openapi/components/schemas/StorefrontInvoice.yaml
@@ -15,7 +15,7 @@ properties:
   orderId:
     description: ID of the order (experimental).
     readOnly: true
-    example: ord_01GYJPRKHBD6ZYHH897QCJMBS4
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
     type:
       - 'string'
       - 'null'

diff --git a/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml b/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml
@@ -57,7 +57,7 @@ properties:
     readOnly: true
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: sub_01HRF27SATGE4Z6PBJE6PD8328
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml b/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml
@@ -60,7 +60,6 @@ properties:
       - 'string'
       - 'null'
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml b/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml
@@ -57,7 +57,7 @@ properties:
     readOnly: true
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: sub_01HRF27SATGE4Z6PBJE6PD8328
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml b/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml
@@ -57,7 +57,7 @@ properties:
     readOnly: true
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: sub_01HRF27SATGE4Z6PBJE6PD8328
   invoiceId:
     type: string
     description: ID of the payment invoice.

diff --git a/openapi/components/schemas/StorefrontSubscription.yaml b/openapi/components/schemas/StorefrontSubscription.yaml
@@ -45,7 +45,7 @@ properties:
       - 'string'
       - 'null'
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   currency:
     description: Currency of the order.
     readOnly: true

diff --git a/openapi/components/schemas/StorefrontUpcomingInvoice.yaml b/openapi/components/schemas/StorefrontUpcomingInvoice.yaml
@@ -16,7 +16,7 @@ properties:
       - 'string'
       - 'null'
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   currency:
     $ref: ./CurrencyCode.yaml
   items:

diff --git a/openapi/components/schemas/Subscription.yaml b/openapi/components/schemas/Subscription.yaml
@@ -16,7 +16,7 @@ properties:
     description: ID of the order (experimental).
     readOnly: true
     maxLength: 50
-    example: ord_01GYJPRKHBD6ZYHH897QCJMBS4
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderType:
     description: |-
       Specifies the type of order.