task-cluster/openapi.yaml at main · tachyonics/task-cluster · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
openapi: "3.1.0"
info:
  title: Task Cluster API
  version: "1.0.0"
  description: A task management API.

paths:
  /task:
    post:
      operationId: createTask
      summary: Create a task
      tags:
        - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTaskRequest"
      responses:
        "201":
          description: Task created successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TaskItem"
        "400":
          description: Invalid input.

  /task/{taskId}:
    get:
      operationId: getTask
      summary: Get a task by ID
      tags:
        - Tasks
      parameters:
        - $ref: "#/components/parameters/TaskId"
      responses:
        "200":
          description: Task found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TaskItem"
        "404":
          description: Task not found.

  /task/{taskId}/priority:
    patch:
      operationId: updateTaskPriority
      summary: Update a task's priority
      tags:
        - Tasks
      parameters:
        - $ref: "#/components/parameters/TaskId"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTaskPriorityRequest"
      responses:
        "200":
          description: Priority updated successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TaskItem"
        "400":
          description: Invalid priority.
        "404":
          description: Task not found.

  /task/{taskId}/cancel:
    post:
      operationId: cancelTask
      summary: Cancel a task
      tags:
        - Tasks
      parameters:
        - $ref: "#/components/parameters/TaskId"
      responses:
        "200":
          description: Task cancelled successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TaskItem"
        "404":
          description: Task not found.
        "409":
          description: Task cannot be cancelled.

components:
  parameters:
    TaskId:
      name: taskId
      in: path
      required: true
      schema:
        type: string
        format: uuid

  schemas:
    TaskStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - cancelled

    CreateTaskRequest:
      type: object
      required:
        - title
        - priority
      properties:
        title:
          type: string
        description:
          type: string
        priority:
          type: integer
        dueBy:
          type: string
          format: date-time

    UpdateTaskPriorityRequest:
      type: object
      required:
        - priority
      properties:
        priority:
          type: integer

    TaskItem:
      type: object
      required:
        - taskId
        - title
        - priority
        - status
        - createdAt
        - updatedAt
      properties:
        taskId:
          type: string
          format: uuid
        title:
          type: string
        description:
          type: string
        priority:
          type: integer
        dueBy:
          type: string
          format: date-time
        status:
          $ref: "#/components/schemas/TaskStatus"
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time