Skip to content

Protocol versioning policy and schema normalization #20

@mark-e-deyoung

Description

@mark-e-deyoung

Problem

  1. protocol/schema_v1.json isn't valid JSON (uses mustache {{}} brackets). No external validator can parse it.
  2. Protocol declares version 1.0.0 but has no MAJOR.MINOR policy for backwards compatibility.
  3. Old clients have no way to negotiate a supported version range.

Proposed Solution

  1. Normalize schema_v1.json to valid JSON
  2. Document versioning policy: MINOR adds methods (backwards compatible), MAJOR changes/removes methods
  3. Add daemon.protocolVersion method returning supported version range

References

  • Scalability audit item 2

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions