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

openRpc doc #293

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

openRpc doc #293

wants to merge 17 commits into from

Conversation

rwwwx
Copy link
Contributor

@rwwwx rwwwx commented Oct 22, 2024

OpenRPC document draft WITHOUT examples
Just copy the whole json file and put it here https://playground.open-rpc.org to see doc

openrpc.json Outdated
},
"page": {
"name": "page",
"description": "Page based pagination (max 50)",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one should be marked as deprecated and discouraged from usage. The recommended way to paginate is using the after or cursor fields. Examples should reflect this as well

openrpc.json Outdated
},
"servers": [
{
"url": "https://rpc.metaplex.com/this_is_fake"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"url": "https://rpc.metaplex.com/this_is_fake"
"url": "https://aura-mainnet.metaplex.com/"

We also have https://aura-devnet.metaplex.com/

openrpc.json Outdated
"name": "asset"
}
],
"params": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing that shitload of filters

openrpc.json Outdated
},
"showGrandTotal": {
"type": "boolean",
"description": "Show grand total"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please figure out what this options do and add to the doc. You may ask teammates to figure this out or look at other refs.

@rwwwx rwwwx requested a review from StanChe October 24, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants