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

Encoding format for REST API #125

Open
fabrice102 opened this issue Jun 3, 2020 · 0 comments
Open

Encoding format for REST API #125

fabrice102 opened this issue Jun 3, 2020 · 0 comments

Comments

@fabrice102
Copy link
Contributor

Is your addition related to a problem? Please describe.
A clear and concise description of what the problem is. What confusion does it cause? How does it affect developers?

The REST API https://developer.algorand.org/docs/reference/rest-apis/algod/ uses many types. For some such as date or string (byte) or boolean it may be difficult to know what the correct encoding is.

Describe the solution you'd like
A clear and concise description of what you want to happen. Which section needs to be added/modified? What should it include?

Two proposed solutions (which can be combined):

  • Provide a page describing the encoding formats of the various types.
  • Have a tooltip displaying the format when clicking on a given type
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

No branches or pull requests

2 participants
@fabrice102 and others