User/API_SPEC.yaml at main · MomentLit/User · 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
224
225
226
227
228
openapi: 3.0.3
info:
  title: "User API"
  description: "API specification for User. Error response mapping is Needs confirmation because no global exception handler is visible."
  version: "0.1.0"
servers:
  - url: "Needs confirmation"
    description: "Needs confirmation"
tags:
  - name: "Users"
  - name: "Internal Users"
paths:
  /users/signup:
    post:
      tags: ["Users"]
      summary: "Create a user"
      description: "Creates a local user account. Authentication is not required by SecurityConfig."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SignUpRequest"
      responses:
        "201":
          description: "User created."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SignUpApiResponse"
        default:
          description: "Needs confirmation"
  /users/me:
    get:
      tags: ["Users"]
      summary: "Get my profile"
      description: "Returns the authenticated user's profile. Authentication is required by SecurityConfig."
      security:
        - bearerAuth: []
      responses:
        "200":
          description: "Profile returned."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UserSearchApiResponse"
        default:
          description: "Needs confirmation"
    patch:
      tags: ["Users"]
      summary: "Update my profile"
      description: "Updates profile fields for the authenticated user. Authentication is required by SecurityConfig."
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserUpdateRequest"
      responses:
        "204":
          description: "Profile updated."
        default:
          description: "Needs confirmation"
    delete:
      tags: ["Users"]
      summary: "Delete my profile"
      description: "Soft-deletes the authenticated user. Authentication is required by SecurityConfig."
      security:
        - bearerAuth: []
      responses:
        "204":
          description: "User deleted."
        default:
          description: "Needs confirmation"
  /internal/users/authenticate:
    post:
      tags: ["Internal Users"]
      summary: "Authenticate a local user"
      description: "Authenticates by email and password. SecurityConfig permits this route; intended network boundary is Needs confirmation."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SignInRequest"
      responses:
        "200":
          description: "Authentication result returned."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UserAuthResponse"
        default:
          description: "Needs confirmation"
  /internal/users/oauth/google:
    post:
      tags: ["Internal Users"]
      summary: "Authenticate or create a Google user"
      description: "Finds or creates a Google provider user when email_verified is true. Google token verification is Needs confirmation."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserGoogleOauthRequest"
      responses:
        "200":
          description: "Authentication result returned."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UserAuthResponse"
        default:
          description: "Needs confirmation"
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        message:
          type: string
        data:
          nullable: true
    SignUpRequest:
      type: object
      required: [email, password, name]
      properties:
        email:
          type: string
          format: email
        password:
          type: string
        name:
          type: string
    UserUpdateRequest:
      type: object
      properties:
        name:
          type: string
        image_url:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        intro:
          type: string
          nullable: true
    SignInRequest:
      type: object
      properties:
        email:
          type: string
        password:
          type: string
    UserGoogleOauthRequest:
      type: object
      properties:
        provider_id:
          type: string
        email:
          type: string
        email_verified:
          type: boolean
        name:
          type: string
        image_url:
          type: string
          nullable: true
    SignUpResponse:
      type: object
      properties:
        user_id:
          type: string
    UserSearchResponse:
      type: object
      properties:
        image_url:
          type: string
          nullable: true
        email:
          type: string
        name:
          type: string
        phone:
          type: string
          nullable: true
        intro:
          type: string
          nullable: true
        role:
          type: string
          enum: [USER, ADMIN]
        created_at:
          type: string
          format: date-time
    UserAuthResponse:
      type: object
      properties:
        user_id:
          type: string
        name:
          type: string
        role:
          type: string
          enum: [USER, ADMIN]
    SignUpApiResponse:
      allOf:
        - $ref: "#/components/schemas/ApiResponse"
        - type: object
          properties:
            data:
              $ref: "#/components/schemas/SignUpResponse"
    UserSearchApiResponse:
      allOf:
        - $ref: "#/components/schemas/ApiResponse"
        - type: object
          properties:
            data:
              $ref: "#/components/schemas/UserSearchResponse"
  responses: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT