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: IPFS examples #385

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Fix: IPFS examples #385

merged 2 commits into from
Nov 26, 2024

Conversation

Ryun1
Copy link
Contributor

@Ryun1 Ryun1 commented Nov 18, 2024

What

I believe

  • because no x-codeSamples are provided for the IPFS endpoints (except POST /ipfs/add)
  • then the site generated usage examples shown via https://docs.blockfrost.io/ default to showing the wrong path
    • Shown is https://cardano-mainnet.blockfrost.io, the correct path is https://ipfs.blockfrost.io/api/v0/ipfs.
  • this is not the case for POST /ipfs/add because an example x-codeSamples is given.
Screenshot 2024-11-18 at 21 54 51

Changes

  • I have added a x-codeSamples example for each IPFS endpoint, with the correct base path (https://ipfs.blockfrost.io/api/v0/ipfs)

Why

  • Incorrect examples being given by defualt can be confusing for people trying to use the IPFS endpoints
    • I was stuck for an embarrassing amount of time...

Notes

  • This might not be the best way to fix this, as this only fixes the issue for the cURL example.
  • Draft because I haven't been able to run an instance of the hosted website, to double check that this is correct - im not familiar with rust so im unsure

Copy link

vercel bot commented Nov 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 9:20pm

@vladimirvolek
Copy link
Member

Looking good thanks!

@vladimirvolek vladimirvolek merged commit cace743 into blockfrost:master Nov 26, 2024
3 checks passed
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