Skip to content

docs(openapi): pin BillingType + InventoryItem schema field constraints #290

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 BillingType + InventoryItem schema field constraints #290

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
14 changes: 11 additions & 3 deletions app/config/openapi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,13 @@ const billingTypeSchema = {
type: 'object',
properties: {
btId: { type: 'integer', readOnly: true },
btName: { type: 'string' },
btHourlyRate: { type: 'number' },
// Mirror billingtype.schema.js: min(1).max(255) on btName,
// finite + non-negative on btHourlyRate. Pinning the bounds
// here lets SDK generators (openapi-typescript et al.) carry
// the constraints into client types. Same pattern as Customer
// (#270), Company (#272), Worker (#276).
btName: { type: 'string', minLength: 1, maxLength: 255 },
btHourlyRate: { type: 'number', minimum: 0 },
btCompId: { type: 'integer' },
btArch: { type: 'boolean', readOnly: true },
},
Expand All @@ -90,7 +95,10 @@ const inventoryItemSchema = {
type: 'object',
properties: {
invitId: { type: 'integer', readOnly: true },
invitDescription: { type: 'string' },
// Mirror inventoryitem.schema.js: min(1).max(1000) on
// invitDescription, finite on invitQty. Same pattern as the
// other entity component-schema pinning PRs.
invitDescription: { type: 'string', minLength: 1, maxLength: 1000 },
invitQty: { type: 'number' },
invitCompId: { type: 'integer' },
invitArch: { type: 'boolean', readOnly: true },
Expand Down