Skip to content

Commit 5423beb

Browse files
committed
Update projects yaml
Add getTask by ID and return a single task Add missing "description" property from Task model
1 parent 034df6c commit 5423beb

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

projects-yaml/Xero-projects.yaml

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,65 @@ paths:
578578
/projects/{projectId}/tasks/{taskId}:
579579
parameters:
580580
- $ref: '#/components/parameters/requiredHeader'
581+
get:
582+
security:
583+
- OAuth2: [projects, projects.read]
584+
tags:
585+
- Projects
586+
summary: Allows you to retrieve a single project
587+
operationId: getTask
588+
description: Allows you to retrieve a specific project
589+
parameters:
590+
- name: projectId
591+
in: path
592+
required: true
593+
description: You can specify an individual project by appending the projectId to the endpoint
594+
schema:
595+
type: string
596+
format: uuid
597+
- name: taskId
598+
in: path
599+
required: true
600+
description: "You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId}"
601+
schema:
602+
type: string
603+
format: uuid
604+
responses:
605+
'200':
606+
description: OK/success, returns a list of task objects
607+
content:
608+
application/json:
609+
schema:
610+
$ref: '#/components/schemas/Task'
611+
example: '{
612+
"name": "Demolition",
613+
"rate": {
614+
"currency": "AUD",
615+
"value": 20
616+
},
617+
"chargeType": "TIME",
618+
"status": "ACTIVE",
619+
"estimateMinutes": 12000,
620+
"taskId": "7be77337-feec-4458-bb1b-dbaa5a4aafce",
621+
"projectId": "b021e7cb-1903-4292-b48b-5b27b4271e3e",
622+
"totalMinutes": 300,
623+
"totalAmount": {
624+
"currency": "AUD",
625+
"value": 100
626+
},
627+
"minutesToBeInvoiced": 300,
628+
"minutesInvoiced": 0,
629+
"nonChargeableMinutes": 0,
630+
"fixedMinutes": 0,
631+
"amountToBeInvoiced": {
632+
"currency": "AUD",
633+
"value": 100
634+
},
635+
"amountInvoiced": {
636+
"currency": "AUD",
637+
"value": 0
638+
}
639+
}'
581640
# put:
582641
# security:
583642
# - OAuth2: [projects, projects.read]
@@ -1440,7 +1499,10 @@ components:
14401499
description: The date time that time entry is created. UTC Date Time in ISO-8601 format. By default it is set to server time.
14411500
duration:
14421501
type: integer
1443-
description: The duration of logged minutes. description A description of the time entry.
1502+
description: The duration of logged minutes.
1503+
description:
1504+
type: string
1505+
description: A description of the time entry.
14441506
status:
14451507
type: string
14461508
enum:

0 commit comments

Comments
 (0)