feat: add Quote/Transaction discriminators and remove inline examples

openapi/components/schemas/quotes/Quote.yaml

@@ -42,45 +42,16 @@ properties:
   source:
     $ref: ./QuoteSource.yaml
   destination:
+    required:
+      - destinationType
     oneOf:
-      - title: Account Destination
-        type: object
-        required:
-          - accountId
-        properties:
-          accountId:
-            type: string
-            description: Destination account identifier
-            example: ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
-          currency:
-            type: string
-            description: Currency code for the destination account
-            example: EUR
-        description: Destination account details
-      - title: UMA Address Destination
-        type: object
-        required:
-          - umaAddress
-        properties:
-          umaAddress:
-            type: string
-            description: UMA address of the recipient
-            example: $receiver@uma.domain.com
-          currency:
-            type: string
-            description: Currency code for the destination
-            example: EUR
-          counterpartyInformation:
-            type: object
-            description: >-
-              Information about the recipient, as required by the platform in their
-              configuration.
-            additionalProperties: true
-            example:
-              FULL_NAME: Jane Receiver
-              BIRTH_DATE: '1990-01-01'
-              NATIONALITY: FR
-        description: UMA address destination details
+      - $ref: ./QuoteAccountDestination.yaml
+      - $ref: ./QuoteUmaAddressDestination.yaml
+    discriminator:
+      propertyName: destinationType
+      mapping:
+        ACCOUNT: ./QuoteAccountDestination.yaml
+        UMA_ADDRESS: ./QuoteUmaAddressDestination.yaml
   sendingCurrency:
     $ref: ../common/Currency.yaml
     description: Currency for the sending amount
@@ -120,15 +91,6 @@ properties:
     description: Payment instructions for executing the payment. This is not required when using an internal account source.
     items:
       $ref: ../common/PaymentInstructions.yaml
-    example:
-      - accountType: US_ACCOUNT
-        accountNumber: "1234567890"
-        routingNumber: "021000021"
-        bankName: "Chase Bank"
-        referenceCode: "REF123456"
-      - accountType: SPARK_WALLET
-        address: "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu"
-        invoice: "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
   transactionId:
     type: string
     description: The ID of the transaction created from this quote.

openapi/components/schemas/quotes/QuoteAccountDestination.yaml

@@ -0,0 +1,18 @@
+type: object
+required:
+  - destinationType
+  - accountId
+properties:
+  destinationType:
+    type: string
+    const: ACCOUNT
+    description: Destination type identifier
+  accountId:
+    type: string
+    description: Destination account identifier
+    example: ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
+  currency:
+    type: string
+    description: Currency code for the destination account
+    example: EUR
+description: Destination account details

openapi/components/schemas/quotes/QuoteAccountSource.yaml

@@ -0,0 +1,14 @@
+type: object
+required:
+  - sourceType
+  - accountId
+properties:
+  sourceType:
+    type: string
+    const: ACCOUNT
+    description: Source type identifier
+  accountId:
+    type: string
+    description: Source account identifier
+    example: InternalAccount:85dcbd6-dced-4ec4-b756-3c3a9ea3d965
+description: Source account details

openapi/components/schemas/quotes/QuoteRealtimeFundingSource.yaml

@@ -0,0 +1,27 @@
+type: object
+required:
+  - sourceType
+  - currency
+properties:
+  sourceType:
+    type: string
+    const: REALTIME_FUNDING
+    description: Source type identifier
+  customerId:
+    type: string
+    description: >-
+      Source customer ID. If this transaction is being initiated on behalf of a customer, this is required.
+      If customerId is not provided, the quote will be created on behalf of the platform itself.
+    example: Customer:019542f5-b3e7-1d02-0000-000000000009
+  currency:
+    type: string
+    description: >-
+      Currency code for the funding source. See
+      [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
+      for the full list of supported fiat and crypto currencies.
+    example: USD
+description: >-
+  Fund the quote using a real-time funding source (RTP, SEPA Instant, Spark, Stables, etc.).
+  This will require manual just-in-time funding using `paymentInstructions` in the response.
+  Because quotes expire quickly, this option is only valid for instant payment methods. Do not try
+  to fund a quote with a non-instant payment method (ACH, etc.).

openapi/components/schemas/quotes/QuoteRequest.yaml

@@ -19,53 +19,17 @@ properties:
   destination:
     oneOf:
       - title: Account
-        type: object
-        required:
-          - accountId
-          - currency
-        properties:
-          accountId:
-            type: string
-            description: Destination account identifier
-            example: a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
-          currency:
-            type: string
-            description: >-
-              Currency code for the destination account. See
-              [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
-              for the full list of supported fiat and crypto currencies.
-            example: EUR
-        description: Destination account details
+        $ref: ./QuoteRequestAccountDestination.yaml
       - title: UMA Address
-        type: object
-        required:
-          - umaAddress
-          - currency
-        properties:
-          umaAddress:
-            type: string
-            description: UMA address of the recipient
-            example: $receiver@uma.domain.com
-          currency:
-            type: string
-            description: >-
-              Currency code for the destination. See
-              [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
-              for the full list of supported fiat and crypto currencies.
-            example: EUR
-        description: UMA address destination details
+        $ref: ./QuoteRequestUmaAddressDestination.yaml
       - title: External Account Details
-        type: object
-        required:
-          - externalAccountDetails
-        properties:
-          externalAccountDetails:
-            $ref: ../external_accounts/ExternalAccountCreateRequest.yaml
-        description: >-
-          A convenient destination option which adds the external account and creates
-          the quote in one step rather than first needing to call /external-accounts
-          to add the account. Useful for one-off payments to some destination.
-          See the external accounts endpoints for test values in sandbox mode.
+        $ref: ./QuoteRequestExternalAccountDetailsDestination.yaml
+    discriminator:
+      propertyName: destinationType
+      mapping:
+        ACCOUNT: ./QuoteRequestAccountDestination.yaml
+        UMA_ADDRESS: ./QuoteRequestUmaAddressDestination.yaml
+        EXTERNAL_ACCOUNT_DETAILS: ./QuoteRequestExternalAccountDetailsDestination.yaml
   lockedCurrencySide:
     $ref: ./QuoteLockSide.yaml
   lockedCurrencyAmount:

openapi/components/schemas/quotes/QuoteRequestAccountDestination.yaml

@@ -0,0 +1,22 @@
+type: object
+required:
+  - destinationType
+  - accountId
+  - currency
+properties:
+  destinationType:
+    type: string
+    const: ACCOUNT
+    description: Destination type identifier
+  accountId:
+    type: string
+    description: Destination account identifier
+    example: a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
+  currency:
+    type: string
+    description: >-
+      Currency code for the destination account. See
+      [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
+      for the full list of supported fiat and crypto currencies.
+    example: EUR
+description: Destination account details

openapi/components/schemas/quotes/QuoteRequestExternalAccountDetailsDestination.yaml

@@ -0,0 +1,16 @@
+type: object
+required:
+  - destinationType
+  - externalAccountDetails
+properties:
+  destinationType:
+    type: string
+    const: EXTERNAL_ACCOUNT_DETAILS
+    description: Destination type identifier
+  externalAccountDetails:
+    $ref: ../external_accounts/ExternalAccountCreateRequest.yaml
+description: >-
+  A convenient destination option which adds the external account and creates
+  the quote in one step rather than first needing to call /external-accounts
+  to add the account. Useful for one-off payments to some destination.
+  See the external accounts endpoints for test values in sandbox mode.

openapi/components/schemas/quotes/QuoteRequestUmaAddressDestination.yaml

@@ -0,0 +1,22 @@
+type: object
+required:
+  - destinationType
+  - umaAddress
+  - currency
+properties:
+  destinationType:
+    type: string
+    const: UMA_ADDRESS
+    description: Destination type identifier
+  umaAddress:
+    type: string
+    description: UMA address of the recipient
+    example: $receiver@uma.domain.com
+  currency:
+    type: string
+    description: >-
+      Currency code for the destination. See
+      [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
+      for the full list of supported fiat and crypto currencies.
+    example: EUR
+description: UMA address destination details

openapi/components/schemas/quotes/QuoteSource.yaml

@@ -1,42 +1,10 @@
+required:
+  - sourceType
 oneOf:
-  - title: Account
-    type: object
-    required:
-      - accountId
-    properties:
-      accountId:
-        type: string
-        description: Source account identifier
-        example: InternalAccount:85dcbd6-dced-4ec4-b756-3c3a9ea3d965
-      currency:
-        type: string
-        description: >-
-          Currency code for the funding source. See
-          [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
-          for the full list of supported fiat and crypto currencies.
-        example: USD
-    description: Source account details
-  - title: Real-time funding
-    type: object
-    required:
-      - currency
-      - customerId
-    properties:
-      customerId:
-        type: string
-        description: >-
-          Source customer ID. If this transaction is being initiated on behalf of a customer, this is required.
-          If customerId is not provided, the quote will be created on behalf of the platform itself.
-        example: Customer:019542f5-b3e7-1d02-0000-000000000009
-      currency:
-        type: string
-        description: >-
-          Currency code for the funding source. See
-          [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails)
-          for the full list of supported fiat and crypto currencies.
-        example: USD
-    description: >-
-      Fund the quote using a real-time funding source (RTP, SEPA Instant, Spark, Stables, etc.).
-      This will require manual just-in-time funding using `paymentInstructions` in the response.
-      Because quotes expire quickly, this option is only valid for instant payment methods. Do not try
-      to fund a quote with a non-instant payment method (ACH, etc.).
+  - $ref: ./QuoteAccountSource.yaml
+  - $ref: ./QuoteRealtimeFundingSource.yaml
+discriminator:
+  propertyName: sourceType
+  mapping:
+    ACCOUNT: ./QuoteAccountSource.yaml
+    REALTIME_FUNDING: ./QuoteRealtimeFundingSource.yaml

openapi/components/schemas/quotes/QuoteUmaAddressDestination.yaml

@@ -0,0 +1,28 @@
+type: object
+required:
+  - destinationType
+  - umaAddress
+properties:
+  destinationType:
+    type: string
+    const: UMA_ADDRESS
+    description: Destination type identifier
+  umaAddress:
+    type: string
+    description: UMA address of the recipient
+    example: $receiver@uma.domain.com
+  currency:
+    type: string
+    description: Currency code for the destination
+    example: EUR
+  counterpartyInformation:
+    type: object
+    description: >-
+      Information about the recipient, as required by the platform in their
+      configuration.
+    additionalProperties: true
+    example:
+      FULL_NAME: Jane Receiver
+      BIRTH_DATE: '1990-01-01'
+      NATIONALITY: FR
+description: UMA address destination details

openapi/components/schemas/transactions/AccountDestination.yaml

@@ -0,0 +1,19 @@
+type: object
+required:
+  - destinationType
+  - accountId
+  - currency
+properties:
+  destinationType:
+    type: string
+    const: ACCOUNT
+    description: Destination type identifier
+  accountId:
+    type: string
+    description: Destination account identifier
+    example: ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123
+  currency:
+    type: string
+    description: Currency code for the destination account
+    example: EUR
+description: Destination account details

openapi/components/schemas/transactions/AccountSource.yaml

@@ -0,0 +1,19 @@
+type: object
+required:
+  - sourceType
+  - accountId
+  - currency
+properties:
+  sourceType:
+    type: string
+    const: ACCOUNT
+    description: Source type identifier
+  accountId:
+    type: string
+    description: Source account identifier
+    example: InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965
+  currency:
+    type: string
+    description: Currency code for the source account
+    example: USD
+description: Source account details