ObolNetwork / ObolNetwork/obol-docs

Make API editable and callable from docs

Open
#315 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
MDX
Stars
27
Forks
61
Avg merge
1h 22m
Merged PRs (30d)
2

Description

🎯 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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the API documentation page at https://docs.obol.tech/api and compare it with the Swagger entry point at https://api.obol.tech/docs#/. Establish whether the completed work should support direct calls or parameter entry with HTTP/cURL copying, then verify the chosen flow and the Netlify deployment build before considering it done.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.