Skip to content

No stability contract for JSON output #57

Description

@camwest

Problem: isq issue list --json output has no documented stability guarantees. AI agents and scripts that depend on this output could break when fields are added, renamed, or removed. This blocks the MCP Server roadmap item—agents need to trust the schema.

Goal: Document what "stable" means for structured output so consumers can depend on it confidently.

Success criteria:

  • Stability policy documented (e.g., "fields never removed, only added")
  • Clear versioning strategy if breaking changes ever needed
  • JSON output fields documented with their stability status
  • Policy referenced in README or DESIGN.md

Context (Rich Hickey's Spec-ulation): Good API evolution means "provide more, require less." Consumers should never break from updates. This is prerequisite for isq becoming infrastructure that agents depend on.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions