From ee5509fecaafb4ce30a5f36d932506649be4918b Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 26 Oct 2025 07:51:04 +1100 Subject: [PATCH] Change invoice item spec for api docs --- openapi/api-docs.yaml | 127 +----------------- openapi/components/schemas/quote_request.yaml | 63 +-------- .../schemas/recurring_invoice_request.yaml | 63 +-------- 3 files changed, 8 insertions(+), 245 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 593c3d1c15..c0bce9700c 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -18642,69 +18642,9 @@ components: example: 'Custom value 4' line_items: type: array - description: 'Array of line items for the quote' + description: 'An array of objects which define the line items of the quote' items: - type: object - properties: - quantity: - type: number - example: 1 - cost: - type: number - example: 14.00 - product_key: - type: string - example: 'sku_4_u' - notes: - type: string - example: 'The actual product description' - discount: - type: number - example: 0 - is_amount_discount: - type: boolean - example: true - tax_name1: - type: string - example: '' - tax_rate1: - type: number - example: 0 - tax_name2: - type: string - example: '' - tax_rate2: - type: number - example: 0 - tax_name3: - type: string - example: '' - tax_rate3: - type: number - example: 0 - sort_id: - type: string - example: '0' - custom_value1: - type: string - example: 'https://picsum.photos/200' - custom_value2: - type: string - example: '94' - custom_value3: - type: string - example: 'Alias vel eveniet.' - custom_value4: - type: string - example: 'Iusto aut quis qui.' - type_id: - type: string - example: '1' - tax_id: - type: string - example: '1' - type: object - + $ref: '#/components/schemas/InvoiceItem' Document: properties: id: @@ -24011,68 +23951,9 @@ components: example: 'Custom value 4' line_items: type: array - description: 'Array of line items for the recurring invoice' + description: 'An array of objects which define the line items of the invoice' items: - type: object - properties: - quantity: - type: number - example: 1 - cost: - type: number - example: 14.00 - product_key: - type: string - example: 'sku_4_u' - notes: - type: string - example: 'The actual product description' - discount: - type: number - example: 0 - is_amount_discount: - type: boolean - example: true - tax_name1: - type: string - example: '' - tax_rate1: - type: number - example: 0 - tax_name2: - type: string - example: '' - tax_rate2: - type: number - example: 0 - tax_name3: - type: string - example: '' - tax_rate3: - type: number - example: 0 - sort_id: - type: string - example: '0' - custom_value1: - type: string - example: 'https://picsum.photos/200' - custom_value2: - type: string - example: '94' - custom_value3: - type: string - example: 'Alias vel eveniet.' - custom_value4: - type: string - example: 'Iusto aut quis qui.' - type_id: - type: string - example: '1' - tax_id: - type: string - example: '1' - type: object + $ref: '#/components/schemas/InvoiceItem' Product: type: object properties: diff --git a/openapi/components/schemas/quote_request.yaml b/openapi/components/schemas/quote_request.yaml index 81ada60cc8..66cb44f143 100644 --- a/openapi/components/schemas/quote_request.yaml +++ b/openapi/components/schemas/quote_request.yaml @@ -44,65 +44,6 @@ example: 'Custom value 4' line_items: type: array - description: 'Array of line items for the quote' + description: 'An array of objects which define the line items of the quote' items: - type: object - properties: - quantity: - type: number - example: 1 - cost: - type: number - example: 14.00 - product_key: - type: string - example: 'sku_4_u' - notes: - type: string - example: 'The actual product description' - discount: - type: number - example: 0 - is_amount_discount: - type: boolean - example: true - tax_name1: - type: string - example: '' - tax_rate1: - type: number - example: 0 - tax_name2: - type: string - example: '' - tax_rate2: - type: number - example: 0 - tax_name3: - type: string - example: '' - tax_rate3: - type: number - example: 0 - sort_id: - type: string - example: '0' - custom_value1: - type: string - example: 'https://picsum.photos/200' - custom_value2: - type: string - example: '94' - custom_value3: - type: string - example: 'Alias vel eveniet.' - custom_value4: - type: string - example: 'Iusto aut quis qui.' - type_id: - type: string - example: '1' - tax_id: - type: string - example: '1' - type: object + $ref: '#/components/schemas/InvoiceItem' \ No newline at end of file diff --git a/openapi/components/schemas/recurring_invoice_request.yaml b/openapi/components/schemas/recurring_invoice_request.yaml index aca6e41659..064321e0d1 100644 --- a/openapi/components/schemas/recurring_invoice_request.yaml +++ b/openapi/components/schemas/recurring_invoice_request.yaml @@ -53,65 +53,6 @@ example: 'Custom value 4' line_items: type: array - description: 'Array of line items for the recurring invoice' + description: 'An array of objects which define the line items of the invoice' items: - type: object - properties: - quantity: - type: number - example: 1 - cost: - type: number - example: 14.00 - product_key: - type: string - example: 'sku_4_u' - notes: - type: string - example: 'The actual product description' - discount: - type: number - example: 0 - is_amount_discount: - type: boolean - example: true - tax_name1: - type: string - example: '' - tax_rate1: - type: number - example: 0 - tax_name2: - type: string - example: '' - tax_rate2: - type: number - example: 0 - tax_name3: - type: string - example: '' - tax_rate3: - type: number - example: 0 - sort_id: - type: string - example: '0' - custom_value1: - type: string - example: 'https://picsum.photos/200' - custom_value2: - type: string - example: '94' - custom_value3: - type: string - example: 'Alias vel eveniet.' - custom_value4: - type: string - example: 'Iusto aut quis qui.' - type_id: - type: string - example: '1' - tax_id: - type: string - example: '1' - type: object \ No newline at end of file + $ref: '#/components/schemas/InvoiceItem' \ No newline at end of file