Skip to content

docs(openapi): pin CustomerPayment cpayDescription length to match the validator #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CryptoJones merged 1 commit into from
May 19, 2026
Merged

docs(openapi): pin CustomerPayment cpayDescription length to match the validator #296

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion app/config/openapi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,15 @@ const customerPaymentSchema = {
properties: {
cpayId: { type: 'integer', readOnly: true },
cpayCustId: { type: 'integer' },
cpayDescription: { type: 'string' },
// customerpayment.schema.js: cpayDescription is optional and
// capped at 10000 chars (the same ceiling used for other free-
// text fields). Pinning maxLength here matches the validator.
cpayDescription: { type: 'string', maxLength: 10000 },
cpayDate: { type: 'string', format: 'date' },
// cpayAmount must be finite + non-zero (a $0 ledger entry is
// operator error). The non-zero rule isn't expressible in
// OpenAPI's standard vocabulary, but operators can read the
// zod source for the full contract.
cpayAmount: { type: 'number' },
cpayArch: { type: 'boolean', readOnly: true },
},
Expand Down