Skip to content

JetStream wire API Reference page needs a re-design #733

@roeschter

Description

@roeschter

https://docs.nats.io/reference/reference-protocols/nats_api_reference

  • Too much information on this page: Split into:
    • reference (list of all subjects) and
    • explanations/Examples
    • Explanation of usage pattern where this information applies
  • Info applies to a range of areas
    • Security allow/deny - limit access to JS
    • accounts export/import
    • JS domains
    • mirror and source
  • Remove reference to GO API this should be language agnostic (we use Nats-cli as example)
  • Explain how to do interact with NATS-CLI and trace whats going on with
    • --trace
    • How do deduce this information using subscribe to $JS.>
    • nats events --all //The documentaion of this command in NATS CLI also needs an update
  • Needs examples/explanation how to use this information in specific scenarios
    • Limiting access to JetStream
    • Write access
    • Read access
    • Consumer create
    • Consumer access
  • How do pull consumers work in detail
  • How do push consumers work in detail
  • How to mirrors and sources work in detail

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions