hedera-docs icon indicating copy to clipboard operation
hedera-docs copied to clipboard

Adding Documentation for NetworkVersionInfoQuery in SDK sections

Open ed-marquez opened this issue 1 year ago • 0 comments

Problem

The Hedera API and SDKs have a query to obtain the version of Services software deployed on a given environment (mainnet, testnet, previewnet).

  • In the protobufs, it's NetworkGetVersionInfoResponse
  • Documented:
  • Here: https://docs.hedera.com/hedera/sdks-and-apis/hedera-api/miscellaneous/networkgetversioninfo
  • and here: https://docs.hedera.com/hedera/sdks-and-apis/hedera-api/miscellaneous/networkservice

In the JS SDK, this query is given by NetworkVersionInfoQuery

However, it is not documented in any of the SDK sections.

Solution

Here are some suggested places to include information about this query:

  • Include notes about the ability to query version info in: https://docs.hedera.com/hedera/networks
  • List the query on: https://docs.hedera.com/hedera/sdks-and-apis/sdks/queries
  • Add a dedicated page for the SDK query in the SDKs section: https://docs.hedera.com/hedera/sdks-and-apis/sdks (May need a network submenu in the SDK section)

cc: @kry

Alternatives

No response

ed-marquez avatar Feb 05 '24 18:02 ed-marquez