141 Matching Annotations
  1. Jan 2018
    1. Where: errors - list of errors, there should always be at least one item in the list code - the pre-defined code of the error message - a developer-friendly message describing the reason for the error details - a list of additional details about the error, depends on the error code

      These items would be better presented as bullets.

    2. Responses which return a list of results (e.g. a list of users) are paged by default. You can select which page you’d like to retrieve by appending a ?page=XX query parameter, by default the first page is displayed. The page size can be adjusted by appending a ?page_size=XX query parameter, by default page_size=100. For navigating through the paged results, the response will contain headers with additional information about paging results following the RFC 5988-bis standard.

      I like the use of white space in this kind of document and recommend its application to all paragraphed text throughout.

    3. In cryptocurrency systems, a public key usually refers to your address where tokens (think bitcoin or factoids) can be sent to you.

      I don't think referring to cryptocuurency here is relevant, necessary, or reassuring to a Harmony customer.