Skip to content

fix(API): Replace v1 with v2 endpoints #735

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Conversation

germartinez
Copy link
Contributor

@germartinez germartinez commented Apr 10, 2025

What it solves

Resolves https://github.com/safe-global/developer-experience/issues/371

Changelog

  • Fix the generation script to take the Sepolia files correctly and adds a message for not documented and not deprecated endpoints.
  • Updates the json from swagger for Mainnet.
  • Updates the paths metadata for the new v2 endpoints.
  • Updates the generated schemas and files.
  • Updates code examples.

Checklist

Copy link

github-actions bot commented Apr 10, 2025

Branch preview

✅ Deployed successfully in branch deployment:

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

Copy link

github-actions bot commented Apr 11, 2025

Overall readability score: 36.33 (🔴 -0.09)

File Readability
polygon-reference.mdx 49.9 (🔴 -1.56)
optimism-reference.mdx 49.9 (🔴 -1.56)
mantle-reference.mdx 49.9 (🔴 -1.56)
mainnet-reference.mdx 49.9 (🔴 -1.56)
linea-reference.mdx 49.9 (🔴 -1.56)
gnosis-chain-reference.mdx 49.9 (🔴 -1.56)
chiado-reference.mdx 49.9 (🔴 -1.56)
celo-reference.mdx 49.9 (🔴 -1.56)
bsc-reference.mdx 49.9 (🔴 -1.56)
blast-reference.mdx 49.9 (🔴 -1.56)
base-sepolia-reference.mdx 49.9 (🔴 -1.56)
base-reference.mdx 49.9 (🔴 -1.56)
avalanche-reference.mdx 49.9 (🔴 -1.56)
aurora-reference.mdx 49.9 (🔴 -1.56)
arbitrum-reference.mdx 49.9 (🔴 -1.56)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
polygon-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
optimism-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
mantle-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
mainnet-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
linea-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
gnosis-chain-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
chiado-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
celo-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
bsc-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
blast-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
base-sepolia-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
base-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
avalanche-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
aurora-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04
arbitrum-reference.mdx 49.9 49.25 12.65 14.9 12.42 7.49
  🔴 -1.56 🔴 -1.11 🔴 -0.48 🔴 -0.4 🟢 +0.11 🔴 -0.04

Averages:

  Readability FRE GF ARI CLI DCRS
Average 36.33 32.26 13.1 16.49 15.14 8.68
  🔴 -0.09 🔴 -0.06 🔴 -0.03 🔴 -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

@germartinez germartinez marked this pull request as ready for review April 11, 2025 13:41
@germartinez germartinez requested a review from louis-md April 11, 2025 13:43
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.

1 participant