[go: up one dir, main page]

Document version rpc argument

Context

This MR adds some documentation for the version argument of both protocol and shell RPCs that supports it.

The results with OpenAPI should look like: image

Manually testing the MR

Run the following command to output the raw json description of a versioned RPC and look for the version argument documentation:

octez-client  rpc get /describe/chains/main/mempool/pending_operations

Checklist

  • n/a Document the interface of any function added or modified (see the coding guidelines)
  • n/a Document any change to the user interface, including configuration parameters (see node configuration)
  • n/a Provide automatic testing (see the testing guide).
  • n/a For new features and bug fixes, add an item in the appropriate changelog (docs/protocols/alpha.rst for the protocol and the environment, CHANGES.rst at the root of the repository for everything else).
  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR
Edited by Albin Coquereau

Merge request reports

Loading