task-list-backend/openapi.yaml at master · aricionur/task-list-backend · 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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
openapi: 3.0.0
info:
  title: Task Management API
  version: 1.0.0
  description: A simple CRUD API for managing tasks

servers:
  - url: http://localhost:3000/{basePath}
    description: Development server
    variables:
      basePath:
        default: v1

paths:
  /:
    get:
      summary: Get API version
      description: Returns the current API version.
      responses:
        "200":
          description: A JSON object with the API version.
          content:
            application/json:
              schema:
                type: object
                properties:
                  apiVersion:
                    type: string
                    example: v1

  /task:
    get:
      summary: Retrieve all tasks
      description: Retrieves a list of all tasks in the database.
      responses:
        "200":
          description: A list of tasks.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
    post:
      summary: Create a new task
      description: Creates a new task with a title and a description.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTaskRequest"
      responses:
        "201":
          description: The created task.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
        "400":
          description: Invalid input.

  /task/{id}:
    get:
      summary: Retrieve a single task by ID
      description: Retrieves a single task based on its unique ID.
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the task to retrieve.
          schema:
            type: integer
      responses:
        "200":
          description: The requested task.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
        "404":
          description: Task not found.
    put:
      summary: Update an existing task
      description: Updates the title, description, or status of an existing task.
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the task to update.
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTaskRequest"
      responses:
        "200":
          description: The updated task.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
        "400":
          description: Invalid input.
        "404":
          description: Task not found.
    delete:
      summary: Delete a task by ID
      description: Deletes a task from the database based on its unique ID.
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the task to delete.
          schema:
            type: integer
      responses:
        "200":
          description: Confirmation message that the task was deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Task deleted successfully"
        "404":
          description: Task not found.

components:
  schemas:
    Task:
      type: object
      required:
        - title
        - status
      properties:
        title:
          type: string
          example: "Buy groceries"
        description:
          type: string
          example: "Milk, bread, and eggs."
        dueDate:
          type: string
          format: date
          example: "2025-09-01"
        status:
          $ref: "#/components/schemas/Status"
    CreateTaskRequest:
      type: object
      required:
        - title
        - status
      properties:
        title:
          type: string
          example: "Buy groceries"
        description:
          type: string
          example: "Milk, bread, and eggs."
        dueDate:
          type: string
          format: date
          example: "2025-09-01"
        status:
          $ref: "#/components/schemas/Status"
    UpdateTaskRequest:
      type: object
      properties:
        title:
          type: string
          example: "Updated task title"
        description:
          type: string
          example: "New description."
        dueDate:
          type: string
          format: date
          example: "2025-09-01"
        status:
          $ref: "#/components/schemas/Status"
    Status:
      type: string
      enum:
        - "Todo"
        - "In Progress"
        - "Done"