feat: expose component locked state in component API

docs/api.rst

@@ -1297,6 +1297,7 @@ Components
     :>json string suggestion_voting: :ref:`component-suggestion_voting`
     :>json string suggestion_autoaccept: :ref:`component-suggestion_autoaccept`
     :>json string push_on_commit: :ref:`component-push_on_commit`
+    :>json bool locked: Whether component is locked, this field is read-only; see :http:get:`/api/components/(string:project)/(string:component)/lock/`
     :>json string commit_pending_age: :ref:`component-commit_pending_age`
     :>json string auto_lock_error: :ref:`component-auto_lock_error`
     :>json string language_regex: :ref:`component-language_regex`

docs/changes.rst

@@ -11,6 +11,7 @@ Not yet released.
 * A shortcut to duplicate a component is now available directly in the menu (:guilabel:`Manage` → :guilabel:`Duplicate Component`)
 * Included username when generating :ref:`credits`.
 * :ref:`bulk-edit` shows a preview of matched strings.
+* :http:get:`/api/components/(string:project)/(string:component)/` exposes component lock state.
 
 **Bug fixes**
 

weblate/api/serializers.py

@@ -82,7 +82,7 @@
         super().__init__(**kwargs)
         self.lookup_field = lookup_field
 
     def get_url(self, obj, view_name, request: AuthenticatedHttpRequest, format):  # noqa: A002
         """
         Given an object, return the URL that hyperlinks to the object.
 
@@ -273,7 +273,7 @@
         return data
 
 
 class RoleSerializer(serializers.ModelSerializer[Role]):
     permissions = PermissionSerializer(many=True)
 
     class Meta:
@@ -328,7 +328,7 @@
         many=True,
         read_only=True,
     )
     componentlists = serializers.HyperlinkedRelatedField(
         view_name="api:componentlist-detail",
         lookup_field="slug",
         many=True,
@@ -368,7 +368,7 @@
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         user = self.context["request"].user
         self.fields["defining_project"].queryset = user.managed_projects
 
 
 class ProjectSerializer(serializers.ModelSerializer[Project]):
@@ -432,7 +432,7 @@
     def get_attribute(self, instance):
         if instance.linked_component:
             instance = instance.linked_component
         return getattr(instance, self.source)
 
 
 class RepoField(LinkedField):
@@ -496,6 +496,7 @@
     push_branch = LinkedField(
         required=False, allow_blank=True, max_length=BRANCH_LENGTH
     )
+    locked = serializers.BooleanField(read_only=True)
 
     serializer_url_field = MultiFieldHyperlinkedIdentityField
 
@@ -595,6 +596,7 @@
             "disable_autoshare",
             "category",
             "linked_component",
+            "locked",
         )
         extra_kwargs = {
             "url": {
@@ -613,7 +615,7 @@
             project = kwargs["context"]["project"]
 
         if project is not None:
             self.fields["category"].queryset = project.category_set.all()
 
     def validate_enforced_checks(self, value):
         if not isinstance(value, list):
@@ -671,7 +673,7 @@
         if "project" in self._context:
             result["project"] = self._context["project"]
         elif self.instance:
             result["project"] = self.instance.project
 
         # Workaround for https://github.com/encode/django-rest-framework/issues/7489
         if "category" not in result:
@@ -703,14 +705,14 @@
         if docfile is not None or zipfile is not None:
             # Validate name/slug uniqueness, this has to be done prior docfile/zipfile
             # extracting
             instance.clean_unique_together()
 
             # Handle uploaded files
             if docfile is not None:
                 fake = create_component_from_doc(attrs, docfile)
                 instance.template = attrs["template"] = fake.template
                 instance.new_base = attrs["new_base"] = fake.template
                 instance.filemask = attrs["filemask"] = fake.filemask
             if zipfile is not None:
                 try:
                     create_component_from_zip(attrs, zipfile)