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

Add openrpc generator and use JsonSchema to update rpc/readme #4187

Merged
merged 73 commits into from
Feb 6, 2024

Conversation

chenyukang
Copy link
Collaborator

@chenyukang chenyukang commented Oct 11, 2023

What problem does this PR solve?

Issue Number: close #4149

Problem Summary:
Our old way of using rpc.py to generate document has some compatibility issues, we may need to tweak it when updating to a new version of rustc, since the format for HTML from cargo doc may change.

This PR introduce a way to use JsonSchema to generated PRC document.

What is changed and how it works?

  • Add derive JsonSchema for data structures used by rpc
  • Add ckb-rpc-gen to generate rpc/README.md
  • Support dump openrpc specs for better dev experience
  • There is a bug from schemars, we may need to contribute the patch to upstream, before that we need to use a patched version.

What's Changed:

Related changes

  • PR to update owner/repo:
  • Need to cherry-pick to the release branch

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code ci-runs-only: [ quick_checks,linters ]

Side effects

  • Performance regression
  • Breaking backward compatibility

Release note

Title Only: Include only the PR title in the release note.

@chenyukang chenyukang requested a review from a team as a code owner October 11, 2023 16:43
@chenyukang chenyukang requested review from zhangsoledad and removed request for a team October 11, 2023 16:43
@chenyukang chenyukang force-pushed the rpc-openrpc-gen branch 7 times, most recently from 2d37bcd to bac7bfb Compare February 2, 2024 02:46
eval-exec
eval-exec previously approved these changes Feb 2, 2024
zhangsoledad
zhangsoledad previously approved these changes Feb 6, 2024
@zhangsoledad zhangsoledad added this pull request to the merge queue Feb 6, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 6, 2024
@chenyukang chenyukang added this pull request to the merge queue Feb 6, 2024
Merged via the queue into develop with commit d6e9341 Feb 6, 2024
32 checks passed
@doitian doitian mentioned this pull request Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
b:rpc Break RPC interface
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants