cardosofelipe/eventspace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add operation_id to all API route handlers

Browse Source 
This commit adds the `operation_id` parameter to all relevant API endpoints in the `auth` routes. These identifiers enhance API documentation and make routes easier to distinguish in tools like Swagger or OpenAPI. No functionality is altered, but these additions improve clarity and maintainability.
This commit is contained in:
Felipe Cardoso
2025-03-05 09:16:27 +01:00
parent 4f06c95eda
commit b019511a1f
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
backend/app/api/routes/auth.py
View File

@@ -23,7 +23,7 @@ router = APIRouter()
logger = logging.getLogger(__name__)
@router.post("/register", response_model=UserResponse, status_code=status.HTTP_201_CREATED)
@router.post("/register", response_model=UserResponse, status_code=status.HTTP_201_CREATED, operation_id="register")
async def register_user(
user_data: UserCreate,
db: Session = Depends(get_db)
@@ -51,7 +51,7 @@ async def register_user(
)
@router.post("/login", response_model=Token)
@router.post("/login", response_model=Token, operation_id="login")
async def login(
login_data: LoginRequest,
db: Session = Depends(get_db)
@@ -100,7 +100,7 @@ async def login(
)
@router.post("/login/oauth", response_model=Token)
@router.post("/login/oauth", response_model=Token, operation_id='login_oauth')
async def login_oauth(
form_data: OAuth2PasswordRequestForm = Depends(),
db: Session = Depends(get_db)
@@ -147,7 +147,7 @@ async def login_oauth(
)
@router.post("/refresh", response_model=Token)
@router.post("/refresh", response_model=Token, operation_id="refresh_token")
async def refresh_token(
refresh_data: RefreshTokenRequest,
db: Session = Depends(get_db)
@@ -183,7 +183,7 @@ async def refresh_token(
)
@router.post("/change-password", status_code=status.HTTP_200_OK)
@router.post("/change-password", status_code=status.HTTP_200_OK, operation_id="change_password")
async def change_password(
current_password: str = Body(..., embed=True),
new_password: str = Body(..., embed=True),
@@ -219,7 +219,7 @@ async def change_password(
)
@router.get("/me", response_model=UserResponse)
@router.get("/me", response_model=UserResponse, operation_id="get_current_user_info")
async def get_current_user_info(
current_user: User = Depends(get_current_user)
) -> Any: