Skip to content

Commit 51d2b24

Browse files
authored
Added write_only=True for better doc generation (#699)
* Added write_only=True for better doc generation Auto doc generators can perform better and generate more accurate docs by having this argument. Username field in TokenObtainSerializer and token in TokenVerifySerializer has been changed. * Added write_only=True to TokenBlacklistSerializer's refresh field
1 parent 605cec4 commit 51d2b24

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

rest_framework_simplejwt/serializers.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class TokenObtainSerializer(serializers.Serializer):
3838
def __init__(self, *args, **kwargs) -> None:
3939
super().__init__(*args, **kwargs)
4040

41-
self.fields[self.username_field] = serializers.CharField()
41+
self.fields[self.username_field] = serializers.CharField(write_only=True)
4242
self.fields["password"] = PasswordField()
4343

4444
def validate(self, attrs: Dict[str, Any]) -> Dict[Any, Any]:
@@ -147,7 +147,7 @@ def validate(self, attrs: Dict[str, Any]) -> Dict[str, str]:
147147

148148

149149
class TokenVerifySerializer(serializers.Serializer):
150-
token = serializers.CharField()
150+
token = serializers.CharField(write_only=True)
151151

152152
def validate(self, attrs: Dict[str, None]) -> Dict[Any, Any]:
153153
token = UntypedToken(attrs["token"])
@@ -164,7 +164,7 @@ def validate(self, attrs: Dict[str, None]) -> Dict[Any, Any]:
164164

165165

166166
class TokenBlacklistSerializer(serializers.Serializer):
167-
refresh = serializers.CharField()
167+
refresh = serializers.CharField(write_only=True)
168168
token_class = RefreshToken
169169

170170
def validate(self, attrs: Dict[str, Any]) -> Dict[Any, Any]:

0 commit comments

Comments
 (0)