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

improve JSON API docs #27

Merged
merged 1 commit into from
Sep 12, 2019
Merged

improve JSON API docs #27

merged 1 commit into from
Sep 12, 2019

Conversation

jmank88
Copy link
Contributor

@jmank88 jmank88 commented Sep 12, 2019

Towards #8 and #23

"contract_address": "0xded28050fdbf604e12056e516c05e154cb5dd1bc",
"explorer_url": "https:\/\/explorer.gochain.io\/",
"rpc_url": "https:\/\/rpc.gochain.io",
"max_file_size": 1000000000 // in bytes
"max_file_size": 1000000000
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sidebar: since most users won't care about many of these fields, we should consider returning individual fields from /info/<field>, e.g. GET /v0/info/rate->2837942 or GET /v0/info/max_file_size->1000000000.

Copy link
Contributor

@treeder treeder left a comment

Choose a reason for hiding this comment

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

looks good.

@treeder treeder merged commit 08d29aa into master Sep 12, 2019
@treeder treeder deleted the api-doc branch September 12, 2019 19:31
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.

None yet

3 participants