fix(api-reference): correct duplicate l2LegacySharedBridge key in BridgeContractsResponse - #220
Open
memosr wants to merge 1 commit into
Open
Conversation
…schema The BridgeContractsResponse schema defined l2LegacySharedBridge twice, which made openapi.json invalid and prevented the OpenAPI tab from loading in Mintlify. The second entry was meant to be l2SharedDefaultBridge. Its example value and the l2Erc20DefaultBridge example were also corrected to match the actual zks_getBridgeContracts response on Abstract mainnet.
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
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.
The
BridgeContractsResponseschema inapi-reference/openapi.jsondefinesl2LegacySharedBridgetwice, which makes the file invalid.Impact
Running
mint devon a clean clone fails to load the OpenAPI tab entirely:Root cause
The second entry was meant to be
l2SharedDefaultBridge. Its own description already said "L2 Shared default bridge address", so this looks like a copy/paste slip when the field was added.Verification
Checked against the live mainnet RPC (
zks_getBridgeContractsonhttps://api.mainnet.abs.xyz):{ "l1Erc20DefaultBridge": "0x57891966931eb4bb6fb81430e6ce0a03aabde063", "l1SharedDefaultBridge": "0x8829ad80e425c646dab305381ff105169feece56", "l1WethBridge": "0x0000000000000000000000000000000000000000", "l2Erc20DefaultBridge": "0x0000000000000000000000000000000000010003", "l2LegacySharedBridge": "0x954ba8223a6bfec1cc3867139243a02ba0bc66e4", "l2SharedDefaultBridge": "0x0000000000000000000000000000000000010003", "l2WethBridge": "0x0000000000000000000000000000000000000000" }Changes
l2LegacySharedBridgetol2SharedDefaultBridge0x0000000000000000000000000000000000010003l2Erc20DefaultBridgeexample, which was0x0...0000instead of the actual0x0...010003The endpoint-level example at
openapi.json:4520was already correct, which is likely why this went unnoticed. Only thex-definitionsschema was affected.After
mint devstarts without the parse error and the OpenAPI tab loads. No.mdxfile referenceszks_getBridgeContractsexamples, so no other files needed changes.