Add detail to default instrument description (#1846)

* Add detail to default instrument description * Fix typo * Fix description issue related to anyOf * Update description * Update related descriptions * Update remaining descriptions
Rebilly · Apr 3, 2024 · 2d67c72 · 2d67c72
1 parent 089ee5c
commit 2d67c72
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 13 deletions.
diff --git a/openapi/components/schemas/AlternativePaymentInstrument.yaml b/openapi/components/schemas/AlternativePaymentInstrument.yaml
@@ -1,5 +1,10 @@
-description: Alternative payment method instrument.
 title: Alternative instrument
+description: |-
+        Alternative payment method instrument.
+
+        To use this payment instrument for automatic subscription renewals,
+        and for transactions when no specific payment instrument is provided by the user,
+        set this as the default payment instrument.
 type: object
 required:
   - method

diff --git a/openapi/components/schemas/CashInstrument.yaml b/openapi/components/schemas/CashInstrument.yaml
@@ -1,5 +1,10 @@
-description: Cash payment instrument object.
 title: Cash
+description: |-
+        Cash payment instrument object.
+
+        To use this payment instrument for automatic subscription renewals,
+        and for transactions when no specific payment instrument is provided by the user,
+        set this as the default payment instrument.
 type: object
 required:
   - method

diff --git a/openapi/components/schemas/CheckInstrument.yaml b/openapi/components/schemas/CheckInstrument.yaml
@@ -1,5 +1,10 @@
-description: Check payment instrument object.
 title: Check
+description: |-
+        Check payment instrument object.
+
+        To use this payment instrument for automatic subscription renewals,
+        and for transactions when no specific payment instrument is provided by the user,
+        set this as the default payment instrument.
 type: object
 required:
   - method

diff --git a/openapi/components/schemas/Customer.yaml b/openapi/components/schemas/Customer.yaml
@@ -45,7 +45,6 @@ properties:
       The token expires after first use.
 # TODO Check if it's valid. Might require a oneOf instead.
   defaultPaymentInstrument:
-    description: Default payment instrument information.
     anyOf:
       - $ref: ./VaultedInstrument.yaml
       - $ref: ./AlternativePaymentInstrument.yaml

diff --git a/openapi/components/schemas/FlexiblePlan.yaml b/openapi/components/schemas/FlexiblePlan.yaml
@@ -1,9 +1,5 @@
 allOf:
   - type: object
-    description: |-
-      Customize an existing plan for the current order.
-
-      To create a new plan, see [Create a plan](https://www.rebilly.com/catalog/all/Plans/PostPlan).
     required:
       - id
     properties:

diff --git a/openapi/components/schemas/StorefrontAccount.yaml b/openapi/components/schemas/StorefrontAccount.yaml
@@ -24,7 +24,10 @@ properties:
       This token may only be used once before it expires.
   defaultPaymentInstrument:
     type: object
-    description: Default payment instrument information.
+    description: |-
+      Default payment instrument.
+      The default payment instrument is used to automatically pay subscription renewals,
+      and for transaction requests where a specific payment instrument is not provided.
     required:
       - method
     properties:

diff --git a/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml b/openapi/components/schemas/SubscriptionOrOneTimeSaleItem.yaml
@@ -22,7 +22,6 @@ properties:
     description: Number of filled product units.
     type: integer
   plan:
-    description: Details of the plan.
     anyOf:
       - $ref: ./OriginalPlan.yaml
       - $ref: ./FlexiblePlan.yaml

diff --git a/openapi/components/schemas/Transaction.yaml b/openapi/components/schemas/Transaction.yaml
@@ -394,7 +394,6 @@ properties:
     readOnly: true
   paymentInstrument:
     type: object
-    description: Payment instrument information.
     anyOf:
       - $ref: ./VaultedInstrument.yaml
       - $ref: ./AlternativePaymentInstrument.yaml

diff --git a/openapi/components/schemas/VaultedInstrument.yaml b/openapi/components/schemas/VaultedInstrument.yaml
@@ -1,5 +1,10 @@
-description: Vaulted payment instrument.
-title: Vaulted instrument
+title: Vaulted payment instrument
+description: |-
+        Vaulted payment instrument.
+
+        To use this payment instrument for automatic subscription renewals,
+        and for transactions when no specific payment instrument is provided by the user,
+        set this as the default payment instrument.
 required:
   - method
   - paymentInstrumentId