docs(openapi): pin CustomerPayment cpayDescription length to match the validator#296
Merged
CryptoJones merged 1 commit intoMay 19, 2026
Merged
Conversation
…e validator Extends the field-length pinning sweep. \`cpayDescription\` is validated by zod as \`z.string().max(10000)\`; pinning the same \`maxLength\` in the OpenAPI spec lets SDK generators surface the constraint. \`cpayAmount\` has zod refinements (finite + non-zero) that don't have direct OpenAPI primitives; documented inline so future readers know to consult the validator for the full contract. Other schemas with free-text fields (PurchaseOrderVendor, PurchaseOrderHeader, PurchaseOrderLine) still have unpinned OpenAPI components — separate follow-up PRs. This batch just covers CustomerPayment so the change stays one-entity-per-PR. No behavior change — pure spec metadata. 761 tests still pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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
Extends the field-length pinning sweep (Customer #270, Company #272, Worker #276, BillingType+InventoryItem #290, Job #294).
cpayDescriptionis validated by zod asz.string().max(10000). Pinning the samemaxLengthin the OpenAPI spec lets SDK generators surface the constraint to client types.Notes
cpayAmounthas zod refinements (finite + non-zero) that don't have direct OpenAPI primitives; documented inline so future readers know to consult the validator for the full contract.Test plan
npm run lint && npm test— 761 passing.Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/