Missing fields in the API documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 493
- PR merge metrics
- No merged PRs in 30d
Description
Certain required arguments are not specified in the current SDK API documentation. For example, wallet_send and account_send do not display an amount field, although it would be required. There are many other cases where some arguments could be missing, although I couldn't tell precisely all the cases. This appears to stem from a bug in scripts/generate_json_api.py.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading scripts/generate_json_api.py and inspect how required arguments are collected for wallet_send and account_send. Verify that amount and other required fields appear in the generated SDK API documentation, then check additional commands for similar omissions. Done means the generator includes all required arguments consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100