Skip to content

docs: document JSON output schema#5

Open
1cbyc wants to merge 1 commit into
jmweb-org:mainfrom
1cbyc:docs/json-output-schema
Open

docs: document JSON output schema#5
1cbyc wants to merge 1 commit into
jmweb-org:mainfrom
1cbyc:docs/json-output-schema

Conversation

@1cbyc

@1cbyc 1cbyc commented Jun 29, 2026

Copy link
Copy Markdown

Summary

  • Document the --json response shape in the README
  • Add a concrete example payload and field reference tables
  • Strengthen CLI JSON test coverage so the documented schema stays stable

Test Plan

  • uv run pytest
  • uv run ruff check .

Fixes #4

Signed-off-by: 1cbyc <isaacnsisong@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the JSON output schema

1 participant