Conversation
Backfill all 46 documented sections as BC4 so subsequent BC5 absorption PRs can mark new endpoints as BC5 and the matrix doubles as a per-version coverage tracker. Column dropped post-BC4 decommission.
github-actions
Bot
added
docs
documentation
There was a problem hiding this comment.
Pull request overview
This PR updates the API coverage matrix documentation to support BC5 absorption tracking by adding a Since column and populating it across the matrix.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
Changes:
- Add a Since column (BC4/BC5) between Status and Priority in
API-COVERAGE.md. - Backfill existing rows with
BC4to establish a baseline for future BC5-only additions. - Add a short explanation of how to interpret the new column.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Per review of #461: the Since column tags rows (sections), not individual endpoints, so reword to match. Add the rule that BC5 endpoints introduced to an existing BC4 section land on a new row, not by bumping the BC4 row's count — keeps the column unambiguous. Add a note acknowledging that the Summary's endpoint totals do not match the per-row Endpoints column. The discrepancy predates this PR; the row count (46 sections) is authoritative for Since tracking.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sincecolumn toAPI-COVERAGE.mdbetweenStatusandPriorityBC4(42 implemented ✅, 4 out-of-scope ⏭️); the 2 reference-only rows remain-since they document zero endpointsBC5row rather than mixing under the BC4 rowPre-existing count discrepancy
The Summary's endpoint totals (155 / 12 / 167) do not match the table's per-row Endpoints column (which sums to 226 / 28 / 254). This predates the PR —
scripts/doc_parity.pyis bash-era and reports 0/309 against the Go codebase, so no authoritative reconciliation is possible from in-repo tooling. A note next to the Summary qualifies this; the 46-row count is authoritative forSincetracking. Reconciling endpoint counts is tracked separately.Test plan
bin/cigreen (full local CI gate: fmt, vet, lint, test, e2e, naming, surface, skill drift, bare groups, smoke coverage, provenance, tidy)