eXstream/auth/api-spec.yaml at main · code-by-sia/eXstream · 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
openapi: 3.0.3
info:
  title: eXstream Auth API
  version: 0.1.0
servers:
  - url: http://localhost:4001
  - url: http://localhost:8080
paths:
  /auth/register:
    post:
      summary: Register a normal user and return a JWT.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RegisterRequest"
      responses:
        "200":
          description: Registered
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthResponse"
        "409":
          description: User already exists
  /auth/login:
    post:
      summary: Authenticate a user and return a JWT.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LoginRequest"
      responses:
        "200":
          description: Authenticated
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthResponse"
        "401":
          description: Invalid credentials
  /auth/reset-password:
    post:
      summary: Reset a user's password.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ResetPasswordRequest"
      responses:
        "200":
          description: Password reset
        "404":
          description: User not found
  /auth/verify:
    get:
      summary: Verify a bearer token.
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Token identity
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProfileResponse"
        "401":
          description: Invalid token
  /auth/profile:
    get:
      summary: Return the current user profile from gateway identity headers.
      security:
        - bearerAuth: []
      parameters:
        - $ref: "#/components/parameters/XUsername"
        - $ref: "#/components/parameters/XRole"
      responses:
        "200":
          description: Profile
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProfileResponse"
        "403":
          description: Missing identity headers
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  parameters:
    XUsername:
      name: X-Username
      in: header
      schema:
        type: string
    XRole:
      name: X-Role
      in: header
      schema:
        type: string
        enum: [ADMIN, USER]
  schemas:
    RegisterRequest:
      type: object
      required: [username, password, profileName, email, avatar]
      properties:
        username:
          type: string
        password:
          type: string
        profileName:
          type: string
        email:
          type: string
          format: email
        avatar:
          type: string
          description: Emoji avatar selected by the user.
    LoginRequest:
      type: object
      required: [username, password]
      properties:
        username:
          type: string
        password:
          type: string
    ResetPasswordRequest:
      type: object
      required: [username, password]
      properties:
        username:
          type: string
        password:
          type: string
    AuthResponse:
      type: object
      properties:
        token:
          type: string
        username:
          type: string
        role:
          type: string
        profileName:
          type: string
        email:
          type: string
        avatar:
          type: string
    ProfileResponse:
      type: object
      properties:
        username:
          type: string
        role:
          type: string
        profileName:
          type: string
        email:
          type: string
        avatar:
          type: string