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.

Sign up for GitHub

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

Jump to bottom

Migrate/add JSON-RPC docs to ethereum.org #2322

Closed
4 tasks
ryancreatescopy opened this issue Jan 26, 2021 · 2 comments · Fixed by #2352
Closed
4 tasks

Migrate/add JSON-RPC docs to ethereum.org #2322

ryancreatescopy opened this issue Jan 26, 2021 · 2 comments · Fixed by #2352
Assignees
@ryancreatescopy @wackerow
Milestone
Docs migration + ...

Comments

@ryancreatescopy
Copy link
Contributor

ryancreatescopy commented Jan 26, 2021 •
edited by samajammin
Loading

Description

  • Make space for JSON RPC docs on ethereum.org
  • Can the UX/readability of specs be improved?
  • Publish specs
  • Set up redirects

Context

ethereum/eth-wiki#55
@samajammin
Copy link
Member

Opened up an issue on ethereum-oasis-op/eth1.x-JSON-RPC-API-standard#8 for input on this.

@samajammin
Copy link
Member

A couple ideas...

  1. I watched a great presentation from @pipermerriam recently where he categorized the core JSON-RPC endpoints:
    image
    I wonder if we should organize endpoints / allow filtering of endpoints in a similar manner?

  2. @djrtwo shared that the Eth2 folks built an API browser (from this repo). Looks like this was built using Swagger. I believe Swagger only support REST APIs (vs. JSON-RPC) but finding/creating a similar solution might be an alternative here vs. building the documentation into our Gatsby app. It would be nice to provide the ability to execute requests directly in the web UI & inspect response payload, which tools like Swagger provide out of the box.

wackerow added a commit that referenced this issue Jan 29, 2021
@wackerow
initial json rpc docs commit [WIP #2322]
2d9f6be
@wackerow wackerow mentioned this issue Feb 1, 2021
Merged
@wackerow wackerow linked a pull request Feb 17, 2021 that will close this issue
Add JSON-RPC API docs [Fixes #2322] #2352
Merged
samajammin added a commit that referenced this issue Mar 12, 2021
@samajammin
Merge pull request #2352 from ethereum/json-rpc
9beb1f7 
Add JSON-RPC API docs [Fixes #2322]
@wackerow wackerow mentioned this issue Mar 12, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ryancreatescopy ryancreatescopy

@wackerow wackerow

Labels
None yet
Projects
None yet
Milestone
Docs migration + consolidation
Development

Successfully merging a pull request may close this issue.

Add JSON-RPC API docs [Fixes #2322] ethereum/ethereum-org-website
3 participants
@samajammin @ryancreatescopy @wackerow