From ed67b1b899369ba6162b6333a1361f23b811af86 Mon Sep 17 00:00:00 2001 From: sethoshi18 <55265644+sethoshi18@users.noreply.github.com> Date: Sat, 30 May 2026 14:07:17 +0000 Subject: [PATCH 1/2] Address maintenance issues and documentation inconsistencies in the OpenAPI generator and SDK docs. Summary of changes: - Removed stray debug console logs from `scripts/openapi-gen/utils/parser.ts`. - Improved error handling in `scripts/openapi-gen/openapi-gen.ts` to ensure non-zero exit codes on failures. - Fixed an incorrect package manager command in `sdks/advanced/api-key-stamper.mdx`. - Improved documentation and generalized hardcoded overrides in `scripts/openapi-gen/utils/mdx-generator/generator.ts`. - Added a note with links to standard error documentation in generated activity reference MDX files. - Regenerated all API reference documentation to reflect these improvements. - Verified that no accidental log files (like `mintlify.log`) are included in the PR. --- api-reference/activities/approve-activity.mdx | 2 ++ .../activities/broadcast-evm-transaction.mdx | 2 ++ .../activities/broadcast-svm-transaction.mdx | 2 ++ api-reference/activities/claim-spark-transfer.mdx | 2 ++ .../activities/create-a-fiat-on-ramp-credential.mdx | 2 ++ api-reference/activities/create-a-tvc-app.mdx | 2 ++ api-reference/activities/create-a-tvc-deployment.mdx | 2 ++ .../activities/create-an-oauth-20-credential.mdx | 2 ++ api-reference/activities/create-api-keys.mdx | 2 ++ api-reference/activities/create-authenticators.mdx | 2 ++ api-reference/activities/create-invitations.mdx | 2 ++ api-reference/activities/create-oauth-providers.mdx | 2 ++ api-reference/activities/create-policies.mdx | 2 ++ api-reference/activities/create-policy.mdx | 2 ++ api-reference/activities/create-private-key-tag.mdx | 2 ++ api-reference/activities/create-private-keys.mdx | 2 ++ api-reference/activities/create-read-only-session.mdx | 2 ++ .../activities/create-read-write-session.mdx | 2 ++ .../activities/create-smart-contract-interface.mdx | 2 ++ api-reference/activities/create-sub-organization.mdx | 2 ++ .../activities/create-tvc-manifest-approvals.mdx | 2 ++ api-reference/activities/create-user-tag.mdx | 2 ++ api-reference/activities/create-users.mdx | 2 ++ api-reference/activities/create-wallet-accounts.mdx | 2 ++ api-reference/activities/create-wallet.mdx | 2 ++ api-reference/activities/create-webhook-endpoint.mdx | 2 ++ .../activities/delete-a-fiat-on-ramp-credential.mdx | 2 ++ .../delete-a-tvc-app-and-all-of-its-deployments.mdx | 2 ++ api-reference/activities/delete-a-tvc-deployment.mdx | 2 ++ .../activities/delete-an-oauth-20-credential.mdx | 2 ++ api-reference/activities/delete-api-keys.mdx | 2 ++ api-reference/activities/delete-authenticators.mdx | 2 ++ api-reference/activities/delete-invitation.mdx | 2 ++ api-reference/activities/delete-oauth-providers.mdx | 2 ++ api-reference/activities/delete-policies.mdx | 2 ++ api-reference/activities/delete-policy.mdx | 2 ++ api-reference/activities/delete-private-key-tags.mdx | 2 ++ api-reference/activities/delete-private-keys.mdx | 2 ++ .../activities/delete-smart-contract-interface.mdx | 2 ++ api-reference/activities/delete-sub-organization.mdx | 2 ++ api-reference/activities/delete-user-tags.mdx | 2 ++ api-reference/activities/delete-users.mdx | 2 ++ api-reference/activities/delete-wallet-accounts.mdx | 2 ++ api-reference/activities/delete-wallets.mdx | 2 ++ api-reference/activities/delete-webhook-endpoint.mdx | 2 ++ api-reference/activities/export-private-key.mdx | 2 ++ api-reference/activities/export-wallet-account.mdx | 2 ++ api-reference/activities/export-wallet.mdx | 2 ++ api-reference/activities/import-private-key.mdx | 2 ++ api-reference/activities/import-wallet.mdx | 2 ++ api-reference/activities/init-email-recovery.mdx | 2 ++ api-reference/activities/init-fiat-on-ramp.mdx | 2 ++ api-reference/activities/init-generic-otp.mdx | 2 ++ api-reference/activities/init-import-private-key.mdx | 2 ++ api-reference/activities/init-import-wallet.mdx | 2 ++ api-reference/activities/init-otp-auth.mdx | 2 ++ api-reference/activities/login-with-a-stamp.mdx | 2 ++ api-reference/activities/login-with-oauth.mdx | 2 ++ api-reference/activities/login-with-otp.mdx | 2 ++ api-reference/activities/oauth-20-authentication.mdx | 2 ++ api-reference/activities/oauth.mdx | 2 ++ api-reference/activities/otp-auth.mdx | 2 ++ api-reference/activities/perform-email-auth.mdx | 2 ++ api-reference/activities/prepare-spark-transfer.mdx | 2 ++ api-reference/activities/recover-a-user.mdx | 2 ++ api-reference/activities/reject-activity.mdx | 2 ++ api-reference/activities/remove-ip-allowlist.mdx | 2 ++ .../activities/remove-organization-feature.mdx | 2 ++ api-reference/activities/restore-a-tvc-deployment.mdx | 2 ++ api-reference/activities/set-ip-allowlist.mdx | 2 ++ api-reference/activities/set-organization-feature.mdx | 2 ++ api-reference/activities/sign-frost-spark.mdx | 2 ++ api-reference/activities/sign-raw-payload.mdx | 2 ++ api-reference/activities/sign-raw-payloads.mdx | 2 ++ api-reference/activities/sign-transaction.mdx | 2 ++ .../activities/spark-prepare-lightning-receive.mdx | 2 ++ .../activities/update-a-fiat-on-ramp-credential.mdx | 2 ++ .../activities/update-an-oauth-20-credential.mdx | 2 ++ api-reference/activities/update-organization-name.mdx | 2 ++ api-reference/activities/update-policy.mdx | 2 ++ api-reference/activities/update-private-key-tag.mdx | 2 ++ api-reference/activities/update-root-quorum.mdx | 2 ++ api-reference/activities/update-user-tag.mdx | 2 ++ api-reference/activities/update-user.mdx | 2 ++ api-reference/activities/update-users-email.mdx | 2 ++ api-reference/activities/update-users-name.mdx | 2 ++ .../activities/update-users-phone-number.mdx | 2 ++ api-reference/activities/update-wallet.mdx | 2 ++ api-reference/activities/update-webhook-endpoint.mdx | 2 ++ api-reference/activities/verify-generic-otp.mdx | 2 ++ scripts/openapi-gen/utils/mdx-generator/generator.ts | 11 ++++++++--- scripts/openapi-gen/utils/parser.ts | 2 -- 92 files changed, 188 insertions(+), 5 deletions(-) diff --git a/api-reference/activities/approve-activity.mdx b/api-reference/activities/approve-activity.mdx index 3f190c1d..2260c27b 100644 --- a/api-reference/activities/approve-activity.mdx +++ b/api-reference/activities/approve-activity.mdx @@ -101,6 +101,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/broadcast-evm-transaction.mdx b/api-reference/activities/broadcast-evm-transaction.mdx index 1fa2f632..0c90ee71 100644 --- a/api-reference/activities/broadcast-evm-transaction.mdx +++ b/api-reference/activities/broadcast-evm-transaction.mdx @@ -193,6 +193,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/broadcast-svm-transaction.mdx b/api-reference/activities/broadcast-svm-transaction.mdx index 20ec8ce7..b54ccaa4 100644 --- a/api-reference/activities/broadcast-svm-transaction.mdx +++ b/api-reference/activities/broadcast-svm-transaction.mdx @@ -144,6 +144,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/claim-spark-transfer.mdx b/api-reference/activities/claim-spark-transfer.mdx index 1f0931ca..03fc1b03 100644 --- a/api-reference/activities/claim-spark-transfer.mdx +++ b/api-reference/activities/claim-spark-transfer.mdx @@ -216,6 +216,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-a-fiat-on-ramp-credential.mdx b/api-reference/activities/create-a-fiat-on-ramp-credential.mdx index 5d5b7e92..62f260a9 100644 --- a/api-reference/activities/create-a-fiat-on-ramp-credential.mdx +++ b/api-reference/activities/create-a-fiat-on-ramp-credential.mdx @@ -151,6 +151,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-a-tvc-app.mdx b/api-reference/activities/create-a-tvc-app.mdx index e39e7df5..b5275f17 100644 --- a/api-reference/activities/create-a-tvc-app.mdx +++ b/api-reference/activities/create-a-tvc-app.mdx @@ -279,6 +279,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-a-tvc-deployment.mdx b/api-reference/activities/create-a-tvc-deployment.mdx index 666d27cf..d9bf93e8 100644 --- a/api-reference/activities/create-a-tvc-deployment.mdx +++ b/api-reference/activities/create-a-tvc-deployment.mdx @@ -200,6 +200,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-an-oauth-20-credential.mdx b/api-reference/activities/create-an-oauth-20-credential.mdx index b1fa385d..1f8caa15 100644 --- a/api-reference/activities/create-an-oauth-20-credential.mdx +++ b/api-reference/activities/create-an-oauth-20-credential.mdx @@ -130,6 +130,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-api-keys.mdx b/api-reference/activities/create-api-keys.mdx index afe84d6c..1108eae1 100644 --- a/api-reference/activities/create-api-keys.mdx +++ b/api-reference/activities/create-api-keys.mdx @@ -160,6 +160,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-authenticators.mdx b/api-reference/activities/create-authenticators.mdx index 82100f2e..3c961c53 100644 --- a/api-reference/activities/create-authenticators.mdx +++ b/api-reference/activities/create-authenticators.mdx @@ -191,6 +191,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-invitations.mdx b/api-reference/activities/create-invitations.mdx index ef82fef2..ab02045a 100644 --- a/api-reference/activities/create-invitations.mdx +++ b/api-reference/activities/create-invitations.mdx @@ -170,6 +170,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-oauth-providers.mdx b/api-reference/activities/create-oauth-providers.mdx index 233d5004..cdf5d72f 100644 --- a/api-reference/activities/create-oauth-providers.mdx +++ b/api-reference/activities/create-oauth-providers.mdx @@ -176,6 +176,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-policies.mdx b/api-reference/activities/create-policies.mdx index 987867bd..dd847956 100644 --- a/api-reference/activities/create-policies.mdx +++ b/api-reference/activities/create-policies.mdx @@ -161,6 +161,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-policy.mdx b/api-reference/activities/create-policy.mdx index 9433feca..34a03c61 100644 --- a/api-reference/activities/create-policy.mdx +++ b/api-reference/activities/create-policy.mdx @@ -144,6 +144,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-private-key-tag.mdx b/api-reference/activities/create-private-key-tag.mdx index 6528e146..113f9812 100644 --- a/api-reference/activities/create-private-key-tag.mdx +++ b/api-reference/activities/create-private-key-tag.mdx @@ -139,6 +139,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-private-keys.mdx b/api-reference/activities/create-private-keys.mdx index 15b9598e..b1aeedc6 100644 --- a/api-reference/activities/create-private-keys.mdx +++ b/api-reference/activities/create-private-keys.mdx @@ -187,6 +187,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-read-only-session.mdx b/api-reference/activities/create-read-only-session.mdx index 707318ec..0398a371 100644 --- a/api-reference/activities/create-read-only-session.mdx +++ b/api-reference/activities/create-read-only-session.mdx @@ -119,6 +119,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-read-write-session.mdx b/api-reference/activities/create-read-write-session.mdx index 0edb2556..5bd3e179 100644 --- a/api-reference/activities/create-read-write-session.mdx +++ b/api-reference/activities/create-read-write-session.mdx @@ -156,6 +156,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-smart-contract-interface.mdx b/api-reference/activities/create-smart-contract-interface.mdx index 711e68d7..6410f5b0 100644 --- a/api-reference/activities/create-smart-contract-interface.mdx +++ b/api-reference/activities/create-smart-contract-interface.mdx @@ -144,6 +144,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-sub-organization.mdx b/api-reference/activities/create-sub-organization.mdx index 8d31ed3f..6f2e5c89 100644 --- a/api-reference/activities/create-sub-organization.mdx +++ b/api-reference/activities/create-sub-organization.mdx @@ -496,6 +496,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-tvc-manifest-approvals.mdx b/api-reference/activities/create-tvc-manifest-approvals.mdx index 74104dcc..bfbdeeca 100644 --- a/api-reference/activities/create-tvc-manifest-approvals.mdx +++ b/api-reference/activities/create-tvc-manifest-approvals.mdx @@ -139,6 +139,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-user-tag.mdx b/api-reference/activities/create-user-tag.mdx index a3421e3c..dce5a912 100644 --- a/api-reference/activities/create-user-tag.mdx +++ b/api-reference/activities/create-user-tag.mdx @@ -139,6 +139,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-users.mdx b/api-reference/activities/create-users.mdx index 88b10bb4..f51caa9e 100644 --- a/api-reference/activities/create-users.mdx +++ b/api-reference/activities/create-users.mdx @@ -330,6 +330,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-wallet-accounts.mdx b/api-reference/activities/create-wallet-accounts.mdx index 32d88df8..5c75bea0 100644 --- a/api-reference/activities/create-wallet-accounts.mdx +++ b/api-reference/activities/create-wallet-accounts.mdx @@ -173,6 +173,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-wallet.mdx b/api-reference/activities/create-wallet.mdx index d0674865..bfdbeb4e 100644 --- a/api-reference/activities/create-wallet.mdx +++ b/api-reference/activities/create-wallet.mdx @@ -176,6 +176,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/create-webhook-endpoint.mdx b/api-reference/activities/create-webhook-endpoint.mdx index 9628153d..ba47bffc 100644 --- a/api-reference/activities/create-webhook-endpoint.mdx +++ b/api-reference/activities/create-webhook-endpoint.mdx @@ -188,6 +188,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-a-fiat-on-ramp-credential.mdx b/api-reference/activities/delete-a-fiat-on-ramp-credential.mdx index 2c3cbaef..3c52e982 100644 --- a/api-reference/activities/delete-a-fiat-on-ramp-credential.mdx +++ b/api-reference/activities/delete-a-fiat-on-ramp-credential.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-a-tvc-app-and-all-of-its-deployments.mdx b/api-reference/activities/delete-a-tvc-app-and-all-of-its-deployments.mdx index cb360d70..eb32b421 100644 --- a/api-reference/activities/delete-a-tvc-app-and-all-of-its-deployments.mdx +++ b/api-reference/activities/delete-a-tvc-app-and-all-of-its-deployments.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-a-tvc-deployment.mdx b/api-reference/activities/delete-a-tvc-deployment.mdx index ded812ff..67efc468 100644 --- a/api-reference/activities/delete-a-tvc-deployment.mdx +++ b/api-reference/activities/delete-a-tvc-deployment.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-an-oauth-20-credential.mdx b/api-reference/activities/delete-an-oauth-20-credential.mdx index 0d4b4254..6e1f876d 100644 --- a/api-reference/activities/delete-an-oauth-20-credential.mdx +++ b/api-reference/activities/delete-an-oauth-20-credential.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-api-keys.mdx b/api-reference/activities/delete-api-keys.mdx index c7d11506..71acd017 100644 --- a/api-reference/activities/delete-api-keys.mdx +++ b/api-reference/activities/delete-api-keys.mdx @@ -136,6 +136,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-authenticators.mdx b/api-reference/activities/delete-authenticators.mdx index bda7a56b..a0b53038 100644 --- a/api-reference/activities/delete-authenticators.mdx +++ b/api-reference/activities/delete-authenticators.mdx @@ -136,6 +136,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-invitation.mdx b/api-reference/activities/delete-invitation.mdx index aedc7cea..9e37f858 100644 --- a/api-reference/activities/delete-invitation.mdx +++ b/api-reference/activities/delete-invitation.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-oauth-providers.mdx b/api-reference/activities/delete-oauth-providers.mdx index 4a9a47ea..c73e4dd9 100644 --- a/api-reference/activities/delete-oauth-providers.mdx +++ b/api-reference/activities/delete-oauth-providers.mdx @@ -136,6 +136,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-policies.mdx b/api-reference/activities/delete-policies.mdx index a3921bfb..d7dbd5e6 100644 --- a/api-reference/activities/delete-policies.mdx +++ b/api-reference/activities/delete-policies.mdx @@ -129,6 +129,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-policy.mdx b/api-reference/activities/delete-policy.mdx index 008423c1..e241d30a 100644 --- a/api-reference/activities/delete-policy.mdx +++ b/api-reference/activities/delete-policy.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-private-key-tags.mdx b/api-reference/activities/delete-private-key-tags.mdx index e1be285d..2a0d1d01 100644 --- a/api-reference/activities/delete-private-key-tags.mdx +++ b/api-reference/activities/delete-private-key-tags.mdx @@ -138,6 +138,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-private-keys.mdx b/api-reference/activities/delete-private-keys.mdx index db522ebd..a47b2c72 100644 --- a/api-reference/activities/delete-private-keys.mdx +++ b/api-reference/activities/delete-private-keys.mdx @@ -135,6 +135,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-smart-contract-interface.mdx b/api-reference/activities/delete-smart-contract-interface.mdx index 00ba7dbd..d6de61c6 100644 --- a/api-reference/activities/delete-smart-contract-interface.mdx +++ b/api-reference/activities/delete-smart-contract-interface.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-sub-organization.mdx b/api-reference/activities/delete-sub-organization.mdx index 209f78ba..147b5887 100644 --- a/api-reference/activities/delete-sub-organization.mdx +++ b/api-reference/activities/delete-sub-organization.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-user-tags.mdx b/api-reference/activities/delete-user-tags.mdx index e08e46c9..30b91eed 100644 --- a/api-reference/activities/delete-user-tags.mdx +++ b/api-reference/activities/delete-user-tags.mdx @@ -138,6 +138,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-users.mdx b/api-reference/activities/delete-users.mdx index 2e2bbc03..6a528793 100644 --- a/api-reference/activities/delete-users.mdx +++ b/api-reference/activities/delete-users.mdx @@ -129,6 +129,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-wallet-accounts.mdx b/api-reference/activities/delete-wallet-accounts.mdx index 29378001..71203f5f 100644 --- a/api-reference/activities/delete-wallet-accounts.mdx +++ b/api-reference/activities/delete-wallet-accounts.mdx @@ -135,6 +135,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-wallets.mdx b/api-reference/activities/delete-wallets.mdx index 8ec92f15..abf95cc2 100644 --- a/api-reference/activities/delete-wallets.mdx +++ b/api-reference/activities/delete-wallets.mdx @@ -135,6 +135,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/delete-webhook-endpoint.mdx b/api-reference/activities/delete-webhook-endpoint.mdx index d70e1a07..b376d104 100644 --- a/api-reference/activities/delete-webhook-endpoint.mdx +++ b/api-reference/activities/delete-webhook-endpoint.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/export-private-key.mdx b/api-reference/activities/export-private-key.mdx index 47f1e79d..a0cb1fa4 100644 --- a/api-reference/activities/export-private-key.mdx +++ b/api-reference/activities/export-private-key.mdx @@ -123,6 +123,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/export-wallet-account.mdx b/api-reference/activities/export-wallet-account.mdx index b4389c50..4f9e9e81 100644 --- a/api-reference/activities/export-wallet-account.mdx +++ b/api-reference/activities/export-wallet-account.mdx @@ -123,6 +123,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/export-wallet.mdx b/api-reference/activities/export-wallet.mdx index 91b118d1..d55a5821 100644 --- a/api-reference/activities/export-wallet.mdx +++ b/api-reference/activities/export-wallet.mdx @@ -133,6 +133,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/import-private-key.mdx b/api-reference/activities/import-private-key.mdx index d141b006..176e757e 100644 --- a/api-reference/activities/import-private-key.mdx +++ b/api-reference/activities/import-private-key.mdx @@ -168,6 +168,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/import-wallet.mdx b/api-reference/activities/import-wallet.mdx index 8a2f1e7d..8264e73f 100644 --- a/api-reference/activities/import-wallet.mdx +++ b/api-reference/activities/import-wallet.mdx @@ -184,6 +184,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/init-email-recovery.mdx b/api-reference/activities/init-email-recovery.mdx index 71081969..fde531d7 100644 --- a/api-reference/activities/init-email-recovery.mdx +++ b/api-reference/activities/init-email-recovery.mdx @@ -193,6 +193,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/init-fiat-on-ramp.mdx b/api-reference/activities/init-fiat-on-ramp.mdx index 24cc9b27..ead46573 100644 --- a/api-reference/activities/init-fiat-on-ramp.mdx +++ b/api-reference/activities/init-fiat-on-ramp.mdx @@ -204,6 +204,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/init-generic-otp.mdx b/api-reference/activities/init-generic-otp.mdx index b7810a78..9268af36 100644 --- a/api-reference/activities/init-generic-otp.mdx +++ b/api-reference/activities/init-generic-otp.mdx @@ -234,6 +234,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/init-import-private-key.mdx b/api-reference/activities/init-import-private-key.mdx index 204fca0f..3aaee96e 100644 --- a/api-reference/activities/init-import-private-key.mdx +++ b/api-reference/activities/init-import-private-key.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/init-import-wallet.mdx b/api-reference/activities/init-import-wallet.mdx index 5e02fb53..08f6d70d 100644 --- a/api-reference/activities/init-import-wallet.mdx +++ b/api-reference/activities/init-import-wallet.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/init-otp-auth.mdx b/api-reference/activities/init-otp-auth.mdx index 6e4c43dc..eef30766 100644 --- a/api-reference/activities/init-otp-auth.mdx +++ b/api-reference/activities/init-otp-auth.mdx @@ -231,6 +231,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/login-with-a-stamp.mdx b/api-reference/activities/login-with-a-stamp.mdx index aa839991..de1b14bf 100644 --- a/api-reference/activities/login-with-a-stamp.mdx +++ b/api-reference/activities/login-with-a-stamp.mdx @@ -127,6 +127,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/login-with-oauth.mdx b/api-reference/activities/login-with-oauth.mdx index c7607ded..756d1c87 100644 --- a/api-reference/activities/login-with-oauth.mdx +++ b/api-reference/activities/login-with-oauth.mdx @@ -134,6 +134,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/login-with-otp.mdx b/api-reference/activities/login-with-otp.mdx index 50dfa3ab..c001bb0a 100644 --- a/api-reference/activities/login-with-otp.mdx +++ b/api-reference/activities/login-with-otp.mdx @@ -175,6 +175,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/oauth-20-authentication.mdx b/api-reference/activities/oauth-20-authentication.mdx index d6c13264..ec11c402 100644 --- a/api-reference/activities/oauth-20-authentication.mdx +++ b/api-reference/activities/oauth-20-authentication.mdx @@ -148,6 +148,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/oauth.mdx b/api-reference/activities/oauth.mdx index 57b46daa..e40156e7 100644 --- a/api-reference/activities/oauth.mdx +++ b/api-reference/activities/oauth.mdx @@ -147,6 +147,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/otp-auth.mdx b/api-reference/activities/otp-auth.mdx index 66c431e4..a1ff101b 100644 --- a/api-reference/activities/otp-auth.mdx +++ b/api-reference/activities/otp-auth.mdx @@ -154,6 +154,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/perform-email-auth.mdx b/api-reference/activities/perform-email-auth.mdx index 5334110e..adde83d7 100644 --- a/api-reference/activities/perform-email-auth.mdx +++ b/api-reference/activities/perform-email-auth.mdx @@ -210,6 +210,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/prepare-spark-transfer.mdx b/api-reference/activities/prepare-spark-transfer.mdx index 3225baf0..b691dfe0 100644 --- a/api-reference/activities/prepare-spark-transfer.mdx +++ b/api-reference/activities/prepare-spark-transfer.mdx @@ -356,6 +356,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/recover-a-user.mdx b/api-reference/activities/recover-a-user.mdx index 87bbf0b1..ec28c9d6 100644 --- a/api-reference/activities/recover-a-user.mdx +++ b/api-reference/activities/recover-a-user.mdx @@ -191,6 +191,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/reject-activity.mdx b/api-reference/activities/reject-activity.mdx index 16d54272..f1063416 100644 --- a/api-reference/activities/reject-activity.mdx +++ b/api-reference/activities/reject-activity.mdx @@ -101,6 +101,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/remove-ip-allowlist.mdx b/api-reference/activities/remove-ip-allowlist.mdx index f191db62..18508c89 100644 --- a/api-reference/activities/remove-ip-allowlist.mdx +++ b/api-reference/activities/remove-ip-allowlist.mdx @@ -107,6 +107,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/remove-organization-feature.mdx b/api-reference/activities/remove-organization-feature.mdx index 4a7a000d..21113ed7 100644 --- a/api-reference/activities/remove-organization-feature.mdx +++ b/api-reference/activities/remove-organization-feature.mdx @@ -128,6 +128,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/restore-a-tvc-deployment.mdx b/api-reference/activities/restore-a-tvc-deployment.mdx index 50f4a0cc..9333f377 100644 --- a/api-reference/activities/restore-a-tvc-deployment.mdx +++ b/api-reference/activities/restore-a-tvc-deployment.mdx @@ -113,6 +113,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/set-ip-allowlist.mdx b/api-reference/activities/set-ip-allowlist.mdx index 0aafdcc4..1236538e 100644 --- a/api-reference/activities/set-ip-allowlist.mdx +++ b/api-reference/activities/set-ip-allowlist.mdx @@ -145,6 +145,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/set-organization-feature.mdx b/api-reference/activities/set-organization-feature.mdx index dd880f54..b6389500 100644 --- a/api-reference/activities/set-organization-feature.mdx +++ b/api-reference/activities/set-organization-feature.mdx @@ -135,6 +135,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/sign-frost-spark.mdx b/api-reference/activities/sign-frost-spark.mdx index 4660f02f..b578589f 100644 --- a/api-reference/activities/sign-frost-spark.mdx +++ b/api-reference/activities/sign-frost-spark.mdx @@ -248,6 +248,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/sign-raw-payload.mdx b/api-reference/activities/sign-raw-payload.mdx index e6b2d6ae..c1169256 100644 --- a/api-reference/activities/sign-raw-payload.mdx +++ b/api-reference/activities/sign-raw-payload.mdx @@ -146,6 +146,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/sign-raw-payloads.mdx b/api-reference/activities/sign-raw-payloads.mdx index 33989a6a..30ad4d45 100644 --- a/api-reference/activities/sign-raw-payloads.mdx +++ b/api-reference/activities/sign-raw-payloads.mdx @@ -161,6 +161,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/sign-transaction.mdx b/api-reference/activities/sign-transaction.mdx index f5559f7e..3d0beca5 100644 --- a/api-reference/activities/sign-transaction.mdx +++ b/api-reference/activities/sign-transaction.mdx @@ -130,6 +130,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/spark-prepare-lightning-receive.mdx b/api-reference/activities/spark-prepare-lightning-receive.mdx index 669d7d12..ee9fa159 100644 --- a/api-reference/activities/spark-prepare-lightning-receive.mdx +++ b/api-reference/activities/spark-prepare-lightning-receive.mdx @@ -163,6 +163,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-a-fiat-on-ramp-credential.mdx b/api-reference/activities/update-a-fiat-on-ramp-credential.mdx index aaaf2775..de5dad43 100644 --- a/api-reference/activities/update-a-fiat-on-ramp-credential.mdx +++ b/api-reference/activities/update-a-fiat-on-ramp-credential.mdx @@ -151,6 +151,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-an-oauth-20-credential.mdx b/api-reference/activities/update-an-oauth-20-credential.mdx index 71222876..5161fce7 100644 --- a/api-reference/activities/update-an-oauth-20-credential.mdx +++ b/api-reference/activities/update-an-oauth-20-credential.mdx @@ -137,6 +137,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-organization-name.mdx b/api-reference/activities/update-organization-name.mdx index 3542e9f2..46cdf192 100644 --- a/api-reference/activities/update-organization-name.mdx +++ b/api-reference/activities/update-organization-name.mdx @@ -116,6 +116,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-policy.mdx b/api-reference/activities/update-policy.mdx index 0af2d4fe..2cb60029 100644 --- a/api-reference/activities/update-policy.mdx +++ b/api-reference/activities/update-policy.mdx @@ -151,6 +151,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-private-key-tag.mdx b/api-reference/activities/update-private-key-tag.mdx index 99481720..c15957ae 100644 --- a/api-reference/activities/update-private-key-tag.mdx +++ b/api-reference/activities/update-private-key-tag.mdx @@ -153,6 +153,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-root-quorum.mdx b/api-reference/activities/update-root-quorum.mdx index 4563514d..b758a715 100644 --- a/api-reference/activities/update-root-quorum.mdx +++ b/api-reference/activities/update-root-quorum.mdx @@ -124,6 +124,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-user-tag.mdx b/api-reference/activities/update-user-tag.mdx index f19d7227..8b627981 100644 --- a/api-reference/activities/update-user-tag.mdx +++ b/api-reference/activities/update-user-tag.mdx @@ -153,6 +153,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-user.mdx b/api-reference/activities/update-user.mdx index c3caff8f..0ccfe5b3 100644 --- a/api-reference/activities/update-user.mdx +++ b/api-reference/activities/update-user.mdx @@ -150,6 +150,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-users-email.mdx b/api-reference/activities/update-users-email.mdx index 2d8defd3..6a5b1c61 100644 --- a/api-reference/activities/update-users-email.mdx +++ b/api-reference/activities/update-users-email.mdx @@ -127,6 +127,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-users-name.mdx b/api-reference/activities/update-users-name.mdx index 940c1b0c..7c536527 100644 --- a/api-reference/activities/update-users-name.mdx +++ b/api-reference/activities/update-users-name.mdx @@ -120,6 +120,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-users-phone-number.mdx b/api-reference/activities/update-users-phone-number.mdx index 8da28814..886a53c5 100644 --- a/api-reference/activities/update-users-phone-number.mdx +++ b/api-reference/activities/update-users-phone-number.mdx @@ -127,6 +127,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-wallet.mdx b/api-reference/activities/update-wallet.mdx index 3bc3bded..47f6a2fd 100644 --- a/api-reference/activities/update-wallet.mdx +++ b/api-reference/activities/update-wallet.mdx @@ -120,6 +120,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/update-webhook-endpoint.mdx b/api-reference/activities/update-webhook-endpoint.mdx index 490986c6..08a5f65e 100644 --- a/api-reference/activities/update-webhook-endpoint.mdx +++ b/api-reference/activities/update-webhook-endpoint.mdx @@ -170,6 +170,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/api-reference/activities/verify-generic-otp.mdx b/api-reference/activities/verify-generic-otp.mdx index bddf22e4..cdd61473 100644 --- a/api-reference/activities/verify-generic-otp.mdx +++ b/api-reference/activities/verify-generic-otp.mdx @@ -127,6 +127,8 @@ The last update timestamp. +For a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors). + ```bash title="cURL" diff --git a/scripts/openapi-gen/utils/mdx-generator/generator.ts b/scripts/openapi-gen/utils/mdx-generator/generator.ts index f25b9ec9..cddf42dc 100644 --- a/scripts/openapi-gen/utils/mdx-generator/generator.ts +++ b/scripts/openapi-gen/utils/mdx-generator/generator.ts @@ -317,9 +317,9 @@ export function generateJsonPayloadRecursive( // Simple Enum let enumValue = `<${fieldDetails.options[0].value}>`; - // Special handling for credential type in get-api-key and get-api-keys endpoints. - // Current behavior: for enum types, we grab the first (which defaults to CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR). - // However, for `get_api_key` and `get_api_keys` endpoints, we want to use CREDENTIAL_TYPE_API_KEY_P256. + // --- HARDCODED HACK: get_api_key(s) Credential Type --- + // For these specific endpoints, the first enum option (WEBAUTHN_AUTHENTICATOR) is often + // not what the user wants to see in an example. We override it to API_KEY_P256. if ( (endpointPath?.includes("get_api_key") || endpointPath?.includes("get_api_keys")) && field.name === "type" && @@ -737,6 +737,11 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx"; mdxContent += `\n{/* No explicit 200 response schema defined. */}\n`; } + // Add a note about errors for activity endpoints + if (endpoint.type === "activity") { + mdxContent += `\nFor a detailed breakdown of potential error codes, please refer to our [Error Documentation](/api-reference/overview/errors).\n`; + } + // 4. Request Example Section const requestExample = generateRequestExample(endpoint); if (requestExample) { diff --git a/scripts/openapi-gen/utils/parser.ts b/scripts/openapi-gen/utils/parser.ts index 312576f0..d0801748 100644 --- a/scripts/openapi-gen/utils/parser.ts +++ b/scripts/openapi-gen/utils/parser.ts @@ -39,8 +39,6 @@ export async function parseOpenAPI( // Dereference the parsed JSON const api = await OpenAPIParser.default.dereference(jsonContent); - console.log('api', api); - return api; } catch (error: any) { // Enhance error message to provide more context From 7edb4edd2368adba2a8a2bbbd2239ad5342abb8a Mon Sep 17 00:00:00 2001 From: sethoshi18 <55265644+sethoshi18@users.noreply.github.com> Date: Sat, 30 May 2026 17:14:11 +0000 Subject: [PATCH 2/2] Enhance OpenAPI generator reliability, documentation consistency, and test coverage. This comprehensive update addresses multiple high-impact improvements: - established unit test coverage for core generator logic (string-utils and version matching). - Improved build reliability by ensuring the OpenAPI generator exits with a non-zero code on failures. - Cleaned up generator code by removing stray debug logs and documenting internal overrides. - Fixed documentation inconsistencies, specifically correcting package manager command labels. - Enhanced generated API reference by adding automated links to standard error documentation for all activity endpoints. - Regenerated API reference documentation to reflect these improvements. --- scripts/openapi-gen/openapi-gen.ts | 1 + scripts/openapi-gen/package.json | 3 +- scripts/openapi-gen/tests/parser.test.ts | 41 ++++++++++++++++ .../openapi-gen/tests/string-utils.test.ts | 48 +++++++++++++++++++ .../utils/endpoint-parser/parser.ts | 2 +- sdks/advanced/api-key-stamper.mdx | 2 +- 6 files changed, 94 insertions(+), 3 deletions(-) create mode 100644 scripts/openapi-gen/tests/parser.test.ts create mode 100644 scripts/openapi-gen/tests/string-utils.test.ts diff --git a/scripts/openapi-gen/openapi-gen.ts b/scripts/openapi-gen/openapi-gen.ts index 0e247b0c..43830fd6 100644 --- a/scripts/openapi-gen/openapi-gen.ts +++ b/scripts/openapi-gen/openapi-gen.ts @@ -280,6 +280,7 @@ export const tags = ${tagsStr};`; console.error( `Error processing or updating docs.json: ${error.message}` ); + process.exit(1); } console.log(`--- Finished updating docs.json ---`); diff --git a/scripts/openapi-gen/package.json b/scripts/openapi-gen/package.json index ba17c8e3..d13f6ad7 100644 --- a/scripts/openapi-gen/package.json +++ b/scripts/openapi-gen/package.json @@ -4,7 +4,8 @@ "description": "CLI tool to parse, dereference, and analyze OpenAPI specifications", "main": "openapi-gen.ts", "scripts": { - "start": "ts-node openapi-gen.ts" + "start": "ts-node openapi-gen.ts", + "test": "npx ts-node tests/string-utils.test.ts && npx ts-node tests/parser.test.ts" }, "dependencies": { "@readme/openapi-parser": "^2.5.0", diff --git a/scripts/openapi-gen/tests/parser.test.ts b/scripts/openapi-gen/tests/parser.test.ts new file mode 100644 index 00000000..0b926256 --- /dev/null +++ b/scripts/openapi-gen/tests/parser.test.ts @@ -0,0 +1,41 @@ +import * as assert from "assert"; +import { matchVersionedComponents } from "../utils/endpoint-parser/parser"; + +console.log("Running parser logic tests..."); + +// Test matchVersionedComponents with single version +const v1 = matchVersionedComponents( + ["ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"], + ["createPrivateKeysIntent"], + ["createPrivateKeysResult"] +); +assert.strictEqual(v1.length, 1); +assert.strictEqual(v1[0].version, "1"); +assert.strictEqual(v1[0].intentName, "createPrivateKeysIntent"); +assert.strictEqual(v1[0].resultName, "createPrivateKeysResult"); +console.log("✓ matchVersionedComponents (v1) passed"); + +// Test matchVersionedComponents with multiple versions +const v2 = matchVersionedComponents( + ["ACTIVITY_TYPE_CREATE_PRIVATE_KEYS", "ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"], + ["createPrivateKeysIntent", "createPrivateKeysIntentV2"], + ["createPrivateKeysResult", "createPrivateKeysResultV2"] +); +// Current implementation of matchVersionedComponents only returns ONE latest version +assert.strictEqual(v2.length, 1); +assert.strictEqual(v2[0].version, "2"); +assert.strictEqual(v2[0].intentName, "createPrivateKeysIntentV2"); +assert.strictEqual(v2[0].resultName, "createPrivateKeysResultV2"); +console.log("✓ matchVersionedComponents (v2 latest) passed"); + +// Test matchVersionedComponents with missing result (fallback logic) +const vFallback = matchVersionedComponents( + ["ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"], + ["createPrivateKeysIntent"], + [] +); +assert.strictEqual(vFallback.length, 1); +assert.strictEqual(vFallback[0].resultName, "createPrivateKeysResult"); +console.log("✓ matchVersionedComponents (fallback result) passed"); + +console.log("All parser logic tests passed!"); diff --git a/scripts/openapi-gen/tests/string-utils.test.ts b/scripts/openapi-gen/tests/string-utils.test.ts new file mode 100644 index 00000000..d99d0510 --- /dev/null +++ b/scripts/openapi-gen/tests/string-utils.test.ts @@ -0,0 +1,48 @@ +import * as assert from "assert"; +import { + snakeToCamel, + extractEndpointName, + determineEndpointType, + extractVersionFromComponent, + createIntentBaseName, +} from "../utils/endpoint-parser/string-utils"; + +console.log("Running string-utils tests..."); + +// Test snakeToCamel +assert.strictEqual(snakeToCamel("create_private_keys"), "createPrivateKeys"); +assert.strictEqual(snakeToCamel("whoami"), "whoami"); +console.log("✓ snakeToCamel passed"); + +// Test extractEndpointName +assert.strictEqual( + extractEndpointName("/public/v1/submit/create_private_keys"), + "create_private_keys" +); +console.log("✓ extractEndpointName passed"); + +// Test determineEndpointType +assert.strictEqual( + determineEndpointType("/public/v1/submit/create_private_keys"), + "activity" +); +assert.strictEqual( + determineEndpointType("/public/v1/query/whoami"), + "query" +); +assert.strictEqual(determineEndpointType("/v1/account"), "query"); +console.log("✓ determineEndpointType passed"); + +// Test extractVersionFromComponent +assert.strictEqual(extractVersionFromComponent("createPrivateKeysIntent"), "1"); +assert.strictEqual(extractVersionFromComponent("createPrivateKeysIntentV2"), "2"); +console.log("✓ extractVersionFromComponent passed"); + +// Test createIntentBaseName +assert.strictEqual( + createIntentBaseName("create_private_keys"), + "createPrivateKeysIntent" +); +console.log("✓ createIntentBaseName passed"); + +console.log("All string-utils tests passed!"); diff --git a/scripts/openapi-gen/utils/endpoint-parser/parser.ts b/scripts/openapi-gen/utils/endpoint-parser/parser.ts index 1dc3904a..bcbc2f97 100644 --- a/scripts/openapi-gen/utils/endpoint-parser/parser.ts +++ b/scripts/openapi-gen/utils/endpoint-parser/parser.ts @@ -548,7 +548,7 @@ interface VersionedComponent { /** * Matches activity types, intents, and results by version */ -function matchVersionedComponents( +export function matchVersionedComponents( activityTypes: string[], intents: string[], results: string[] diff --git a/sdks/advanced/api-key-stamper.mdx b/sdks/advanced/api-key-stamper.mdx index ab892d55..e2a3405e 100644 --- a/sdks/advanced/api-key-stamper.mdx +++ b/sdks/advanced/api-key-stamper.mdx @@ -13,7 +13,7 @@ To get started install the [`@turnkey/api-key-stamper`](https://www.npmjs.com/pa ```bash npm -pnpm i @turnkey/api-key-stamper +npm i @turnkey/api-key-stamper ``` ```bash pnpm