diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index de413165d1f4..64e2c1e26127 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -40,14 +40,9 @@ paths: - $ref: '#/components/parameters/index' - - name: rows - in: query - description: 'The number of activities to return' - required: false - schema: - type: number - format: integer - example: '50' + $ref: '#/components/parameters/per_page_meta' + - + $ref: '#/components/parameters/page_meta' responses: 200: description: 'A list of actvities' @@ -14955,6 +14950,22 @@ components: description: 'The IP Address of the user who performed the action' type: string example: 192.168.1.252 + user: + $ref: '#/components/schemas/User' + client: + $ref: '#/components/schemas/Client' + contact: + $ref: '#/components/schemas/Contact' + recurring_invoice: + $ref: '#/components/schemas/RecurringInvoice' + invoice: + $ref: '#/components/schemas/Invoice' + credit: + $ref: '#/components/schemas/Credit' + quote: + $ref: '#/components/schemas/Quote' + + type: object BTRules: properties: @@ -18934,7 +18945,7 @@ components: type: string example: supersecretpassword activity_include: - name: activity_include + name: include in: query description: Include child relations of the Activity object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token required: false @@ -18981,7 +18992,7 @@ components: value: task summary: include=task will include the task object in the response login_include: - name: login_include + name: include in: query description: Include child relations of the CompanyUser object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token required: false @@ -19000,6 +19011,22 @@ components: account: value: account summary: include=account will include the account object in the response + per_page_meta: + name: per_page + in: query + description: The number of records to return for each request, default is 20 + required: false + schema: + type: int + example: 20 + page_meta: + name: page + in: query + description: The page number to return for this request (when performing pagination), default is 1 + required: false + schema: + type: int + example: 1 include: name: include in: query diff --git a/openapi/components/components.yaml b/openapi/components/components.yaml index 60dc1cd27893..ca70c4905e25 100644 --- a/openapi/components/components.yaml +++ b/openapi/components/components.yaml @@ -73,6 +73,32 @@ components: description: 'The IP Address of the user who performed the action' type: string example: 192.168.1.252 + user: + $ref: '#/components/schemas/User' + client: + $ref: '#/components/schemas/Client' + contact: + $ref: '#/components/schemas/Contact' + recurring_invoice: + $ref: '#/components/schemas/RecurringInvoice' + invoice: + $ref: '#/components/schemas/Invoice' + credit: + $ref: '#/components/schemas/Credit' + quote: + $ref: '#/components/schemas/Quote' + payment: + $ref: '#/components/schemas/Payment' + expense: + $ref: '#/components/schemas/Expense' + task: + $ref: '#/components/schemas/Task' + purchase_order: + $ref: '#/components/schemas/PurchaseOrder' + vendor: + $ref: '#/components/schemas/Vendor' + vendor_contact: + $ref: '#/components/schemas/VendorContact' type: object BTRules: properties: @@ -4052,7 +4078,7 @@ components: type: string example: supersecretpassword activity_include: - name: activity_include + name: include in: query description: Include child relations of the Activity object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token required: false @@ -4099,7 +4125,7 @@ components: value: task summary: include=task will include the task object in the response login_include: - name: login_include + name: include in: query description: Include child relations of the CompanyUser object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token required: false @@ -4118,6 +4144,22 @@ components: account: value: account summary: include=account will include the account object in the response + per_page_meta: + name: per_page + in: query + description: The number of records to return for each request, default is 20 + required: false + schema: + type: int + example: 20 + page_meta: + name: page + in: query + description: The page number to return for this request (when performing pagination), default is 1 + required: false + schema: + type: int + example: 1 include: name: include in: query diff --git a/openapi/paths/paths.yaml b/openapi/paths/paths.yaml index 2c9b69b37ba3..331f98150e39 100644 --- a/openapi/paths/paths.yaml +++ b/openapi/paths/paths.yaml @@ -16,14 +16,9 @@ paths: - $ref: '#/components/parameters/index' - - name: rows - in: query - description: 'The number of activities to return' - required: false - schema: - type: number - format: integer - example: '50' + $ref: '#/components/parameters/per_page_meta' + - + $ref: '#/components/parameters/page_meta' responses: 200: description: 'A list of actvities'