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

Make API editable and callable from docs #315

Open
1 task
anadi2311 opened this issue Feb 14, 2024 · 0 comments
Open
1 task

Make API editable and callable from docs #315

anadi2311 opened this issue Feb 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@anadi2311
Copy link
Contributor

🎯 Problem to be solved

Currently the apis on https://docs.obol.tech/api are not directly executable on docs. If someone wants to call the API through browser, they have to use Swagger which is not public facing. https://api.obol.tech/docs#/

This increases time to first call for dev.

If it is too much of issue, then we should at least let users input the query and path parameters and copy the HTTP or Curl so that they can use that in postman/ cmd line quicklu

🛠️ Proposed solution

  • let users input the parameters and call API directly from docs and copy the API to be used
  • If cannot call from docs, let them input parameters and copy API from the docs.

🧪 Tests

  • Netlify deployment build tests passing

👐 Additional acceptance criteria

❌ Out of Scope

@anadi2311 anadi2311 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 14, 2024
@anadi2311 anadi2311 changed the title Make API executable from docs Make API editable and callable from docs Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant