API: add ?full_name= icontains filter on RemoteRepository (#10551)

* API: add `?full_name=` icontains filter on RemoteRepository

This allows to perform queries like:

 * http://devthedocs.org/api/v3/remote/repositories/?full_name=getnikola
 * http://devthedocs.org/api/v3/remote/repositories/?full_name=readthedocs&expand=projects

Closes #10513

* API: add test case for `?full_name=` filter

* Docs: update APIv3 query parameters to add `full_name`

Author: humitos

docs/user/api/v3.rst

@@ -1852,6 +1852,7 @@ Remote repository listing
     The ``results`` in response is an array of remote repositories data.
 
     :query string name: return remote repositories containing the name
+    :query string full_name: return remote repositories containing the full name (it inclues the username/organization the project belongs to)
     :query string vcs_provider: return remote repositories for specific vcs provider (``github``, ``gitlab`` or ``bitbucket``)
     :query string organization: return remote repositories for specific remote organization (using remote organization ``slug``)
     :query string expand: allows to add/expand some extra fields in the response.

readthedocs/api/v3/filters.py

@@ -60,15 +60,17 @@ def get_running(self, queryset, name, value):
 
 
 class RemoteRepositoryFilter(filters.FilterSet):
-    name = filters.CharFilter(field_name='name', lookup_expr='icontains')
-    organization = filters.CharFilter(field_name='organization__slug')
+    name = filters.CharFilter(field_name="name", lookup_expr="icontains")
+    full_name = filters.CharFilter(field_name="full_name", lookup_expr="icontains")
+    organization = filters.CharFilter(field_name="organization__slug")
 
     class Meta:
         model = RemoteRepository
         fields = [
-            'name',
-            'vcs_provider',
-            'organization',
+            "name",
+            "full_name",
+            "vcs_provider",
+            "organization",
         ]
 
 

readthedocs/api/v3/tests/test_remoterepositories.py

@@ -103,3 +103,19 @@ def test_remote_repository_list_name_filter(self):
             response_data,
             self._get_response_dict('remoterepositories-list'),
         )
+
+    def test_remote_repository_list_full_name_filter(self):
+        self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
+        response = self.client.get(
+            reverse("remoterepositories-list"),
+            {"expand": ("projects," "remote_organization"), "full_name": "proj"},
+        )
+        self.assertEqual(response.status_code, 200)
+
+        response_data = response.json()
+        self.assertEqual(len(response_data["results"]), 1)
+
+        self.assertDictEqual(
+            response_data,
+            self._get_response_dict("remoterepositories-list"),
+        )