budgetBuddy/swaggerProd.yaml at main · nihalerdal/budgetBuddy · 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
openapi: 3.0.0
info:
  title: BudgetBuddy API
  version: "1.0.0"
  description: API documentation for BudgetBuddy app

servers:
  - url: http://localhost:3000/api/v1
    description: Local Development
  - url: https://expense-tracker-gjuu.onrender.com/api-docs
    description: Production

paths:
  /auth/register:
    post:
      summary: Register a new user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - username
                - password
              properties:
                username:
                  type: string
                password:
                  type: string
      responses:
        201:
          description: User registered successfully
        400:
          description: Bad request

  /auth/login:
    post:
      summary: Login a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - username
                - password
              properties:
                username:
                  type: string
                password:
                  type: string
      responses:
        200:
          description: Successful login
        401:
          description: Unauthorized

  /expenses:
    get:
      summary: Get all expenses
      responses:
        200:
          description: List of expenses
    post:
      summary: Create a new expense
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
               required:
                - title
                - amount
                - mainCategory
                - subCategory
                - date
               properties:
                title:
                  type: string
                amount:
                  type: number
                mainCategory:
                  type: string
                subCategory:
                  type: string
                date:
                  type: string
                  format: date
                description:
                  type: string
            example:
              title: "Lunch"
              amount: 12.5
              date: "2025-05-23"
              description: "Lunch with colleagues"
              mainCategory: "Food"
              subCategory: "Restaurant"
      responses:
        201:
          description: Expense created

  /expenses/{id}:
    get:
      summary: Get expense by ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        200:
          description: Expense details
        404:
          description: Expense not found
    delete:
      summary: Delete expense by ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        204:
          description: Expense deleted
    patch:
      summary: Update expense by ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                category:
                  type: string
                date:
                  type: string
                  format: date
                description:
                  type: string
      responses:
        200:
          description: Expense updated