Document AddGasSponsor auth requirements - #225
Merged
Merged
Conversation
Sync file structure, format locales. Branch: 225/merge
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivated by a support thread where a customer (StrayShot, project 43551) hit
403 PermissionDeniedand then401 AccessKeyNotFoundcallingAddGasSponsorbecause the auth requirements weren't documented. The endpoint requires bothX-Access-KeyandAuthorization: Bearer <admin-secret>— sending only one produces exactly those errors.Changes
api-references/transactions/endpoints/add-gas-sponsor.mdx— was previously an empty OpenAPI stub. Now describes what the endpoint does, the two required headers (with pointers to where to find each key in Builder), the chain-specific Relayer URLs, a working cURL example, and the common error responses.api-references/transactions/endpoints/relayer-api.json— added a summary + description to theAddGasSponsorpath, and updated itssecurityblock to require bothApiKeyAuthandBearerAuthtogether (AND rather than either/or), so the auto-generated API playground matches reality.solutions/builder/gas-sponsorship.mdx— added a "Managing Gas Sponsors via API" section right before the webhook section, covering programmatic sponsor management with the same auth requirements and example.Generated by Mintlify Agent.
Requested by: jlawton@polygon.technology via Slack
Mintlify session: slack_1785413466.434049_C071DTH2RUM