chore(backend/api): naming improvements
This commit is contained in:
@@ -36,7 +36,7 @@ router = Router(tags=["auth"])
|
|||||||
def login(
|
def login(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
payload: LoginIn,
|
payload: LoginIn,
|
||||||
) -> tuple[int, TokenPairOut]:
|
) -> tuple[HTTPStatus, TokenPairOut]:
|
||||||
user = authenticate(
|
user = authenticate(
|
||||||
request,
|
request,
|
||||||
username=payload.username,
|
username=payload.username,
|
||||||
@@ -66,7 +66,7 @@ def login(
|
|||||||
def refresh(
|
def refresh(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
payload: TokenRefreshIn,
|
payload: TokenRefreshIn,
|
||||||
) -> tuple[int, TokenRefreshOut]:
|
) -> tuple[HTTPStatus, TokenRefreshOut]:
|
||||||
try:
|
try:
|
||||||
claims = decode_refresh_token(payload.refresh)
|
claims = decode_refresh_token(payload.refresh)
|
||||||
except TokenError:
|
except TokenError:
|
||||||
@@ -93,7 +93,7 @@ def refresh(
|
|||||||
summary="Current user profile",
|
summary="Current user profile",
|
||||||
description="Return the profile of the currently authenticated user.",
|
description="Return the profile of the currently authenticated user.",
|
||||||
)
|
)
|
||||||
def me(request: HttpRequest) -> tuple[int, MeOut]:
|
def me(request: HttpRequest) -> tuple[HTTPStatus, MeOut]:
|
||||||
user = getattr(request, "auth", None)
|
user = getattr(request, "auth", None)
|
||||||
if not isinstance(user, User):
|
if not isinstance(user, User):
|
||||||
raise AuthenticationError
|
raise AuthenticationError
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ def list_approver_groups(
|
|||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
limit: int = 50,
|
limit: int = 50,
|
||||||
offset: int = 0,
|
offset: int = 0,
|
||||||
) -> tuple[int, ApproverGroupListOut]:
|
) -> tuple[HTTPStatus, ApproverGroupListOut]:
|
||||||
qs = approver_group_list()
|
qs = approver_group_list()
|
||||||
total = qs.count()
|
total = qs.count()
|
||||||
items = [
|
items = [
|
||||||
@@ -75,7 +75,7 @@ def list_approver_groups(
|
|||||||
def create_approver_group(
|
def create_approver_group(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
payload: ApproverGroupCreateIn,
|
payload: ApproverGroupCreateIn,
|
||||||
) -> tuple[int, ApproverGroupOut]:
|
) -> tuple[HTTPStatus, ApproverGroupOut]:
|
||||||
experimenter = get_object_or_404(User, pk=payload.experimenter_id)
|
experimenter = get_object_or_404(User, pk=payload.experimenter_id)
|
||||||
|
|
||||||
group = approver_group_create(
|
group = approver_group_create(
|
||||||
@@ -102,7 +102,7 @@ def create_approver_group(
|
|||||||
def get_approver_group(
|
def get_approver_group(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
group_id: str,
|
group_id: str,
|
||||||
) -> tuple[int, ApproverGroupOut]:
|
) -> tuple[HTTPStatus, ApproverGroupOut]:
|
||||||
group = get_object_or_404(
|
group = get_object_or_404(
|
||||||
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
||||||
"approvers"
|
"approvers"
|
||||||
@@ -126,7 +126,7 @@ def update_approver_group(
|
|||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
group_id: str,
|
group_id: str,
|
||||||
payload: ApproverGroupUpdateIn,
|
payload: ApproverGroupUpdateIn,
|
||||||
) -> tuple[int, ApproverGroupOut]:
|
) -> tuple[HTTPStatus, ApproverGroupOut]:
|
||||||
group = get_object_or_404(
|
group = get_object_or_404(
|
||||||
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
||||||
"approvers"
|
"approvers"
|
||||||
@@ -161,7 +161,7 @@ def update_approver_group(
|
|||||||
def delete_approver_group(
|
def delete_approver_group(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
group_id: str,
|
group_id: str,
|
||||||
) -> tuple[int, None]:
|
) -> tuple[HTTPStatus, None]:
|
||||||
group = get_object_or_404(
|
group = get_object_or_404(
|
||||||
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
||||||
"approvers"
|
"approvers"
|
||||||
@@ -186,7 +186,7 @@ def add_approver_to_group(
|
|||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
group_id: str,
|
group_id: str,
|
||||||
payload: ApproverGroupAddApproverIn,
|
payload: ApproverGroupAddApproverIn,
|
||||||
) -> tuple[int, ApproverGroupOut]:
|
) -> tuple[HTTPStatus, ApproverGroupOut]:
|
||||||
group = get_object_or_404(
|
group = get_object_or_404(
|
||||||
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
||||||
"approvers"
|
"approvers"
|
||||||
@@ -220,7 +220,7 @@ def remove_approver_from_group(
|
|||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
group_id: str,
|
group_id: str,
|
||||||
payload: ApproverGroupRemoveApproverIn,
|
payload: ApproverGroupRemoveApproverIn,
|
||||||
) -> tuple[int, ApproverGroupOut]:
|
) -> tuple[HTTPStatus, ApproverGroupOut]:
|
||||||
group = get_object_or_404(
|
group = get_object_or_404(
|
||||||
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
ApproverGroup.objects.select_related("experimenter").prefetch_related(
|
||||||
"approvers"
|
"approvers"
|
||||||
@@ -253,7 +253,7 @@ def remove_approver_from_group(
|
|||||||
def get_approver_group_by_experimenter(
|
def get_approver_group_by_experimenter(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
experimenter_id: str,
|
experimenter_id: str,
|
||||||
) -> tuple[int, ApproverGroupOut]:
|
) -> tuple[HTTPStatus, ApproverGroupOut]:
|
||||||
group = approver_group_get_by_experimenter_id(experimenter_id)
|
group = approver_group_get_by_experimenter_id(experimenter_id)
|
||||||
if group is None:
|
if group is None:
|
||||||
raise Http404
|
raise Http404
|
||||||
@@ -272,7 +272,7 @@ def get_approver_group_by_experimenter(
|
|||||||
)
|
)
|
||||||
def get_review_settings(
|
def get_review_settings(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
) -> tuple[int, ReviewSettingsOut]:
|
) -> tuple[HTTPStatus, ReviewSettingsOut]:
|
||||||
settings = review_settings_load()
|
settings = review_settings_load()
|
||||||
return HTTPStatus.OK, ReviewSettingsOut.model_validate(settings)
|
return HTTPStatus.OK, ReviewSettingsOut.model_validate(settings)
|
||||||
|
|
||||||
@@ -290,7 +290,7 @@ def get_review_settings(
|
|||||||
def update_review_settings(
|
def update_review_settings(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
payload: ReviewSettingsUpdateIn,
|
payload: ReviewSettingsUpdateIn,
|
||||||
) -> tuple[int, ReviewSettingsOut]:
|
) -> tuple[HTTPStatus, ReviewSettingsOut]:
|
||||||
settings = review_settings_update(
|
settings = review_settings_update(
|
||||||
default_min_approvals=payload.default_min_approvals,
|
default_min_approvals=payload.default_min_approvals,
|
||||||
allow_any_approver=payload.allow_any_approver,
|
allow_any_approver=payload.allow_any_approver,
|
||||||
@@ -312,7 +312,7 @@ def update_review_settings(
|
|||||||
def get_effective_policy(
|
def get_effective_policy(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
experimenter_id: str,
|
experimenter_id: str,
|
||||||
) -> tuple[int, EffectiveReviewPolicyOut]:
|
) -> tuple[HTTPStatus, EffectiveReviewPolicyOut]:
|
||||||
experimenter = get_object_or_404(User, pk=experimenter_id)
|
experimenter = get_object_or_404(User, pk=experimenter_id)
|
||||||
|
|
||||||
if experimenter.role != UserRole.EXPERIMENTER:
|
if experimenter.role != UserRole.EXPERIMENTER:
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ def list_users(
|
|||||||
search: str | None = None,
|
search: str | None = None,
|
||||||
limit: int = 50,
|
limit: int = 50,
|
||||||
offset: int = 0,
|
offset: int = 0,
|
||||||
) -> tuple[int, UserListOut]:
|
) -> tuple[HTTPStatus, UserListOut]:
|
||||||
qs = user_list(role=role, is_active=is_active, search=search)
|
qs = user_list(role=role, is_active=is_active, search=search)
|
||||||
total = qs.count()
|
total = qs.count()
|
||||||
items = [
|
items = [
|
||||||
@@ -65,7 +65,7 @@ def list_users(
|
|||||||
def create_user(
|
def create_user(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
payload: UserCreateIn,
|
payload: UserCreateIn,
|
||||||
) -> tuple[int, UserOut]:
|
) -> tuple[HTTPStatus, UserOut]:
|
||||||
valid_roles = {choice[0] for choice in UserRole.choices}
|
valid_roles = {choice[0] for choice in UserRole.choices}
|
||||||
if payload.role not in valid_roles:
|
if payload.role not in valid_roles:
|
||||||
raise ValidationError(
|
raise ValidationError(
|
||||||
@@ -100,7 +100,7 @@ def create_user(
|
|||||||
def get_user(
|
def get_user(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
user_id: str,
|
user_id: str,
|
||||||
) -> tuple[int, UserOut]:
|
) -> tuple[HTTPStatus, UserOut]:
|
||||||
user = get_object_or_404(User, pk=user_id)
|
user = get_object_or_404(User, pk=user_id)
|
||||||
return HTTPStatus.OK, UserOut.model_validate(user)
|
return HTTPStatus.OK, UserOut.model_validate(user)
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ def update_user(
|
|||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
user_id: str,
|
user_id: str,
|
||||||
payload: UserUpdateIn,
|
payload: UserUpdateIn,
|
||||||
) -> tuple[int, UserOut]:
|
) -> tuple[HTTPStatus, UserOut]:
|
||||||
user = get_object_or_404(User, pk=user_id)
|
user = get_object_or_404(User, pk=user_id)
|
||||||
|
|
||||||
if payload.role is not None:
|
if payload.role is not None:
|
||||||
@@ -159,7 +159,7 @@ def update_user(
|
|||||||
def delete_user(
|
def delete_user(
|
||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
user_id: str,
|
user_id: str,
|
||||||
) -> tuple[int, None]:
|
) -> tuple[HTTPStatus, None]:
|
||||||
user = get_object_or_404(User, pk=user_id)
|
user = get_object_or_404(User, pk=user_id)
|
||||||
|
|
||||||
current_user = getattr(request, "auth", None)
|
current_user = getattr(request, "auth", None)
|
||||||
@@ -185,7 +185,7 @@ def assign_role(
|
|||||||
request: HttpRequest,
|
request: HttpRequest,
|
||||||
user_id: str,
|
user_id: str,
|
||||||
payload: UserRoleAssignIn,
|
payload: UserRoleAssignIn,
|
||||||
) -> tuple[int, UserOut]:
|
) -> tuple[HTTPStatus, UserOut]:
|
||||||
user = get_object_or_404(User, pk=user_id)
|
user = get_object_or_404(User, pk=user_id)
|
||||||
|
|
||||||
updated_user = user_assign_role(user=user, role=payload.role)
|
updated_user = user_assign_role(user=user, role=payload.role)
|
||||||
|
|||||||
Reference in New Issue
Block a user