Skip to content

docs(audit): add the API adapter audit (#19) - #1909

Merged
cristim merged 5 commits into
mainfrom
docs/api-adapter-audit
Nov 10, 2026
Merged

cristim merged 5 commits into
mainfrom
docs/api-adapter-audit

Conversation

@cristim

@cristim cristim commented Nov 10, 2026

Copy link
Copy Markdown
Member

What

Adds docs/audits/api-adapter-audit-2026-11-09.md, the written adapter audit #19 asks for: for every API request adapter (request type plus handler call path) which fields reach their target and which are accepted and dropped, an appendix of all 64 decode sites at the audited commit, a test-coverage table, and how the existing guards keep it true. The doc states the method's limits.

Findings are fixed (#1788, #1905, #1906), already tracked (#1776, #923), or collected in the follow-up issue #1907.

The doc is committed in five commits of at most 315 added lines each, so the PR is merged with a rebase to keep that split on main.

Verification

  • Appendix diffed against git grep -n -E '(Unmarshal|Decode)\(' 72d90d54 -- internal/api internal/server ':!*_test.go' (64 lines): identical.
  • Field rows sampled against the code at the audited commit; guard-test line numbers checked.
  • markdownlint-cli 0.47.0 with the repo config: clean.
  • Local review: pass 1 by a cold reviewer (three accuracy nits fixed in the last commit); pass 2 on this head.

Closes #19

🤖 Generated with Claude Code

cristim and others added 5 commits November 10, 2026 02:04
…rations)

Documents which request fields reach their target and which are accepted and dropped, for the API request adapters at 72d90d5.

Part of #19

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ge, ladder)

Documents which request fields reach their target and which are accepted and dropped, for the API request adapters at 72d90d5.

Part of #19

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ides, auth)

Documents which request fields reach their target and which are accepted and dropped, for the API request adapters at 72d90d5.

Part of #19

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ge, appendix)

Documents which request fields reach their target and which are accepted and dropped, for the API request adapters at 72d90d5.

Closes #19

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The plan term, payment and target_coverage rows reach the target only when
provider and service are both set; say so. Name the six strict decoders and
note that the ladder config decode is covered by the follow-up issue.

Part of #19

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@cristim cristim added priority/p2 Backlog-worthy severity/medium Moderate harm urgency/this-sprint Within the current sprint type/chore Maintenance / non-user-visible triaged Item has been triaged impact/many Affects most users effort/m Days labels Nov 10, 2026
@coderabbitai

coderabbitai Bot commented Nov 10, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Review was skipped because the changed files are too large to review.

📏 Files whose diffs exceed the per-file size limit: 1

  • docs/audits/api-adapter-audit-2026-11-09.md

Retrying the review will skip these files again. If they are generated content such as fixtures or snapshots, exclude them with reviews.path_filters (for example !**/fixtures/**).

Run configuration

Commits

Reviewing files that changed from the base of the PR and between f81a259 and 70f83c4.

Files selected for processing: 1

  • docs/audits/api-adapter-audit-2026-11-09.md

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@cristim
cristim merged commit 854164a into main Nov 10, 2026
77 of 79 checks passed
@cristim
cristim deleted the docs/api-adapter-audit branch November 10, 2026 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/m Days impact/many Affects most users priority/p2 Backlog-worthy severity/medium Moderate harm triaged Item has been triaged type/chore Maintenance / non-user-visible urgency/this-sprint Within the current sprint

Projects

None yet

Development

Successfully merging this pull request may close these issues.

audit(internal): API* → internal-request adapter field-drop hygiene (followup to #893)

1 participant