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

docs(API): create reference documentation for API using Open RPC standard #18

Merged
merged 5 commits into from
Nov 1, 2024

Conversation

BrunoCampana
Copy link
Member

Objective:

  • Document the API exposed by wallet applications to communicate with dApps on the Hathor platform.
  • API type: JSON-RPC 2.0.
  • API documented using the Open RPC standard.
  • API documented in the openrpc.json file.
  • The file should be used to automatically generate documentation on the Hathor docs website, similar to how it is already done with the full node and headless APIs.
  • The final format that will be used is still being defined.
  • For now, the following format can be used as a minimum standard to be used, but it should still improve the UI/UX:

https://beta-test.docs.hathor.network/references/dapps/rpc-api/htr_getBalance

Only one file to be reviewed: openrpc.json

@BrunoCampana BrunoCampana added the documentation Improvements or additions to documentation label Aug 26, 2024
@BrunoCampana BrunoCampana self-assigned this Aug 26, 2024
@BrunoCampana BrunoCampana reopened this Aug 28, 2024
docs/openrpc.json Outdated Show resolved Hide resolved
docs/openrpc.json Show resolved Hide resolved
docs/openrpc.json Outdated Show resolved Hide resolved
docs/openrpc.json Show resolved Hide resolved
docs/openrpc.json Outdated Show resolved Hide resolved
docs/openrpc.json Outdated Show resolved Hide resolved
docs/openrpc.json Show resolved Hide resolved
docs/openrpc.json Outdated Show resolved Hide resolved
docs/openrpc.json Outdated Show resolved Hide resolved
docs/openrpc.json Outdated Show resolved Hide resolved
@BrunoCampana BrunoCampana merged commit ac504bf into master Nov 1, 2024
@BrunoCampana BrunoCampana deleted the docs/openrpc branch November 1, 2024 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Waiting to be deployed
Development

Successfully merging this pull request may close these issues.

3 participants