Skip to content

[codex] Document JSON report schema and clean public links#27

Merged
stacknil merged 1 commit intomainfrom
codex/document-json-schema-public-links
Apr 30, 2026
Merged

[codex] Document JSON report schema and clean public links#27
stacknil merged 1 commit intomainfrom
codex/document-json-schema-public-links

Conversation

@stacknil
Copy link
Copy Markdown
Owner

Design

This PR documents the machine-readable JSON report shape for sbom-diff-and-risk and records the stable summary contract added in PR #26.

The new schema document explains the top-level JSON fields, the count-only base summary, the intentional absence of unchanged, conditional summary.policy, conditional summary.enrichment, sorted provider status_counts, stability expectations, and non-claims.

Files Changed

  • tools/sbom-diff-and-risk/docs/report-schema.md
  • tools/sbom-diff-and-risk/README.md
  • tools/sbom-diff-and-risk/docs/reviewer-evidence-pack.md
  • tools/sbom-diff-and-risk/docs/reviewer-brief.md
  • Existing public docs with local absolute Windows links were cleaned to use relative links.

Validation

  • git diff --check origin/main..HEAD
  • Scanned public Markdown for D:/OneDrive and D:\OneDrive; no matches remain.
  • Checked changed Markdown links; relative file links resolve.
  • Confirmed no runtime source, workflow, pyproject.toml, or version changes.

Out of Scope

  • No runtime behavior changes.
  • No CLI changes.
  • No workflow changes.
  • No package metadata or version changes.

@stacknil stacknil merged commit 2250b8e into main Apr 30, 2026
5 checks passed
@stacknil stacknil deleted the codex/document-json-schema-public-links branch April 30, 2026 08:05
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.

1 participant