argent_bank-app--frontend/api-docs/api-transactions.yaml at main · Kasia307584/argent_bank-app--frontend · 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
openapi: "3.0.0"
info:
  title: Bank Argent API transaction module documentation
  description: Contains transaction module API endpoints in the codebase
  version: "1.0.0"
servers:
  - url: http://localhost:3001/api/v1
paths:
  /accounts/{accountId}/transactions:
    get:
      tags:
        - Transaction Module
      summary: Account transactions API
      description: API for fetching account last month transactions
      parameters:
        - in: header
          name: Authorization
          schema:
            type: string
          description: Attach Bearer JWT token
          required: true
        - in: path
          name: accountId
          schema:
            type: integer
            minimum: 1
          description: The account ID
          required: true
        - in: query
          name: month
          schema:
            type: string
            default: current
          description: The month for which to return items
        - in: query
          name: order
          schema:
            type: string
            default: asc
          description: The order in which to return items
      responses:
        "200":
          description: Account transactions retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionsResponse"
        "400":
          description: Invalid Fields
        "500":
          description: Internal Server Error
  /accounts/{accountId}/transactions/{transactionId}:
    get:
      tags:
        - Transaction Module
      summary: Transaction details API
      description: API for fetching details of a transaction
      parameters:
        - in: header
          name: Authorization
          schema:
            type: string
          description: Attach Bearer JWT token
          required: true
        - in: path
          name: accountId
          schema:
            type: integer
            minimum: 1
          description: The account ID
          required: true
        - in: path
          name: transactionId
          schema:
            type: integer
            minimum: 1
          description: The transaction ID
          required: true
      responses:
        "200":
          description: Transaction details retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DetailsResponse"
        "400":
          description: Invalid Fields
        "500":
          description: Internal Server Error
    put:
      tags:
        - Transaction Module
      summary: Transaction details API
      description: API for updating details of a transaction
      parameters:
        - in: header
          name: Authorization
          schema:
            type: string
          description: Attach Bearer JWT token
          required: true
        - in: path
          name: accountId
          schema:
            type: integer
            minimum: 1
          description: The account ID
          required: true
        - in: path
          name: transactionId
          schema:
            type: integer
            minimum: 1
          description: The transaction ID
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Detail"
        description: Update transaction details
        required: true
      responses:
        "200":
          description: Transaction details updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DetailsResponse"
        "400":
          description: Invalid Fields
        "500":
          description: Internal Server Error
components:
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
  schemas:
    Transaction:
      type: object
      properties:
        id:
          type: integer
        date:
          type: string
        description:
          type: string
        amount:
          type: integer
        balance:
          type: integer
    Detail:
      type: object
      properties:
        category:
          type: string
        notes:
          type: string
    TransactionsResponse:
      type: array
      items:
        $ref: "#/components/schemas/Transaction"
    DetailsResponse:
      $ref: "#/components/schemas/Detail"