Skip to content
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.

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

Fix API sample responses and request parameters #675

Merged
merged 3 commits into from
Jan 17, 2025
Merged

Conversation

louis-md
Copy link
Collaborator

This PR fixes four bugs with the API reference after the transaction service upgraded it's Swagger version:

  • Query parameters' types were not displayed
  • Sample responses were not displayed
  • Typescript examples were not displayed
  • Response parameters with multiple types were not displayed correctly (e.g. stringnull instead of string | null)

@louis-md louis-md requested a review from tanay1337 January 17, 2025 14:52
Copy link

github-actions bot commented Jan 17, 2025

Branch preview

✅ Deployed successfully in branch deployment:

https://fix_api_reference--docs.review.5afe.dev

Copy link

github-actions bot commented Jan 17, 2025

Overall readability score: 31.53 (🔴 -0.09)

File Readability
generated-reference.mdx 49.94 (🟢 +0)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
generated-reference.mdx 49.94 41.9 12.16 14.6 12.53 7.45
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 31.53 27.46 13.67 17.39 15.72 8.97
  🔴 -0.09 🔴 -0.05 🔴 -0.02 🔴 -0.02 🔴 -0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@valle-xyz
Copy link
Collaborator

LGTM! I checked the bugs on Arbitrum and Base, and all are resolved as expected.

@valle-xyz valle-xyz self-requested a review January 17, 2025 15:30
@louis-md louis-md merged commit d8e0355 into main Jan 17, 2025
4 checks passed
@louis-md louis-md deleted the fix-api-reference branch January 17, 2025 15:40
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.

2 participants