Skip to content

[Docs] Update API examples for count and timestampMs properties #20

@dev-adamant-im

Description

@dev-adamant-im

Summary

Update API endpoint and transaction-related documentation so current response examples consistently include timestampMs where applicable and use numeric count values instead of quoted strings.

Details

The node API examples in the documentation should reflect the current payload structure after the spaceship consensus change and current response serialization behavior.

Scope:

  • add timestampMs to transaction examples and field descriptions where applicable
  • refresh response examples that still show count as a string
  • align affected endpoint pages and transaction/message type pages with current node responses
  • keep refreshed examples internally consistent for confirmations, timestamps, and related transaction fields

Affected documentation areas include:

  • api-endpoints/blocks.md
  • api-endpoints/chatrooms.md
  • api-endpoints/delegates.md
  • api-endpoints/kvs.md
  • api-endpoints/transactions.md
  • api-types/message-types.md
  • api-types/transaction-types.md
  • essentials/storing-data-in-kvs.md
  • essentials/working-with-contact-list.md

Checklist

  • Add timestampMs to affected transaction and endpoint examples
  • Document timestampMs meaning in the transaction field reference and link it to the spaceship consensus change where relevant
  • Replace quoted count examples with numeric values in affected responses
  • Refresh outdated example payloads where needed to keep related fields consistent
  • Review rendered docs pages for formatting and JSON example correctness
  • Link implementation PRs for traceability

Notes

Verification

  • Confirm affected docs pages display valid JSON examples and consistent field names and types.
  • Confirm transaction-related examples that can include timestampMs mention or show it consistently.
  • Confirm affected endpoints show count as a number, not a quoted string.
  • Confirm links to the spaceship consensus documentation resolve correctly where added.

Metadata

Metadata

Assignees

No one assigned

    Labels

    APIsAPI design, endpoints, and integrationsNodesADM node software issues, APIs, connectivity, consensusdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions