threefoldtech / web3gw

Proxy for the web3 world
Apache License 2.0
1 stars 1 forks source link

RPC documentation #133

Closed robvanmieghem closed 1 year ago

robvanmieghem commented 1 year ago

The RPC doc in the manual just says Coming soon...: Screenshot 2023-06-13 at 13 57 39

The readme states that OpenRPC json files are generated in the documentation but a single json file for all clients is not very human readable and https://threefoldtech.github.io/web3_proxy/openrpc/<client_name>/openrpc.json requires knowledge of the client name and is again not human readable.

The openrpc playground could be a solution but the link in the readme opens an OpenRPC playground with the default petstore example: Screenshot 2023-06-14 at 08 13 31

timurgordon commented 1 year ago

143 is a minor fix by adding the links to the playgrounds of each client, do you think it's necessary to have separate pages for each under the rpc chapter @robvanmieghem? It might be a bit redundant