search

prysmaticlabs / prysm

Go implementation of Ethereum proof of stake
https://www.offchainlabs.com
GNU General Public License v3.0
3.47k stars 998 forks source link

Create an OpenAPI specification for custom Prysm endpoints #12794

Open rkapka opened 1 year ago

rkapka commented 1 year ago

🚀 Feature Request

Description

We currently have several custom endpoints under /beacon-chain/rpc/prysm/node and /beacon-chain/rpc/prysm/validator. They are not documented anywhere making them hard to find and use properly. We would like to have a page similar to https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.4.2 that describes custom Prysm endpoints.

The exact design is unknown at this point. We can probably leverage some Go package to generate the spec from the definitions.

0xCMars commented 1 year ago

Maybe we can use the swagger to generate the API page automatically, I think that Ethereum also uses swagger to generate their beacon API docs. swagger

wrik0 commented 6 months ago

@rkapka Is it gonna be alright if the swagger doc/page is OAS 2.0 and not OAS 3.0? Something like this?

tushar994 commented 5 days ago

@rkapka is this still wanted? I would like to take it up.