Skip to content

Initial Cookbook structure #423

@6r1d

Description

@6r1d

We just had a meeting with @0x009922, @mversic, @AlexStroke and @dmitrivenger.

We need a new API documentation structure to make all examples between different API versions available.
This is a structure we've established:

  • Transactions
    • Using different ISIs
    • MST
    • Smartcontracts
    • Expressions?
  • Query
    • Show default usage
    • Show filters (not a priority, as DSL can be implemented, a few examples would be useful - @mversic)
    • Show how lazy pagination should be used
    • Query connected peers
  • Block stream
    • Show how to subscribe
    • Show how does the output look
  • Events
    • Different filters, different events
  • Telemetry
    • How to do something useful with telemetry, e.g. check load or performance
    • How to check status
    • How to get metrics
    • Healthcheck - route, data structure
  • Triggers
    • Show multiple examples of different triggers with different actions
  • Executor
    • Write and update one
  • Philosophy of how to work with different aspects of Iroha
    • Checking what peer among the current is the leader??
    • Checking current peer's load?

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-importantHigh-impact, important changeM-epicIssues/PRs that depend on other items (e.g. tracking issues)

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions