onflow / onflow/docs

Interactive API docs

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

https://developers.flow.com/http-api/

There are interactive ways to integrate API calls directly on the developer portal
It is built using Swagger / OpenAPI
Currently, the interactive API calls are broken and the requests do not go through. This needs to be fixed

moved from https://github.com/onflow/developer-portal/issues/756

Contributor guide

Open the contributing guide

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 interactive API documentation at https://developers.flow.com/http-api/ and inspect how its Swagger/OpenAPI requests are configured and sent. Reproduce a failing interactive call, then trace the relevant developer-portal configuration. Done means the documented interactive API calls successfully send requests and return responses.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.