docs icon indicating copy to clipboard operation
docs copied to clipboard

Encoding format for REST API

Open fabrice102 opened this issue 5 years ago • 0 comments

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

fabrice102 avatar Jun 03 '20 01:06 fabrice102