fintrack-api/docs/api/transactions/paths.yaml at main · Techave-Dev/fintrack-api · 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
paths:
  /transactions:
    post:
      tags: [Transactions]
      summary: Create transaction
      operationId: createTransaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: ../common/schemas.yaml#/components/schemas/TransactionCreate
      responses:
        "201":
          description: Transaction created
          content:
            application/json:
              schema:
                allOf:
                  - $ref: ../common/schemas.yaml#/components/schemas/ApiResponse
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          transaction:
                            $ref: ../common/schemas.yaml#/components/schemas/Transaction
        "400":
          $ref: ../common/responses.yaml#/components/responses/BadRequest
        "401":
          $ref: ../common/responses.yaml#/components/responses/Unauthorized

    get:
      tags: [Transactions]
      summary: List user transactions
      operationId: listTransactions
      parameters:
        - name: type
          in: query
          schema:
            type: string
            enum: [income, expense]
        - name: categoryId
          in: query
          schema:
            type: integer
        - name: from
          in: query
          schema:
            type: string
            format: date
        - name: to
          in: query
          schema:
            type: string
            format: date
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
      responses:
        "200":
          description: Transactions listed
          content:
            application/json:
              schema:
                allOf:
                  - $ref: ../common/schemas.yaml#/components/schemas/ApiResponse
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: ../common/schemas.yaml#/components/schemas/Transaction
                      meta:
                        $ref: ../common/schemas.yaml#/components/schemas/Pagination
        "401":
          $ref: ../common/responses.yaml#/components/responses/Unauthorized

  /transactions/{id}:
    get:
      tags: [Transactions]
      summary: Get transaction by ID
      operationId: getTransactionById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: Transaction found
          content:
            application/json:
              schema:
                allOf:
                  - $ref: ../common/schemas.yaml#/components/schemas/ApiResponse
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          transaction:
                            $ref: ../common/schemas.yaml#/components/schemas/Transaction
        "403":
          $ref: ../common/responses.yaml#/components/responses/Forbidden
        "404":
          $ref: ../common/responses.yaml#/components/responses/NotFound

    patch:
      tags: [Transactions]
      summary: Update transaction
      operationId: updateTransaction
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: ../common/schemas.yaml#/components/schemas/TransactionUpdate
      responses:
        "200":
          description: Transaction updated
          content:
            application/json:
              schema:
                allOf:
                  - $ref: ../common/schemas.yaml#/components/schemas/ApiResponse
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          transaction:
                            $ref: ../common/schemas.yaml#/components/schemas/Transaction
        "401":
          $ref: ../common/responses.yaml#/components/responses/Unauthorized
        "403":
          $ref: ../common/responses.yaml#/components/responses/Forbidden
        "404":
          $ref: ../common/responses.yaml#/components/responses/NotFound

    delete:
      tags: [Transactions]
      summary: Delete transaction
      operationId: deleteTransaction
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        "204":
          description: Transaction deleted
        "401":
          $ref: ../common/responses.yaml#/components/responses/Unauthorized
        "403":
          $ref: ../common/responses.yaml#/components/responses/Forbidden
        "404":
          $ref: ../common/responses.yaml#/components/responses/NotFound