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

Generate Open RPC specification #4149

Closed
doitian opened this issue Sep 12, 2023 · 3 comments
Closed

Generate Open RPC specification #4149

doitian opened this issue Sep 12, 2023 · 3 comments
Assignees
@chenyukang
Labels
good first issue Good for newcomers help wanted Extra attention is needed p:could-have Priority: desirable but not necessary t:doc Type: Documentation t:enhancement Type: Feature, refactoring.

Comments

@doitian
Copy link
Member

doitian commented Sep 12, 2023

Feature Request

Is your feature request related to a problem? Please describe.

Open RPC is Open API for JSON RPC.

Generating the OPEN RPC specification allows user to try the RPC methods in the playground.

Describe the solution you'd like

Generating the Open RPC specification from the code or from rpc/README.md
@doitian doitian added help wanted Extra attention is needed good first issue Good for newcomers t:doc Type: Documentation t:enhancement Type: Feature, refactoring. labels Sep 12, 2023
@eval-exec eval-exec self-assigned this Sep 12, 2023
@eval-exec eval-exec moved this to 🆕 New in CKB Kanban Sep 12, 2023
@eval-exec
Copy link
Collaborator

We need this feature, and I prefer the web UI design by rapidocweb.

@doitian doitian added the p:could-have Priority: desirable but not necessary label Sep 12, 2023
@doitian
Copy link
Member Author

doitian commented Sep 12, 2023

We need this feature, and I prefer the web UI design by rapidocweb.

Open API does not play well with JSON RPC

@eval-exec
Copy link
Collaborator

eval-exec commented Sep 13, 2023 •
edited
Loading

Why Open API not play well with JSON-RPC?

I found this: https://cronos.org/swagger/jsonrpc.json. The ethereum JSON-RPC schema are defined by Open API, and they provide documented it by swagger, looks better than Open RPC's web UI.: https://cronos.org/swagger?network=mainnet#/ETH%20Methods/eth_accounts

ref:

  1. Describe the advantages of open-rpc over openapi open-rpc/spec#112
  2. Support an RPC structure of API OAI/OpenAPI-Specification#664

@eval-exec eval-exec removed their assignment Sep 14, 2023
@chenyukang chenyukang self-assigned this Sep 26, 2023
@eval-exec eval-exec moved this from 🆕 New to 🏗 In progress in CKB Kanban Oct 7, 2023
@chenyukang chenyukang mentioned this issue Oct 11, 2023
Merged
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in CKB Kanban Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chenyukang chenyukang

Labels
good first issue Good for newcomers help wanted Extra attention is needed p:could-have Priority: desirable but not necessary t:doc Type: Documentation t:enhancement Type: Feature, refactoring.
Projects
CKB Kanban
Archived in project
Milestone
No milestone
Development

No branches or pull requests
3 participants
@doitian @chenyukang @eval-exec