Skip to content

Explain API consumer checks alongside indexed impact - #1084

Open
zlareb1 wants to merge 3 commits into
mainfrom
docs/api-change-contract-boundary
Open

zlareb1 wants to merge 3 commits into
mainfrom
docs/api-change-contract-boundary

Conversation

@zlareb1

@zlareb1 zlareb1 commented Nov 20, 2026

Copy link
Copy Markdown
Member

Changelog category

  • Documentation

Changelog entry

Explain how indexed change-impact evidence fits alongside API consumer-contract checks.

Why

An API can break an existing client without changing an indexed call site. The operations guide explains callers and tests but does not show how that evidence differs from checking consumer expectations.

Scope and risk

Add one subsection to the existing code-operations page. Use an optional request field becoming required as the example. Ask readers to compare schemas, required fields, status codes and error behavior separately, and report consumers outside the available scope. A caller list does not establish API compatibility.

Compatibility, rollout and rollback

Documentation only. No API, runtime, dependency, configuration or translation change. Existing examples, headings and generated summary inputs remain unchanged. Reverting removes the added subsection.

Tests

  • The selected page passes cached Prettier, the page and public body pass the prose checker, and the whitespace check passes.
  • No local test suite, site build, model evaluation or provider call ran. Documentation links, public-copy checks and the full required suite run in hosted CI and must pass before merge.
  • No performance, cost, recommendation or automated contract-testing claim is added.

AI assistance in the code

  • AI-generated: Codex wrote the documentation using the current operation reference and an independently reviewed plan.

  • I can explain every changed line.

Checklist

  • Selected formatting and prose checks pass.
  • Required hosted CI passes.
  • Fresh independent review of the pushed head has no findings.

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
@vercel

vercel Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
loom-docs Ready Ready Preview Nov 21, 2026 12:37am UTC

Request Review

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>

This branch has not been deployed

No deployments
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