Skip to content

fix: reverting back to using enums instead of const for openapi generator #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pengying merged 1 commit into from
Jan 30, 2026
+2,269 −2,211
Merged

fix: reverting back to using enums instead of const for openapi generator #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,537 changes: 789 additions & 748 deletions mintlify/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1,537 changes: 789 additions & 748 deletions openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions openapi/components/schemas/common/BasePaymentAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
type: object
required:
- accountType
properties:
accountType:
$ref: ./PaymentAccountType.yaml
discriminator:
propertyName: accountType
mapping:
CLABE: ./PaymentClabeAccountInfo.yaml
US_ACCOUNT: ./PaymentUsAccountInfo.yaml
PIX: ./PaymentPixAccountInfo.yaml
IBAN: ./PaymentIbanAccountInfo.yaml
UPI: ./PaymentUpiAccountInfo.yaml
NGN_ACCOUNT: ./PaymentNgnAccountInfo.yaml
SPARK_WALLET: ./PaymentSparkWalletInfo.yaml
LIGHTNING: ./PaymentLightningInvoiceInfo.yaml
SOLANA_WALLET: ./PaymentSolanaWalletInfo.yaml
TRON_WALLET: ./PaymentTronWalletInfo.yaml
POLYGON_WALLET: ./PaymentPolygonWalletInfo.yaml
BASE_WALLET: ./PaymentBaseWalletInfo.yaml
6 changes: 3 additions & 3 deletions openapi/components/schemas/common/BaseWalletInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
type: object
required:
- accountType
- address
- accountType
properties:
accountType:
type: string
const: BASE_WALLET
example: BASE_WALLET
enum:
- BASE_WALLET
address:
type: string
description: Base eth wallet address
Expand Down
6 changes: 3 additions & 3 deletions openapi/components/schemas/common/CadAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
type: object
required:
- accountType
- bankCode
- branchCode
- accountNumber
- accountType
properties:
accountType:
type: string
enum: [CAD_ACCOUNT]
example: CAD_ACCOUNT
enum:
- CAD_ACCOUNT
bankCode:
type: string
description: Canadian financial institution number (3 digits)
Expand Down
6 changes: 3 additions & 3 deletions openapi/components/schemas/common/ClabeAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
type: object
required:
- accountType
- clabeNumber
- accountType
properties:
accountType:
type: string
const: CLABE
example: CLABE
enum:
- CLABE
clabeNumber:
type: string
description: 18-digit CLABE number (Mexican banking standard)
Expand Down
14 changes: 0 additions & 14 deletions openapi/components/schemas/common/FboAccountInfo.yaml
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions openapi/components/schemas/common/GbpAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
type: object
required:
- accountType
- sortCode
- accountNumber
- accountType
properties:
accountType:
type: string
enum: [GBP_ACCOUNT]
example: GBP_ACCOUNT
enum:
- GBP_ACCOUNT
sortCode:
type: string
description: UK bank sort code (6 digits, may include hyphens)
Expand Down
6 changes: 3 additions & 3 deletions openapi/components/schemas/common/IbanAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
type: object
required:
- accountType
- iban
- swiftBic
- accountType
properties:
accountType:
type: string
const: IBAN
example: IBAN
enum:
- IBAN
iban:
type: string
description: International Bank Account Number
Expand Down
6 changes: 3 additions & 3 deletions openapi/components/schemas/common/NgnAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
type: object
required:
- accountType
- accountNumber
- bankName
- accountType
properties:
accountType:
type: string
const: NGN_ACCOUNT
example: NGN_ACCOUNT
enum:
- NGN_ACCOUNT
accountNumber:
type: string
description: Nigerian bank account number
Expand Down
4 changes: 2 additions & 2 deletions ...hemas/common/BankAccountOrWalletType.yaml → ...ts/schemas/common/PaymentAccountType.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ enum:
- US_ACCOUNT
- PIX
- IBAN
- FBO
- UPI
- NGN_ACCOUNT
- SPARK_WALLET
Expand All @@ -13,4 +12,5 @@ enum:
- TRON_WALLET
- POLYGON_WALLET
- BASE_WALLET
description: Type of account or wallet information
description: Type of payment account or wallet
example: US_ACCOUNT
13 changes: 8 additions & 5 deletions openapi/components/schemas/common/PaymentBaseWalletInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./BaseWalletInfo.yaml
properties:
assetType:
type: string
description: Type of asset
const: USDC
- type: object
properties:
assetType:
type: string
description: Type of asset
enum:
- USDC
20 changes: 11 additions & 9 deletions openapi/components/schemas/common/PaymentClabeAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./ClabeAccountInfo.yaml
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
- type: object
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
20 changes: 11 additions & 9 deletions openapi/components/schemas/common/PaymentIbanAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./IbanAccountInfo.yaml
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
- type: object
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
2 changes: 1 addition & 1 deletion openapi/components/schemas/common/PaymentInstructions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ properties:
SOLANA_WALLET: ../common/PaymentSolanaWalletInfo.yaml
TRON_WALLET: ../common/PaymentTronWalletInfo.yaml
POLYGON_WALLET: ../common/PaymentPolygonWalletInfo.yaml
BASE_WALLET: ../common/PaymentBaseWalletInfo.yaml
BASE_WALLET: ../common/PaymentBaseWalletInfo.yaml
23 changes: 10 additions & 13 deletions openapi/components/schemas/common/PaymentLightningInvoiceInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
type: object
required:
- accountType
- invoice
properties:
accountType:
type: string
const: LIGHTNING
example: LIGHTNING
invoice:
type: string
description: Invoice for the payment
example: lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- type: object
required:
- invoice
properties:
invoice:
type: string
description: Invoice for the payment
example: lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs
20 changes: 11 additions & 9 deletions openapi/components/schemas/common/PaymentNgnAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./NgnAccountInfo.yaml
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
- type: object
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
1 change: 1 addition & 0 deletions openapi/components/schemas/common/PaymentPixAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./PixAccountInfo.yaml
14 changes: 9 additions & 5 deletions openapi/components/schemas/common/PaymentPolygonWalletInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./PolygonWalletInfo.yaml
properties:
assetType:
type: string
description: Type of asset
const: USDC
- type: object
properties:
assetType:
type: string
description: Type of asset
enum:
- USDC

16 changes: 9 additions & 7 deletions openapi/components/schemas/common/PaymentSolanaWalletInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./SolanaWalletInfo.yaml
properties:
assetType:
type: string
description: Type of asset
enum:
- USDC
- USDT
- type: object
properties:
assetType:
type: string
description: Type of asset
enum:
- USDC
- USDT
Comment on lines +6 to +11
Copy link

@gcamata gcamata Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this be a ref?

Copy link
Contributor Author

@pengying pengying Jan 30, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could make it a ref if you want to create an enum for openapi-generator for webdev.

    @field_validator('asset_type')

    def asset_type_validate_enum(cls, value):
        """Validates the enum"""
        if value is None:
            return value
        if value not in set(['USDC', 'USDT']):
            raise ValueError("must be one of enum values ('USDC', 'USDT')")
        return value
    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )

For external generation via stainless, this results in a distinct type:
https://github.com/stainless-sdks/grid-kotlin/blob/main/grid-kotlin-core/src/main/kotlin/com/grid/api/models/quotes/PaymentInstructions.kt#L4432

class AssetType @JsonCreator private constructor(private val value: JsonField<String>) :
                Enum {

                /**
                 * Returns this class instance's raw value.
                 *
                 * This is usually only useful if this instance was deserialized from data that
                 * doesn't match any known member, and you want to know that value. For example, if
                 * the SDK is on an older version than the API, then the API may respond with new
                 * members that the SDK is unaware of.
                 */
                @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value

                companion object {

                    val USDC = of("USDC")

                    val USDT = of("USDT")

                    fun of(value: String) = AssetType(JsonField.of(value))
                }

                /** An enum containing [AssetType]'s known values. */
                enum class Known {
                    USDC,
                    USDT,
                }

28 changes: 15 additions & 13 deletions openapi/components/schemas/common/PaymentSparkWalletInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./SparkWalletInfo.yaml
required:
- assetType
properties:
assetType:
type: string
description: Type of asset
enum:
- BTC
- USDB
invoice:
type: string
description: Invoice for the payment
example: sparkrt1pgss8ter0fhc4c220f3zftmpz49h8wqte8eg3m5zkrraplgc048jucgszg3ssqgjzqqekv73mmh842yj7drsjwh7t7tz5zt8wf5kghm5v4ehggszppjp5s80cg3qjdzc55g2567tn3lj705hdsr577tg8ah795mlnt6807y657qhkmgfkf9w75p4wz3l8vhua85zdn6ryj32zuj0p00pv2l5z4u47mw6h4s
- type: object
required:
- assetType
properties:
assetType:
type: string
description: Type of asset
enum:
- BTC
- USDB
invoice:
type: string
description: Invoice for the payment
example: sparkrt1pgss8ter0fhc4c220f3zftmpz49h8wqte8eg3m5zkrraplgc048jucgszg3ssqgjzqqekv73mmh842yj7drsjwh7t7tz5zt8wf5kghm5v4ehggszppjp5s80cg3qjdzc55g2567tn3lj705hdsr577tg8ah795mlnt6807y657qhkmgfkf9w75p4wz3l8vhua85zdn6ryj32zuj0p00pv2l5z4u47mw6h4s
12 changes: 7 additions & 5 deletions openapi/components/schemas/common/PaymentTronWalletInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./TronWalletInfo.yaml
properties:
assetType:
type: string
description: Type of asset
const: USDT
- type: object
properties:
assetType:
type: string
description: Type of asset
enum: [USDT]
1 change: 1 addition & 0 deletions openapi/components/schemas/common/PaymentUpiAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./UpiAccountInfo.yaml
20 changes: 11 additions & 9 deletions openapi/components/schemas/common/PaymentUsAccountInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
allOf:
- $ref: ./BasePaymentAccountInfo.yaml
- $ref: ./UsAccountInfo.yaml
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
- type: object
required:
- reference
properties:
reference:
type: string
description: >-
Unique reference code that must be included with the payment to properly
credit it
example: UMA-Q12345-REF
Loading