postgres-node-ts-crud/swagger.yaml at main · instinxt/postgres-node-ts-crud · 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
openapi: 3.0.0
info:
  title: Todo API
  description: API for managing todos
  version: 1.0.0
tags:
  - name: Todos
    description: API for managing todos
servers:
  - url: "http://localhost:5000"
paths:
  /todos:
    post:
      summary: Create a new todo
      tags: [Todos]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: "New Todo"
      responses:
        "201":
          description: Todo successfully created

    get:
      summary: Get all todos
      tags: [Todos]
      responses:
        "200":
          description: List of todos

  /todos/{id}:
    get:
      summary: Get a todo by ID
      tags: [Todos]
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the todo to retrieve
          schema:
            type: integer
      responses:
        "200":
          description: Todo found
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  title:
                    type: string
                    example: "New Todo"
                  completed:
                    type: boolean
                    example: false
        "404":
          description: Todo not found

    put:
      summary: Update a todo by ID
      tags: [Todos]
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the todo to update
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: "Updated Todo"
                completed:
                  type: boolean
                  example: true
      responses:
        "200":
          description: Todo updated successfully
        "404":
          description: Todo not found

    delete:
      summary: Delete a todo by ID
      tags: [Todos]
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the todo to delete
          schema:
            type: integer
      responses:
        "200":
          description: Todo deleted successfully
        "404":
          description: Todo not found