Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-06-01 02:44:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updates for upload route

Browse Source
This commit is contained in:
David Bomba 2023-11-23 12:08:50 +11:00
parent e7b2afb0be
commit b1d11c0bbe
12 changed files with 370 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

203
openapi/api-docs.yaml
View File

@ -9092,7 +9092,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/tasks/{id}/upload": "/api/v1/tasks/{id}/upload":
put: post:
tags: tags:
- tasks - tasks
summary: "Uploads a task document" summary: "Uploads a task document"
@ -9110,6 +9110,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Task object" description: "Returns the Task object"
@ -9511,7 +9528,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/projects/{id}/upload": "/api/v1/projects/{id}/upload":
put: post:
tags: tags:
- projects - projects
summary: "Uploads a project document" summary: "Uploads a project document"
@ -9529,6 +9546,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Project object" description: "Returns the Project object"
@ -9995,7 +10029,7 @@ paths:
default: default:
$ref: '#/components/responses/default' $ref: '#/components/responses/default'
'/api/v1/clients/{id}/upload': '/api/v1/clients/{id}/upload':
put: post:
tags: tags:
- clients - clients
summary: 'Add client document' summary: 'Add client document'
@ -10685,7 +10719,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/credits/{id}/upload": "/api/v1/credits/{id}/upload":
put: post:
tags: tags:
- credits - credits
summary: "Upload a credit document" summary: "Upload a credit document"
@ -10703,6 +10737,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Credit object" description: "Returns the Credit object"
@ -11213,7 +11264,7 @@ paths:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/payments/{id}/upload": "/api/v1/payments/{id}/upload":
put: post:
tags: tags:
- payments - payments
summary: "Upload a payment document" summary: "Upload a payment document"
@ -11231,6 +11282,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Payment object" description: "Returns the Payment object"
@ -12471,7 +12539,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/recurring_invoices/{id}/upload": "/api/v1/recurring_invoices/{id}/upload":
put: post:
tags: tags:
- Recurring Invoices - Recurring Invoices
summary: "Add recurring invoice document" summary: "Add recurring invoice document"
@ -12489,6 +12557,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the RecurringInvoice object" description: "Returns the RecurringInvoice object"
@ -13000,7 +13085,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/quotes/{id}/upload": "/api/v1/quotes/{id}/upload":
put: post:
tags: tags:
- quotes - quotes
summary: "Upload a quote document" summary: "Upload a quote document"
@ -13018,6 +13103,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Quote object" description: "Returns the Quote object"
@ -13438,7 +13540,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/purchase_orders/{id}/upload": "/api/v1/purchase_orders/{id}/upload":
put: post:
tags: tags:
- Purchase Orders - Purchase Orders
summary: "Uploads a purchase order document" summary: "Uploads a purchase order document"
@ -13456,6 +13558,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Purchase Order object" description: "Returns the Purchase Order object"
@ -13865,7 +13984,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/vendors/{id}/upload": "/api/v1/vendors/{id}/upload":
put: post:
tags: tags:
- vendors - vendors
summary: "Uploads a vendor document" summary: "Uploads a vendor document"
@ -13883,6 +14002,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Vendor object" description: "Returns the Vendor object"
@ -17926,22 +18062,18 @@ components:
description: 'The hashed if of the contact' description: 'The hashed if of the contact'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
user_id: user_id:
description: 'The hashed id of the user who created the contact' description: 'The hashed id of the user who created the contact'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
company_id: company_id:
description: 'The hashed id of the company' description: 'The hashed id of the company'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
client_id: client_id:
description: 'The hashed id of the client' description: 'The hashed id of the client'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
first_name: first_name:
description: 'The first name of the contact' description: 'The first name of the contact'
type: string type: string
@ -17978,26 +18110,18 @@ components:
description: 'The terms of service which the contact has accpeted' description: 'The terms of service which the contact has accpeted'
type: string type: string
example: 'A long set of ToS' example: 'A long set of ToS'
readOnly: true
password: password:
description: 'The hashed password of the contact' description: 'The hashed password of the contact'
type: string type: string
example: '*****' example: '*****'
confirmation_code: confirmation-code:
description: 'The confirmation code used to authenticate the contacts email address' description: 'The confirmation code used to authenticate the contacts email address'
type: string type: string
example: 333-sdjkh34gbasd example: 333-sdjkh34gbasd
readOnly: true
token: token:
description: 'A uuid based token.' description: 'A uuid based token.'
type: string type: string
example: 333-sdjkh34gbasd example: 333-sdjkh34gbasd
readOnly: true
contact_key:
description: 'A unique identifier for the contact'
type: string
example: JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a
readOnly: true
is_primary: is_primary:
description: 'Defines is this contact is the primary contact for the client' description: 'Defines is this contact is the primary contact for the client'
type: boolean type: boolean
@ -18019,37 +18143,31 @@ components:
type: number type: number
format: integer format: integer
example: '3' example: '3'
readOnly: true
email_verified_at: email_verified_at:
description: 'The date which the contact confirmed their email' description: 'The date which the contact confirmed their email'
type: number type: number
format: integer format: integer
example: '134341234234' example: '134341234234'
readOnly: true
last_login: last_login:
description: Timestamp description: Timestamp
type: number type: number
format: integer format: integer
example: '134341234234' example: '134341234234'
readOnly: true
created_at: created_at:
description: Timestamp description: Timestamp
type: number type: number
format: integer format: integer
example: '134341234234' example: '134341234234'
readOnly: true
updated_at: updated_at:
description: Timestamp description: Timestamp
type: number type: number
format: integer format: integer
example: '134341234234' example: '134341234234'
readOnly: true
deleted_at: deleted_at:
description: Timestamp description: Timestamp
type: number type: number
format: integer format: integer
example: '134341234234' example: '134341234234'
readOnly: true
type: object type: object
ClientContactRequest: ClientContactRequest:
properties: properties:
@ -18110,17 +18228,14 @@ components:
description: 'The hashed id of the user id' description: 'The hashed id of the user id'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
company_id: company_id:
description: 'The hashed id of the company' description: 'The hashed id of the company'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
vendor_id: vendor_id:
description: 'The hashed id of the vendor' description: 'The hashed id of the vendor'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
readOnly: true
first_name: first_name:
description: 'The first name of the contact' description: 'The first name of the contact'
type: string type: string
@ -18129,16 +18244,6 @@ components:
description: 'The last name of the contact' description: 'The last name of the contact'
type: string type: string
example: Windsor example: Windsor
contact_key:
description: 'A unique identifier for the contact'
type: string
example: JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a
readOnly: true
confirmation_code:
description: 'The confirmation code used to authenticate the contacts email address'
type: string
example: 333-sdjkh34gbasd
readOnly: true
phone: phone:
description: 'The contacts phone number' description: 'The contacts phone number'
type: string type: string
@ -18163,16 +18268,6 @@ components:
description: 'The contact email address' description: 'The contact email address'
type: string type: string
example: harry@windsor.com example: harry@windsor.com
email_verified_at:
description: 'The date which the contact confirmed their email'
type: number
format: integer
example: '134341234234'
readOnly: true
password:
description: 'The hashed password of the contact'
type: string
example: '*****'
is_primary: is_primary:
description: 'Boolean flag determining if the contact is the primary contact for the vendor' description: 'Boolean flag determining if the contact is the primary contact for the vendor'
type: boolean type: boolean
@ -19504,6 +19599,10 @@ components:
description: 'The hashed id of the company. This is a unique identifier for the company.' description: 'The hashed id of the company. This is a unique identifier for the company.'
type: string type: string
example: Opnel5aKBz example: Opnel5aKBz
client_id:
description: 'The hashed id of the client. This is a unique identifier for the client.'
type: string
example: Opnel5aKBz
contacts: contacts:
type: array type: array
items: items:
@ -19633,6 +19732,8 @@ components:
type: string type: string
example: 'Bob the vendor' example: 'Bob the vendor'
readOnly: true readOnly: true
settings:
$ref: '#/components/schemas/CompanySettings'
type: object type: object
ClientSettings: ClientSettings:
required: required:

76
openapi/paths.yaml
View File

@ -1865,7 +1865,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}/upload": "/api/v1/companies/{id}/upload":
put: post:
tags: tags:
- companies - companies
summary: "Uploads a document to a company" summary: "Uploads a document to a company"
@ -1883,6 +1883,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the client object" description: "Returns the client object"
@ -3405,7 +3422,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/expenses/{id}/upload": "/api/v1/expenses/{id}/upload":
put: post:
tags: tags:
- expense - expense
summary: "Uploads a document to a expense" summary: "Uploads a document to a expense"
@ -3423,6 +3440,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Expense object" description: "Returns the Expense object"
@ -3777,7 +3811,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/group_settings/{id}/upload": "/api/v1/group_settings/{id}/upload":
put: post:
tags: tags:
- group_settings - group_settings
summary: "Uploads a document to a group setting" summary: "Uploads a document to a group setting"
@ -3795,6 +3829,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Group Setting object" description: "Returns the Group Setting object"
@ -4902,7 +4953,7 @@ paths:
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/recurring_expenses/{id}/upload": "/api/v1/recurring_expenses/{id}/upload":
put: post:
tags: tags:
- recurring_expense - recurring_expense
summary: "Uploads a document to a recurring_expense" summary: "Uploads a document to a recurring_expense"
@ -4920,6 +4971,23 @@ paths:
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the RecurringExpense object" description: "Returns the RecurringExpense object"

2
openapi/paths/clients.yaml
View File

@ -438,7 +438,7 @@
default: default:
$ref: '#/components/responses/default' $ref: '#/components/responses/default'
'/api/v1/clients/{id}/upload': '/api/v1/clients/{id}/upload':
put: post:
tags: tags:
- clients - clients
summary: 'Add client document' summary: 'Add client document'

19
openapi/paths/credits.yaml
View File

@ -385,7 +385,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/credits/{id}/upload": "/api/v1/credits/{id}/upload":
put: post:
tags: tags:
- credits - credits
summary: "Upload a credit document" summary: "Upload a credit document"
@ -403,6 +403,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Credit object" description: "Returns the Credit object"

19
openapi/paths/payments.yaml
View File

@ -482,7 +482,7 @@
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/payments/{id}/upload": "/api/v1/payments/{id}/upload":
put: post:
tags: tags:
- payments - payments
summary: "Upload a payment document" summary: "Upload a payment document"
@ -500,6 +500,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Payment object" description: "Returns the Payment object"

2
openapi/paths/products.yaml
View File

@ -382,7 +382,7 @@
$ref: '#/components/responses/default' $ref: '#/components/responses/default'
"/api/v1/products/{id}/upload": "/api/v1/products/{id}/upload":
put: post:
tags: tags:
- products - products
summary: "Add product document" summary: "Add product document"

19
openapi/paths/projects.yaml
View File

@ -340,7 +340,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/projects/{id}/upload": "/api/v1/projects/{id}/upload":
put: post:
tags: tags:
- projects - projects
summary: "Uploads a project document" summary: "Uploads a project document"
@ -358,6 +358,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Project object" description: "Returns the Project object"

19
openapi/paths/purchase_orders.yaml
View File

@ -392,7 +392,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/purchase_orders/{id}/upload": "/api/v1/purchase_orders/{id}/upload":
put: post:
tags: tags:
- Purchase Orders - Purchase Orders
summary: "Uploads a purchase order document" summary: "Uploads a purchase order document"
@ -410,6 +410,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Purchase Order object" description: "Returns the Purchase Order object"

19
openapi/paths/quotes.yaml
View File

@ -483,7 +483,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/quotes/{id}/upload": "/api/v1/quotes/{id}/upload":
put: post:
tags: tags:
- quotes - quotes
summary: "Upload a quote document" summary: "Upload a quote document"
@ -501,6 +501,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Quote object" description: "Returns the Quote object"

19
openapi/paths/recurring_invoices.yaml
View File

@ -499,7 +499,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/recurring_invoices/{id}/upload": "/api/v1/recurring_invoices/{id}/upload":
put: post:
tags: tags:
- Recurring Invoices - Recurring Invoices
summary: "Add recurring invoice document" summary: "Add recurring invoice document"
@ -517,6 +517,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the RecurringInvoice object" description: "Returns the RecurringInvoice object"

19
openapi/paths/tasks.yaml
View File

@ -340,7 +340,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/tasks/{id}/upload": "/api/v1/tasks/{id}/upload":
put: post:
tags: tags:
- tasks - tasks
summary: "Uploads a task document" summary: "Uploads a task document"
@ -358,6 +358,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Task object" description: "Returns the Task object"

19
openapi/paths/vendors.yaml
View File

@ -340,7 +340,7 @@
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/vendors/{id}/upload": "/api/v1/vendors/{id}/upload":
put: post:
tags: tags:
- vendors - vendors
summary: "Uploads a vendor document" summary: "Uploads a vendor document"
@ -358,6 +358,23 @@
type: string type: string
format: string format: string
example: D2J234DFA example: D2J234DFA
requestBody:
description: "File Upload Body"
required: true
content:
multipart/form-data:
schema:
type: object
properties:
_method:
type: string
example: PUT
documents:
type: array
items:
description: "Array of binary documents for upload"
type: string
format: binary
responses: responses:
200: 200:
description: "Returns the Vendor object" description: "Returns the Vendor object"