45bbffdf9f
We added the possibility to scan all uploaded files with an anti malware solution. Depending the backend used, we want to give the possibility to check the file mimtype to determine if this one is tagged as unsafe or not. To this you can set the environment variable DOCUMENT_ATTACHMENT_CHECK_UNSAFE_MIME_TYPES_ENABLED to False. The default value is True.
739 lines
24 KiB
Python
739 lines
24 KiB
Python
"""Client serializers for the impress core app."""
|
|
|
|
import binascii
|
|
import mimetypes
|
|
from base64 import b64decode
|
|
|
|
from django.conf import settings
|
|
from django.db.models import Q
|
|
from django.utils.functional import lazy
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
import magic
|
|
from rest_framework import exceptions, serializers
|
|
|
|
from core import enums, models, utils
|
|
from core.services.ai_services import AI_ACTIONS
|
|
from core.services.converter_services import (
|
|
ConversionError,
|
|
YdocConverter,
|
|
)
|
|
|
|
|
|
class UserSerializer(serializers.ModelSerializer):
|
|
"""Serialize users."""
|
|
|
|
class Meta:
|
|
model = models.User
|
|
fields = ["id", "email", "full_name", "short_name", "language"]
|
|
read_only_fields = ["id", "email", "full_name", "short_name"]
|
|
|
|
|
|
class UserLightSerializer(UserSerializer):
|
|
"""Serialize users with limited fields."""
|
|
|
|
id = serializers.SerializerMethodField(read_only=True)
|
|
email = serializers.SerializerMethodField(read_only=True)
|
|
|
|
def get_id(self, _user):
|
|
"""Return always None. Here to have the same fields than in UserSerializer."""
|
|
return None
|
|
|
|
def get_email(self, _user):
|
|
"""Return always None. Here to have the same fields than in UserSerializer."""
|
|
return None
|
|
|
|
class Meta:
|
|
model = models.User
|
|
fields = ["id", "email", "full_name", "short_name"]
|
|
read_only_fields = ["id", "email", "full_name", "short_name"]
|
|
|
|
|
|
class BaseAccessSerializer(serializers.ModelSerializer):
|
|
"""Serialize template accesses."""
|
|
|
|
abilities = serializers.SerializerMethodField(read_only=True)
|
|
|
|
def update(self, instance, validated_data):
|
|
"""Make "user" field is readonly but only on update."""
|
|
validated_data.pop("user", None)
|
|
return super().update(instance, validated_data)
|
|
|
|
def get_abilities(self, access) -> dict:
|
|
"""Return abilities of the logged-in user on the instance."""
|
|
request = self.context.get("request")
|
|
if request:
|
|
return access.get_abilities(request.user)
|
|
return {}
|
|
|
|
def validate(self, attrs):
|
|
"""
|
|
Check access rights specific to writing (create/update)
|
|
"""
|
|
request = self.context.get("request")
|
|
user = getattr(request, "user", None)
|
|
role = attrs.get("role")
|
|
|
|
# Update
|
|
if self.instance:
|
|
can_set_role_to = self.instance.get_abilities(user)["set_role_to"]
|
|
|
|
if role and role not in can_set_role_to:
|
|
message = (
|
|
f"You are only allowed to set role to {', '.join(can_set_role_to)}"
|
|
if can_set_role_to
|
|
else "You are not allowed to set this role for this template."
|
|
)
|
|
raise exceptions.PermissionDenied(message)
|
|
|
|
# Create
|
|
else:
|
|
try:
|
|
resource_id = self.context["resource_id"]
|
|
except KeyError as exc:
|
|
raise exceptions.ValidationError(
|
|
"You must set a resource ID in kwargs to create a new access."
|
|
) from exc
|
|
|
|
if not self.Meta.model.objects.filter( # pylint: disable=no-member
|
|
Q(user=user) | Q(team__in=user.teams),
|
|
role__in=[models.RoleChoices.OWNER, models.RoleChoices.ADMIN],
|
|
**{self.Meta.resource_field_name: resource_id}, # pylint: disable=no-member
|
|
).exists():
|
|
raise exceptions.PermissionDenied(
|
|
"You are not allowed to manage accesses for this resource."
|
|
)
|
|
|
|
if (
|
|
role == models.RoleChoices.OWNER
|
|
and not self.Meta.model.objects.filter( # pylint: disable=no-member
|
|
Q(user=user) | Q(team__in=user.teams),
|
|
role=models.RoleChoices.OWNER,
|
|
**{self.Meta.resource_field_name: resource_id}, # pylint: disable=no-member
|
|
).exists()
|
|
):
|
|
raise exceptions.PermissionDenied(
|
|
"Only owners of a resource can assign other users as owners."
|
|
)
|
|
|
|
# pylint: disable=no-member
|
|
attrs[f"{self.Meta.resource_field_name}_id"] = self.context["resource_id"]
|
|
return attrs
|
|
|
|
|
|
class DocumentAccessSerializer(BaseAccessSerializer):
|
|
"""Serialize document accesses."""
|
|
|
|
user_id = serializers.PrimaryKeyRelatedField(
|
|
queryset=models.User.objects.all(),
|
|
write_only=True,
|
|
source="user",
|
|
required=False,
|
|
allow_null=True,
|
|
)
|
|
user = UserSerializer(read_only=True)
|
|
|
|
class Meta:
|
|
model = models.DocumentAccess
|
|
resource_field_name = "document"
|
|
fields = ["id", "user", "user_id", "team", "role", "abilities"]
|
|
read_only_fields = ["id", "abilities"]
|
|
|
|
|
|
class DocumentAccessLightSerializer(DocumentAccessSerializer):
|
|
"""Serialize document accesses with limited fields."""
|
|
|
|
user = UserLightSerializer(read_only=True)
|
|
|
|
class Meta:
|
|
model = models.DocumentAccess
|
|
fields = ["id", "user", "team", "role", "abilities"]
|
|
read_only_fields = ["id", "team", "role", "abilities"]
|
|
|
|
|
|
class TemplateAccessSerializer(BaseAccessSerializer):
|
|
"""Serialize template accesses."""
|
|
|
|
class Meta:
|
|
model = models.TemplateAccess
|
|
resource_field_name = "template"
|
|
fields = ["id", "user", "team", "role", "abilities"]
|
|
read_only_fields = ["id", "abilities"]
|
|
|
|
|
|
class ListDocumentSerializer(serializers.ModelSerializer):
|
|
"""Serialize documents with limited fields for display in lists."""
|
|
|
|
is_favorite = serializers.BooleanField(read_only=True)
|
|
nb_accesses_ancestors = serializers.IntegerField(read_only=True)
|
|
nb_accesses_direct = serializers.IntegerField(read_only=True)
|
|
user_roles = serializers.SerializerMethodField(read_only=True)
|
|
abilities = serializers.SerializerMethodField(read_only=True)
|
|
|
|
class Meta:
|
|
model = models.Document
|
|
fields = [
|
|
"id",
|
|
"abilities",
|
|
"created_at",
|
|
"creator",
|
|
"depth",
|
|
"excerpt",
|
|
"is_favorite",
|
|
"link_role",
|
|
"link_reach",
|
|
"nb_accesses_ancestors",
|
|
"nb_accesses_direct",
|
|
"numchild",
|
|
"path",
|
|
"title",
|
|
"updated_at",
|
|
"user_roles",
|
|
]
|
|
read_only_fields = [
|
|
"id",
|
|
"abilities",
|
|
"created_at",
|
|
"creator",
|
|
"depth",
|
|
"excerpt",
|
|
"is_favorite",
|
|
"link_role",
|
|
"link_reach",
|
|
"nb_accesses_ancestors",
|
|
"nb_accesses_direct",
|
|
"numchild",
|
|
"path",
|
|
"updated_at",
|
|
"user_roles",
|
|
]
|
|
|
|
def get_abilities(self, document) -> dict:
|
|
"""Return abilities of the logged-in user on the instance."""
|
|
request = self.context.get("request")
|
|
|
|
if request:
|
|
paths_links_mapping = self.context.get("paths_links_mapping", None)
|
|
# Retrieve ancestor links from paths_links_mapping (if provided)
|
|
ancestors_links = (
|
|
paths_links_mapping.get(document.path[: -document.steplen])
|
|
if paths_links_mapping
|
|
else None
|
|
)
|
|
return document.get_abilities(request.user, ancestors_links=ancestors_links)
|
|
|
|
return {}
|
|
|
|
def get_user_roles(self, document):
|
|
"""
|
|
Return roles of the logged-in user for the current document,
|
|
taking into account ancestors.
|
|
"""
|
|
request = self.context.get("request")
|
|
if request:
|
|
return document.get_roles(request.user)
|
|
return []
|
|
|
|
|
|
class DocumentSerializer(ListDocumentSerializer):
|
|
"""Serialize documents with all fields for display in detail views."""
|
|
|
|
content = serializers.CharField(required=False)
|
|
|
|
class Meta:
|
|
model = models.Document
|
|
fields = [
|
|
"id",
|
|
"abilities",
|
|
"content",
|
|
"created_at",
|
|
"creator",
|
|
"depth",
|
|
"excerpt",
|
|
"is_favorite",
|
|
"link_role",
|
|
"link_reach",
|
|
"nb_accesses_ancestors",
|
|
"nb_accesses_direct",
|
|
"numchild",
|
|
"path",
|
|
"title",
|
|
"updated_at",
|
|
"user_roles",
|
|
]
|
|
read_only_fields = [
|
|
"id",
|
|
"abilities",
|
|
"created_at",
|
|
"creator",
|
|
"depth",
|
|
"is_favorite",
|
|
"link_role",
|
|
"link_reach",
|
|
"nb_accesses_ancestors",
|
|
"nb_accesses_direct",
|
|
"numchild",
|
|
"path",
|
|
"updated_at",
|
|
"user_roles",
|
|
]
|
|
|
|
def get_fields(self):
|
|
"""Dynamically make `id` read-only on PUT requests but writable on POST requests."""
|
|
fields = super().get_fields()
|
|
|
|
request = self.context.get("request")
|
|
if request and request.method == "POST":
|
|
fields["id"].read_only = False
|
|
|
|
return fields
|
|
|
|
def validate_id(self, value):
|
|
"""Ensure the provided ID does not already exist when creating a new document."""
|
|
request = self.context.get("request")
|
|
|
|
# Only check this on POST (creation)
|
|
if request and request.method == "POST":
|
|
if models.Document.objects.filter(id=value).exists():
|
|
raise serializers.ValidationError(
|
|
"A document with this ID already exists. You cannot override it."
|
|
)
|
|
|
|
return value
|
|
|
|
def validate_content(self, value):
|
|
"""Validate the content field."""
|
|
if not value:
|
|
return None
|
|
|
|
try:
|
|
b64decode(value, validate=True)
|
|
except binascii.Error as err:
|
|
raise serializers.ValidationError("Invalid base64 content.") from err
|
|
|
|
return value
|
|
|
|
def save(self, **kwargs):
|
|
"""
|
|
Process the content field to extract attachment keys and update the document's
|
|
"attachments" field for access control.
|
|
"""
|
|
content = self.validated_data.get("content", "")
|
|
extracted_attachments = set(utils.extract_attachments(content))
|
|
|
|
existing_attachments = (
|
|
set(self.instance.attachments or []) if self.instance else set()
|
|
)
|
|
new_attachments = extracted_attachments - existing_attachments
|
|
|
|
if new_attachments:
|
|
attachments_documents = (
|
|
models.Document.objects.filter(
|
|
attachments__overlap=list(new_attachments)
|
|
)
|
|
.only("path", "attachments")
|
|
.order_by("path")
|
|
)
|
|
|
|
user = self.context["request"].user
|
|
readable_per_se_paths = (
|
|
models.Document.objects.readable_per_se(user)
|
|
.order_by("path")
|
|
.values_list("path", flat=True)
|
|
)
|
|
readable_attachments_paths = utils.filter_descendants(
|
|
[doc.path for doc in attachments_documents],
|
|
readable_per_se_paths,
|
|
skip_sorting=True,
|
|
)
|
|
|
|
readable_attachments = set()
|
|
for document in attachments_documents:
|
|
if document.path not in readable_attachments_paths:
|
|
continue
|
|
readable_attachments.update(set(document.attachments) & new_attachments)
|
|
|
|
# Update attachments with readable keys
|
|
self.validated_data["attachments"] = list(
|
|
existing_attachments | readable_attachments
|
|
)
|
|
|
|
return super().save(**kwargs)
|
|
|
|
|
|
class ServerCreateDocumentSerializer(serializers.Serializer):
|
|
"""
|
|
Serializer for creating a document from a server-to-server request.
|
|
|
|
Expects 'content' as a markdown string, which is converted to our internal format
|
|
via a Node.js microservice. The conversion is handled automatically, so third parties
|
|
only need to provide markdown.
|
|
|
|
Both "sub" and "email" are required because the external app calling doesn't know
|
|
if the user will pre-exist in Docs database. If the user pre-exist, we will ignore the
|
|
submitted "email" field and use the email address set on the user account in our database
|
|
"""
|
|
|
|
# Document
|
|
title = serializers.CharField(required=True)
|
|
content = serializers.CharField(required=True)
|
|
# User
|
|
sub = serializers.CharField(
|
|
required=True, validators=[models.User.sub_validator], max_length=255
|
|
)
|
|
email = serializers.EmailField(required=True)
|
|
language = serializers.ChoiceField(
|
|
required=False, choices=lazy(lambda: settings.LANGUAGES, tuple)()
|
|
)
|
|
# Invitation
|
|
message = serializers.CharField(required=False)
|
|
subject = serializers.CharField(required=False)
|
|
|
|
def create(self, validated_data):
|
|
"""Create the document and associate it with the user or send an invitation."""
|
|
language = validated_data.get("language", settings.LANGUAGE_CODE)
|
|
|
|
# Get the user on its sub (unique identifier). Default on email if allowed in settings
|
|
email = validated_data["email"]
|
|
|
|
try:
|
|
user = models.User.objects.get_user_by_sub_or_email(
|
|
validated_data["sub"], email
|
|
)
|
|
except models.DuplicateEmailError as err:
|
|
raise serializers.ValidationError({"email": [err.message]}) from err
|
|
|
|
if user:
|
|
email = user.email
|
|
language = user.language or language
|
|
|
|
try:
|
|
document_content = YdocConverter().convert_markdown(
|
|
validated_data["content"]
|
|
)
|
|
except ConversionError as err:
|
|
raise serializers.ValidationError(
|
|
{"content": ["Could not convert content"]}
|
|
) from err
|
|
|
|
document = models.Document.add_root(
|
|
title=validated_data["title"],
|
|
content=document_content,
|
|
creator=user,
|
|
)
|
|
|
|
if user:
|
|
# Associate the document with the pre-existing user
|
|
models.DocumentAccess.objects.create(
|
|
document=document,
|
|
role=models.RoleChoices.OWNER,
|
|
user=user,
|
|
)
|
|
else:
|
|
# The user doesn't exist in our database: we need to invite him/her
|
|
models.Invitation.objects.create(
|
|
document=document,
|
|
email=email,
|
|
role=models.RoleChoices.OWNER,
|
|
)
|
|
|
|
self._send_email_notification(document, validated_data, email, language)
|
|
return document
|
|
|
|
def _send_email_notification(self, document, validated_data, email, language):
|
|
"""Notify the user about the newly created document."""
|
|
subject = validated_data.get("subject") or _(
|
|
"A new document was created on your behalf!"
|
|
)
|
|
context = {
|
|
"message": validated_data.get("message")
|
|
or _("You have been granted ownership of a new document:"),
|
|
"title": subject,
|
|
}
|
|
document.send_email(subject, [email], context, language)
|
|
|
|
def update(self, instance, validated_data):
|
|
"""
|
|
This serializer does not support updates.
|
|
"""
|
|
raise NotImplementedError("Update is not supported for this serializer.")
|
|
|
|
|
|
class LinkDocumentSerializer(serializers.ModelSerializer):
|
|
"""
|
|
Serialize link configuration for documents.
|
|
We expose it separately from document in order to simplify and secure access control.
|
|
"""
|
|
|
|
class Meta:
|
|
model = models.Document
|
|
fields = [
|
|
"link_role",
|
|
"link_reach",
|
|
]
|
|
|
|
|
|
class DocumentDuplicationSerializer(serializers.Serializer):
|
|
"""
|
|
Serializer for duplicating a document.
|
|
Allows specifying whether to keep access permissions.
|
|
"""
|
|
|
|
with_accesses = serializers.BooleanField(default=False)
|
|
|
|
def create(self, validated_data):
|
|
"""
|
|
This serializer is not intended to create objects.
|
|
"""
|
|
raise NotImplementedError("This serializer does not support creation.")
|
|
|
|
def update(self, instance, validated_data):
|
|
"""
|
|
This serializer is not intended to update objects.
|
|
"""
|
|
raise NotImplementedError("This serializer does not support updating.")
|
|
|
|
|
|
# Suppress the warning about not implementing `create` and `update` methods
|
|
# since we don't use a model and only rely on the serializer for validation
|
|
# pylint: disable=abstract-method
|
|
class FileUploadSerializer(serializers.Serializer):
|
|
"""Receive file upload requests."""
|
|
|
|
file = serializers.FileField()
|
|
|
|
def validate_file(self, file):
|
|
"""Add file size and type constraints as defined in settings."""
|
|
# Validate file size
|
|
if file.size > settings.DOCUMENT_IMAGE_MAX_SIZE:
|
|
max_size = settings.DOCUMENT_IMAGE_MAX_SIZE // (1024 * 1024)
|
|
raise serializers.ValidationError(
|
|
f"File size exceeds the maximum limit of {max_size:d} MB."
|
|
)
|
|
|
|
extension = file.name.rpartition(".")[-1] if "." in file.name else None
|
|
|
|
# Read the first few bytes to determine the MIME type accurately
|
|
mime = magic.Magic(mime=True)
|
|
magic_mime_type = mime.from_buffer(file.read(1024))
|
|
file.seek(0) # Reset file pointer to the beginning after reading
|
|
self.context["is_unsafe"] = False
|
|
if settings.DOCUMENT_ATTACHMENT_CHECK_UNSAFE_MIME_TYPES_ENABLED:
|
|
self.context["is_unsafe"] = (
|
|
magic_mime_type in settings.DOCUMENT_UNSAFE_MIME_TYPES
|
|
)
|
|
|
|
extension_mime_type, _ = mimetypes.guess_type(file.name)
|
|
|
|
# Try guessing a coherent extension from the mimetype
|
|
if extension_mime_type != magic_mime_type:
|
|
self.context["is_unsafe"] = True
|
|
|
|
guessed_ext = mimetypes.guess_extension(magic_mime_type)
|
|
# Missing extensions or extensions longer than 5 characters (it's as long as an extension
|
|
# can be) are replaced by the extension we eventually guessed from mimetype.
|
|
if (extension is None or len(extension) > 5) and guessed_ext:
|
|
extension = guessed_ext[1:]
|
|
|
|
if extension is None:
|
|
raise serializers.ValidationError("Could not determine file extension.")
|
|
|
|
self.context["expected_extension"] = extension
|
|
self.context["content_type"] = magic_mime_type
|
|
self.context["file_name"] = file.name
|
|
|
|
return file
|
|
|
|
def validate(self, attrs):
|
|
"""Override validate to add the computed extension to validated_data."""
|
|
attrs["expected_extension"] = self.context["expected_extension"]
|
|
attrs["is_unsafe"] = self.context["is_unsafe"]
|
|
attrs["content_type"] = self.context["content_type"]
|
|
attrs["file_name"] = self.context["file_name"]
|
|
return attrs
|
|
|
|
|
|
class TemplateSerializer(serializers.ModelSerializer):
|
|
"""Serialize templates."""
|
|
|
|
abilities = serializers.SerializerMethodField(read_only=True)
|
|
accesses = TemplateAccessSerializer(many=True, read_only=True)
|
|
|
|
class Meta:
|
|
model = models.Template
|
|
fields = [
|
|
"id",
|
|
"title",
|
|
"accesses",
|
|
"abilities",
|
|
"css",
|
|
"code",
|
|
"is_public",
|
|
]
|
|
read_only_fields = ["id", "accesses", "abilities"]
|
|
|
|
def get_abilities(self, document) -> dict:
|
|
"""Return abilities of the logged-in user on the instance."""
|
|
request = self.context.get("request")
|
|
if request:
|
|
return document.get_abilities(request.user)
|
|
return {}
|
|
|
|
|
|
# pylint: disable=abstract-method
|
|
class DocumentGenerationSerializer(serializers.Serializer):
|
|
"""Serializer to receive a request to generate a document on a template."""
|
|
|
|
body = serializers.CharField(label=_("Body"))
|
|
body_type = serializers.ChoiceField(
|
|
choices=["html", "markdown"],
|
|
label=_("Body type"),
|
|
required=False,
|
|
default="html",
|
|
)
|
|
format = serializers.ChoiceField(
|
|
choices=["pdf", "docx"],
|
|
label=_("Format"),
|
|
required=False,
|
|
default="pdf",
|
|
)
|
|
|
|
|
|
class InvitationSerializer(serializers.ModelSerializer):
|
|
"""Serialize invitations."""
|
|
|
|
abilities = serializers.SerializerMethodField(read_only=True)
|
|
|
|
class Meta:
|
|
model = models.Invitation
|
|
fields = [
|
|
"id",
|
|
"abilities",
|
|
"created_at",
|
|
"email",
|
|
"document",
|
|
"role",
|
|
"issuer",
|
|
"is_expired",
|
|
]
|
|
read_only_fields = [
|
|
"id",
|
|
"abilities",
|
|
"created_at",
|
|
"document",
|
|
"issuer",
|
|
"is_expired",
|
|
]
|
|
|
|
def get_abilities(self, invitation) -> dict:
|
|
"""Return abilities of the logged-in user on the instance."""
|
|
request = self.context.get("request")
|
|
if request:
|
|
return invitation.get_abilities(request.user)
|
|
return {}
|
|
|
|
def validate(self, attrs):
|
|
"""Validate invitation data."""
|
|
request = self.context.get("request")
|
|
user = getattr(request, "user", None)
|
|
|
|
attrs["document_id"] = self.context["resource_id"]
|
|
|
|
# Only set the issuer if the instance is being created
|
|
if self.instance is None:
|
|
attrs["issuer"] = user
|
|
|
|
return attrs
|
|
|
|
def validate_role(self, role):
|
|
"""Custom validation for the role field."""
|
|
request = self.context.get("request")
|
|
user = getattr(request, "user", None)
|
|
document_id = self.context["resource_id"]
|
|
|
|
# If the role is OWNER, check if the user has OWNER access
|
|
if role == models.RoleChoices.OWNER:
|
|
if not models.DocumentAccess.objects.filter(
|
|
Q(user=user) | Q(team__in=user.teams),
|
|
document=document_id,
|
|
role=models.RoleChoices.OWNER,
|
|
).exists():
|
|
raise serializers.ValidationError(
|
|
"Only owners of a document can invite other users as owners."
|
|
)
|
|
|
|
return role
|
|
|
|
|
|
class VersionFilterSerializer(serializers.Serializer):
|
|
"""Validate version filters applied to the list endpoint."""
|
|
|
|
version_id = serializers.CharField(required=False, allow_blank=True)
|
|
page_size = serializers.IntegerField(
|
|
required=False, min_value=1, max_value=50, default=20
|
|
)
|
|
|
|
|
|
class AITransformSerializer(serializers.Serializer):
|
|
"""Serializer for AI transform requests."""
|
|
|
|
action = serializers.ChoiceField(choices=AI_ACTIONS, required=True)
|
|
text = serializers.CharField(required=True)
|
|
|
|
def validate_text(self, value):
|
|
"""Ensure the text field is not empty."""
|
|
|
|
if len(value.strip()) == 0:
|
|
raise serializers.ValidationError("Text field cannot be empty.")
|
|
return value
|
|
|
|
|
|
class AITranslateSerializer(serializers.Serializer):
|
|
"""Serializer for AI translate requests."""
|
|
|
|
language = serializers.ChoiceField(
|
|
choices=tuple(enums.ALL_LANGUAGES.items()), required=True
|
|
)
|
|
text = serializers.CharField(required=True)
|
|
|
|
def validate_text(self, value):
|
|
"""Ensure the text field is not empty."""
|
|
|
|
if len(value.strip()) == 0:
|
|
raise serializers.ValidationError("Text field cannot be empty.")
|
|
return value
|
|
|
|
|
|
class MoveDocumentSerializer(serializers.Serializer):
|
|
"""
|
|
Serializer for validating input data to move a document within the tree structure.
|
|
|
|
Fields:
|
|
- target_document_id (UUIDField): The ID of the target parent document where the
|
|
document should be moved. This field is required and must be a valid UUID.
|
|
- position (ChoiceField): Specifies the position of the document in relation to
|
|
the target parent's children.
|
|
Choices:
|
|
- "first-child": Place the document as the first child of the target parent.
|
|
- "last-child": Place the document as the last child of the target parent (default).
|
|
- "left": Place the document as the left sibling of the target parent.
|
|
- "right": Place the document as the right sibling of the target parent.
|
|
|
|
Example:
|
|
Input payload for moving a document:
|
|
{
|
|
"target_document_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
"position": "first-child"
|
|
}
|
|
|
|
Notes:
|
|
- The `target_document_id` is mandatory.
|
|
- The `position` defaults to "last-child" if not provided.
|
|
"""
|
|
|
|
target_document_id = serializers.UUIDField(required=True)
|
|
position = serializers.ChoiceField(
|
|
choices=enums.MoveNodePositionChoices.choices,
|
|
default=enums.MoveNodePositionChoices.LAST_CHILD,
|
|
)
|