def field_to_schema(field):
title = force_text(field.label) if field.label else ''
description = force_text(field.help_text) if field.help_text else ''
if isinstance(field, serializers.ListSerializer):
child_schema = field_to_schema(field.child)
return coreschema.Array(
items=child_schema,
title=title,
description=description
)
elif isinstance(field, serializers.Serializer):
return coreschema.Object(
properties=OrderedDict([
(key, field_to_schema(value))
for key, value
in field.fields.items()
]),
title=title,
description=description
)
elif isinstance(field, serializers.ManyRelatedField):
return coreschema.Array(
items=coreschema.String(),
title=title,
description=description
)
elif isinstance(field, serializers.RelatedField):
return coreschema.String(title=title, description=description)
elif isinstance(field, serializers.MultipleChoiceField):
return coreschema.Array(
items=coreschema.Enum(enum=list(field.choices.keys())),
title=title,
description=description
)
elif isinstance(field, serializers.ChoiceField):
return coreschema.Enum(
enum=list(field.choices.keys()),
title=title,
description=description
)
elif isinstance(field, serializers.BooleanField):
return coreschema.Boolean(title=title, description=description)
elif isinstance(field, (serializers.DecimalField, serializers.FloatField)):
return coreschema.Number(title=title, description=description)
elif isinstance(field, serializers.IntegerField):
return coreschema.Integer(title=title, description=description)
if field.style.get('base_template') == 'textarea.html':
return coreschema.String(
title=title,
description=description,
format='textarea'
)
return coreschema.String(title=title, description=description)
class LoginAuthToken(APIView):
throttle_classes = ()
permission_classes = ()
authentication_classes = ()
serializer_class = AuthTokenSerializer
if coreapi is not None and coreschema is not None:
schema = ManualSchema(
fields=[
coreapi.Field(
name='username',
required=True,
location='form',
schema=coreschema.String(
title='Username',
description='Valid username for authentication',
),
),
coreapi.Field(
name='password',
required=True,
location='form',
schema=coreschema.String(
title='Password',
description='Valid password for authentication',
),
),
coreapi.Field(
name='permanent',
required=False,
location='form',
schema=coreschema.Boolean(
title='Permanent',
description='Define if login can expire',
),
),
],
encoding='application/json',
)
allowed_cookie = False
allowed_header = True
def post(self, request, *args, **kwargs):
serializer = self.serializer_class(data=request.data,
context={'request': request})
serializer.is_valid(raise_exception=True)
user = serializer.validated_data['user']
login(request._request,
user,
not serializer.validated_data.get('permanent', False),
allowed_cookie=self.allowed_cookie,
allowed_header=self.allowed_header)
return Response({'token': request._request.token.key})
def test_field_to_schema(self):
label = 'Test label'
help_text = 'This is a helpful test text'
cases = [
# tuples are ([field], [expected schema])
# TODO: Add remaining cases
(
serializers.BooleanField(label=label, help_text=help_text),
coreschema.Boolean(title=label, description=help_text)
),
(
serializers.DecimalField(1000, 1000, label=label, help_text=help_text),
coreschema.Number(title=label, description=help_text)
),
(
serializers.FloatField(label=label, help_text=help_text),
coreschema.Number(title=label, description=help_text)
),
(
serializers.IntegerField(label=label, help_text=help_text),
coreschema.Integer(title=label, description=help_text)
),
(
serializers.DateField(label=label, help_text=help_text),
coreschema.String(title=label, description=help_text, format='date')
),
(
serializers.DateTimeField(label=label, help_text=help_text),
coreschema.String(title=label, description=help_text, format='date-time')
),
(
serializers.JSONField(label=label, help_text=help_text),
coreschema.Object(title=label, description=help_text)
),
]
for case in cases:
self.assertEqual(field_to_schema(case[0]), case[1])
def field_to_schema(field):
title = force_text(field.label) if field.label else ''
description = force_text(field.help_text) if field.help_text else ''
if isinstance(field, (serializers.ListSerializer, serializers.ListField)):
child_schema = field_to_schema(field.child)
return coreschema.Array(items=child_schema,
title=title,
description=description)
elif isinstance(field, serializers.DictField):
return coreschema.Object(title=title, description=description)
elif isinstance(field, serializers.Serializer):
return coreschema.Object(properties=OrderedDict([
(key, field_to_schema(value))
for key, value in field.fields.items()
]),
title=title,
description=description)
elif isinstance(field, serializers.ManyRelatedField):
return coreschema.Array(items=coreschema.String(),
title=title,
description=description)
elif isinstance(field, serializers.PrimaryKeyRelatedField):
schema_cls = coreschema.String
model = getattr(field.queryset, 'model', None)
if model is not None:
model_field = model._meta.pk
if isinstance(model_field, models.AutoField):
schema_cls = coreschema.Integer
return schema_cls(title=title, description=description)
elif isinstance(field, serializers.RelatedField):
return coreschema.String(title=title, description=description)
elif isinstance(field, serializers.MultipleChoiceField):
return coreschema.Array(
items=coreschema.Enum(enum=list(field.choices)),
title=title,
description=description)
elif isinstance(field, serializers.ChoiceField):
return coreschema.Enum(enum=list(field.choices),
title=title,
description=description)
elif isinstance(field, serializers.BooleanField):
return coreschema.Boolean(title=title, description=description)
elif isinstance(field, (serializers.DecimalField, serializers.FloatField)):
return coreschema.Number(title=title, description=description)
elif isinstance(field, serializers.IntegerField):
return coreschema.Integer(title=title, description=description)
elif isinstance(field, serializers.DateField):
return coreschema.String(title=title,
description=description,
format='date')
elif isinstance(field, serializers.DateTimeField):
return coreschema.String(title=title,
description=description,
format='date-time')
elif isinstance(field, serializers.JSONField):
return coreschema.Object(title=title, description=description)
if field.style.get('base_template') == 'textarea.html':
return coreschema.String(title=title,
description=description,
format='textarea')
return coreschema.String(title=title, description=description)
class CreateUserAPIView(generics.CreateAPIView):
# Allow any user (authenticated or not) to access this url
permission_classes = (permissions.AllowAny, )
queryset = models.User.objects.all()
serializer_class = serializers.UserSerializer
if coreapi_schema.is_enabled():
schema = ManualSchema(
fields=[
coreapi.Field(
name="email",
required=True,
location='form',
schema=coreschema.String(
title="Email",
description="Valid email for authentication",
),
),
coreapi.Field(
name="username",
required=True,
location='form',
schema=coreschema.String(
title="Username",
description="user login",
),
),
coreapi.Field(
name="password",
required=True,
location='form',
schema=coreschema.String(
title="Password",
description="Valid password for authentication",
),
),
coreapi.Field(
name="first_name",
required=True,
location='form',
schema=coreschema.String(
title="First name",
description="user first name",
),
),
coreapi.Field(
name="last_name",
required=True,
location='form',
schema=coreschema.String(
title="Last name",
description="user last name",
),
),
coreapi.Field(
name="is_staff",
required=True,
location='form',
schema=coreschema.Boolean(
title="User status",
description="is user staff",
),
),
],
encoding="application/json",
)
