-
Notifications
You must be signed in to change notification settings - Fork 41
Website: add RPC API documentation with CI validation #1745
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
Open
dannywillems
wants to merge
3
commits into
develop
Choose a base branch
from
dw/website-rpc-doc
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OCaml Reference Validation ResultsRepository: https://github.com/MinaProtocol/mina.git Click to see full validation output |
✓ Code Reference Verification PassedAll code references in the documentation have been verified successfully! Total references checked: 1 The documentation is in sync with the codebase on the |
c40a016 to
6a4017d
Compare
Add comprehensive documentation for the Mina Rust node's HTTP RPC endpoints, separate from the GraphQL API: - Create new api-and-data section and reorganize existing API documentation - Add RPC API reference page with all endpoint documentation - Add curl scripts for each RPC endpoint (17 scripts) - Add CI workflow to validate RPC endpoints against O1Labs node - Add rustdoc comments to RPC response structs in Rust code - Link documentation to Rust API docs for response structures - Fix broken links after documentation reorganization Closes #1743
6a4017d to
dbee53c
Compare
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
api-and-datasection and reorganize existing API documentationChanges
website/docs/developers/api-and-data/rpc-api.mdwith all RPC endpoints documented alphabetically.github/workflows/test-rpc-remote.ymlruns daily and on PR/push to validate endpointsscripts/rpc-api/curl/for endpoint examplesnode/src/rpc/mod.rsapi-and-data/subdirectoryCloses #1743
New mandatory CI jobs
The following jobs should be added as required status checks on
developandmainbranches:Test Rust Node RPC Endpoints (ubuntu-latest)test-rpc-remote.ymlTest Rust Node RPC Endpoints (macos-latest)test-rpc-remote.ymlCommands to add branch protection rules
Note: To append these checks to existing branch protection rules (preserving current settings), use the GitHub web UI at:
developandmain