Skip to content

fix(docs): correct errors in gas manager admin openapi spec#1401

Merged
jakehobbs merged 2 commits into
mainfrom
jake/paymaster-admin-docs
Jun 23, 2026
Merged

fix(docs): correct errors in gas manager admin openapi spec#1401
jakehobbs merged 2 commits into
mainfrom
jake/paymaster-admin-docs

Conversation

@jakehobbs

Copy link
Copy Markdown
Contributor

Description

Aligns the public Gas Manager Admin OpenAPI spec (src/openapi/admin/admin.yaml) with the actual REST API shape served by meta-manage, fixing field-name, type, enum, and response-envelope mismatches without adding any undocumented endpoints.

Related Issues

N/A

Changes Made

  • Renamed request/response fields to camelCase to match the JSON the API emits/accepts (solanaRules, erc20Rules, gasPumpId, and nested ERC-20 fields tokenAddress, recipientAddress, usePostOp, priceMultiplier, etc.).
  • Corrected the stats path stats/detailsstats/detailed, changed USD stats fields from string to number, native-token fields to integer, and added erc20Stats.
  • Added bundler_sponsorship to PolicyType, introduced a PolicyStatus enum (active, inactive, pending_approval, rejected), and constrained sponsorship status to PENDING/MINED/EXPIRED.
  • Fixed rule numeric types (strings → numbers/integers), pagination limits (/policies max 50; sponsorships default 15, max 100 with before/after), added the nameFilter query param, and removed the non-existent success-envelope error objects and the fake delete-response body.

Testing

  • I have tested these changes locally
  • I have run the validation scripts (pnpm run validate)
  • I have checked that the documentation builds correctly

Fix mismatches between the public Gas Manager Admin spec and the actual
meta-manage REST surface: camelCase request/response fields, corrected
stats numeric types, accurate enums, pagination limits, and removal of
non-existent success-envelope error/delete bodies.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jakehobbs jakehobbs requested a review from a team as a code owner June 23, 2026 17:45
@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Jun 23, 2026, 6:11 PM

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5075a7058f

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/openapi/admin/admin.yaml
Comment thread src/openapi/admin/admin.yaml Outdated
@jakehobbs jakehobbs changed the title Align Gas Manager Admin OpenAPI spec with REST API shape fix(docs): correct errors in gas manager admin openapi spec Jun 23, 2026
Top-level networks is not required for any policy type: erc20 derives
networks from erc20Rules.tokens (the field is ignored), and the other
types fall back to the app default. Clarify in the description which
types use it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jakehobbs jakehobbs merged commit 92af84e into main Jun 23, 2026
11 checks passed
@jakehobbs jakehobbs deleted the jake/paymaster-admin-docs branch June 23, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants