Refactor API tags for authentication and user profile endpoints to use 'service' prefix instead of 'user'. This change improves clarity and consistency in the API structure.

pull/21891/head
ytqh 1 year ago
parent e0bd682158
commit 7fc884acdc

@ -4,7 +4,7 @@ from libs.external_api import ExternalApi
bp = Blueprint("admin_api", __name__, url_prefix="/admin/api") bp = Blueprint("admin_api", __name__, url_prefix="/admin/api")
api = ExternalApi(bp) api = ExternalApi(bp)
# from .settings import settings
from .auth import login from .auth import login
from .settings import settings
from .stats import stats from .stats import stats
from .students import conversation, message, students from .students import conversation, message, students

@ -27,7 +27,7 @@ class LogoutApi(Resource):
"""Logout user. """Logout user.
--- ---
tags: tags:
- user/auth - service/auth
summary: Logout User summary: Logout User
description: Logs out the authenticated user and invalidates the session description: Logs out the authenticated user and invalidates the session
responses: responses:
@ -55,7 +55,7 @@ class EmailCodeLoginSendEmailApi(Resource):
"""Send email code for login. """Send email code for login.
--- ---
tags: tags:
- user/auth - service/auth
summary: Email Code Login Email Sending summary: Email Code Login Email Sending
description: Sends an email with a verification code for login description: Sends an email with a verification code for login
parameters: parameters:
@ -123,7 +123,7 @@ class EmailCodeLoginApi(Resource):
"""Login using email code. """Login using email code.
--- ---
tags: tags:
- user/auth - service/auth
summary: Email Code Login summary: Email Code Login
description: Allows the user to login using a verification code and token sent via email description: Allows the user to login using a verification code and token sent via email
parameters: parameters:
@ -237,7 +237,7 @@ class RefreshTokenApi(Resource):
"""Refresh authentication token. """Refresh authentication token.
--- ---
tags: tags:
- user/auth - service/auth
summary: Refresh Token summary: Refresh Token
description: Refreshes an access token using a valid refresh token description: Refreshes an access token using a valid refresh token
parameters: parameters:

@ -14,7 +14,7 @@ class UserProfile(Resource):
"""Get user profile. """Get user profile.
--- ---
tags: tags:
- user/profile - service/profile
summary: Get profile summary: Get profile
description: Get current user's profile information description: Get current user's profile information
security: security:
@ -47,7 +47,7 @@ class UserProfile(Resource):
"""Update user profile. """Update user profile.
--- ---
tags: tags:
- user/profile - service/profile
summary: Update profile summary: Update profile
description: Update user profile information description: Update user profile information
security: security:

Loading…
Cancel
Save