DOCS: remove third-party names from generated API descriptions #903

Open
opened 2026-10-02 17:38:32 +00:00 by kayg · 1 comment
Owner

Evidence

At the #863 audit base, a case-sensitive scan found 11 comment lines in packages/api-client/src/generated.ts that name common third-party products. Examples: generated.ts:617 and :4794 name Unsplash; :5746 names Apple; :6522 names YNAB. This file is generated, so edits here alone will be overwritten.

Owner rule

Comments are documentation. Source comments must not name third-party products.

Expected behaviour

Find and update the source OpenAPI descriptions, then regenerate the client. Describe the image source, sidecar format, and budget state without product names. Keep the generated client in sync with its source.

Test idea

Regenerate the client and check that the source and generated descriptions contain no third-party names. Do not change API behavior or schema types.

## Evidence At the #863 audit base, a case-sensitive scan found 11 comment lines in `packages/api-client/src/generated.ts` that name common third-party products. Examples: `generated.ts:617` and `:4794` name Unsplash; `:5746` names Apple; `:6522` names YNAB. This file is generated, so edits here alone will be overwritten. ## Owner rule Comments are documentation. Source comments must not name third-party products. ## Expected behaviour Find and update the source OpenAPI descriptions, then regenerate the client. Describe the image source, sidecar format, and budget state without product names. Keep the generated client in sync with its source. ## Test idea Regenerate the client and check that the source and generated descriptions contain no third-party names. Do not change API behavior or schema types.
Author
Owner

The web job cannot safely complete #903 within its assigned comment-only scope. packages/api-client/package.json generates src/generated.ts from contracts/openapi.json. The descriptions come from Rust schema and route documentation. Correcting only the generated comments would be overwritten, as this issue warns. Both the source descriptions and JSON contract are outside this job's owned apps/web/src, packages/*/src files. No generated-only edit made. The Rust documentation job must correct those descriptions and regenerate the contract/client together; preserve schema types and runtime behavior.

The web job cannot safely complete #903 within its assigned comment-only scope. `packages/api-client/package.json` generates `src/generated.ts` from `contracts/openapi.json`. The descriptions come from Rust schema and route documentation. Correcting only the generated comments would be overwritten, as this issue warns. Both the source descriptions and JSON contract are outside this job's owned `apps/web/src`, `packages/*/src` files. No generated-only edit made. The Rust documentation job must correct those descriptions and regenerate the contract/client together; preserve schema types and runtime behavior.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
kayg/calternal#903
No description provided.