work-clock-api/swagger.yaml at master · Amitonhub/work-clock-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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
openapi: 3.0.0
info:
  title: Work Clock API
  version: 1.0.0
  description: Attendance Application Using QR Code
  contact:
    name: Amit & Karun
servers:
  - url: http://localhost:5000
  - url: https://work-clock-api.onrender.com
paths:
  /api/users/register:
    post:
      summary: Register a new user
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                # Define your request body properties here
      responses:
        '200':
          description: User registered successfully
        '400':
          description: Bad request
  /api/users/login:
    post:
      summary: Login as a user
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                # Define your request body properties here
      responses:
        '200':
          description: User logged in successfully
        '401':
          description: Unauthorized
  /api/users/current:
    get:
      summary: Get current user details
      tags:
        - Users
      security:
        - bearerAuth: []
      responses:
        '200':
          description: Current user details retrieved successfully
        '401':
          description: Unauthorized
  /api/users/auth:
    get:
      summary: Check user authentication status
      tags:
        - Users
      responses:
        '200':
          description: User is authenticated
        '401':
          description: Unauthorized
  /api/users/logout:
    get:
      summary: Logout user
      tags:
        - Users
      security:
        - bearerAuth: []
      responses:
        '200':
          description: User logged out successfully
        '401':
          description: Unauthorized
  /api/attendance:
    post:
      summary: Record attendance
      tags:
        - Attendance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                punchType:
                  type: string
      responses:
        '200':
          description: Attendance recorded successfully
        '400':
          description: Bad request

  /api/attendance/:user_id/:date:
    get:
      summary: Get attendance for a user on a specific date
      tags:
        - Attendance
      parameters:
        - name: user_id
          in: path
          required: true
          description: User ID
          schema:
            type: string
        - name: date
          in: path
          required: true
          description: Date (e.g., YYYY-MM-DD)
          schema:
            type: string
      responses:
        '200':
          description: Attendance retrieved successfully
        '401':
          description: Unauthorized

  /api/attendance/period-attendance:
    get:
      summary: Get period attendance
      tags:
        - Attendance
      responses:
        '200':
          description: Period attendance retrieved successfully
        '401':
          description: Unauthorized

  /api/attendance/:user_id:
    get:
      summary: Get all attendance records for a user
      tags:
        - Attendance
      parameters:
        - name: user_id
          in: path
          required: true
          description: User ID
          schema:
            type: string
      responses:
        '200':
          description: Attendance records retrieved successfully
        '401':
          description: Unauthorized

  /api/attendance/qr:
    post:
      summary: Generate QR code for attendance
      tags:
        - Attendance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                # Define your request body properties here
      responses:
        '200':
          description: QR code generated successfully
        '400':
          description: Bad request

  /api/notifications/create:
    post:
      summary: Create a notification
      tags:
        - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                # Define your request body properties here
      responses:
        '200':
          description: Notification created successfully
        '400':
          description: Bad request

  /api/notifications/getall:
    get:
      summary: Get all notifications
      tags:
        - Notifications
      responses:
        '200':
          description: Notifications retrieved successfully
        '401':
          description: Unauthorized

  /api/notifications/updateStarredStatus:
    put:
      summary: Update starred status of a notification
      tags:
        - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                # Define your request body properties here
      responses:
        '200':
          description: Starred status updated successfully
        '400':
          description: Bad request

# ... (other paths and definitions as needed)