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

[Feature Request]: improve example api values as they are not realistic #3317

Closed
jcstein opened this issue Apr 18, 2024 · 1 comment
Closed
Assignees
Labels
area:api Related to celestia-node API documentation Improvements or additions to documentation enhancement New feature or request external Issues created by non node team members

Comments

@jcstein
Copy link
Member

jcstein commented Apr 18, 2024

summary

gas of “42” is not realistic, etc

Implementation ideas

moving over celestiaorg/node-rpc-docs#32 as the changes need to happen here, and will then be imported into the node-rpc-docs

@jcstein jcstein added the enhancement New feature or request label Apr 18, 2024
@github-actions github-actions bot added the external Issues created by non node team members label Apr 18, 2024
@liamsi liamsi added area:api Related to celestia-node API documentation Improvements or additions to documentation labels Apr 19, 2024
@liamsi liamsi mentioned this issue Apr 23, 2024
11 tasks
@ramin ramin self-assigned this Jun 6, 2024
@ramin ramin added the v0.15.0 label Jun 13, 2024
@ramin
Copy link
Contributor

ramin commented Jul 1, 2024

after a bit of work on docgen, realizing there's no way to override single input values in an RPC calls without forking docgen and doing quite a bit of work, then discussing with @jcstein and @distractedm1nd it was determined that a) the improvements they are making to docs are good enough b) medium term, the reflection based automatic docgen was a nice start, but we need something better for docs that allows more specific input. Also, the work by the interfaces wg regarding a canonical API may well supersede JSON-RPC as the de facto developer interface for building. So, with @jcstein's blessing we will close this

@ramin ramin closed this as not planned Won't fix, can't repro, duplicate, stale Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Related to celestia-node API documentation Improvements or additions to documentation enhancement New feature or request external Issues created by non node team members
Projects
None yet
Development

No branches or pull requests

3 participants