Skip to content

docs: document user list query parameters #6385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liuruibin merged 1 commit into from
Jul 10, 2026
+20 −24
Merged

docs: document user list query parameters #6385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions apps/users/api/user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,22 @@ def get_parameters():
class WorkspaceUserAPI(APIMixin):
@staticmethod
def get_parameters():
return [OpenApiParameter(
name="workspace_id",
description=_('Workspace ID'),
type=OpenApiTypes.STR,
location=OpenApiParameter.PATH,
required=True,
)]
return [
OpenApiParameter(
name="workspace_id",
description=_('Workspace ID'),
type=OpenApiTypes.STR,
location=OpenApiParameter.PATH,
required=True,
),
OpenApiParameter(
name="nick_name",
description=_('Nick name'),
type=OpenApiTypes.STR,
location=OpenApiParameter.QUERY,
required=False,
)
]

@staticmethod
def get_response():
Expand Down Expand Up @@ -165,16 +174,10 @@ def get_response():
class UserListApi(APIMixin):
@staticmethod
def get_parameters():
return [OpenApiParameter(
name="workspace_id",
description=_('Workspace ID'),
type=OpenApiTypes.STR,
location=OpenApiParameter.PATH,
required=False,
),
return [
OpenApiParameter(
name="nick_name",
description=_('Nickname'),
description=_('Nick name'),
type=OpenApiTypes.STR,
location=OpenApiParameter.QUERY,
required=False,
Expand Down
11 changes: 2 additions & 9 deletions apps/users/views/user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
from django.core.cache import cache
from django.db.models import QuerySet
from django.utils.translation import gettext_lazy as _
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema, OpenApiParameter
from drf_spectacular.utils import extend_schema
from rest_framework.request import Request
from rest_framework.views import APIView

Expand Down Expand Up @@ -131,13 +130,7 @@ class UserList(APIView):
description=_("Get all user"),
operation_id=_("Get all user"), # type: ignore
tags=[_("User Management")], # type: ignore
parameters=[OpenApiParameter(
name="nick_name",
description=_('Nickname'),
type=OpenApiTypes.STR,
location=OpenApiParameter.QUERY, # type: ignore
required=False,
)],
parameters=UserListApi.get_parameters(),
responses=UserListApi.get_response())
@has_permissions(RoleConstants.WORKSPACE_MANAGE, RoleConstants.ADMIN, RoleConstants.EXTENDS_ADMIN,
RoleConstants.EXTENDS_WORKSPACE_MANAGE, RoleConstants.USER, RoleConstants.EXTENDS_USER)
Expand Down
Loading