Skip to content

API: add project name/slug filters #9843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 5, 2023
Merged

API: add project name/slug filters #9843

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ad27181
API: add project name/slug filters
agjohnson Dec 23, 2022
e6c3883
Lint
agjohnson Dec 23, 2022
27a6520
Add missing fixture
agjohnson Dec 24, 2022
e2eafdf
Remove print statement
agjohnson Jan 3, 2023
002ffc6
Add comment on changing filter fields
agjohnson Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/user/api/v3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ Projects list
}]
}

:query string name: return projects with matching name
:query string slug: return projects with matching slug
:query string language: language code as ``en``, ``es``, ``ru``, etc.
:query string programming_language: programming language code as ``py``, ``js``, etc.

Expand Down
8 changes: 6 additions & 2 deletions readthedocs/api/v3/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@


class ProjectFilter(filters.FilterSet):
name = filters.CharFilter(lookup_expr="icontains")
slug = filters.CharFilter(lookup_expr="icontains")

class Meta:
model = Project
fields = [
'language',
'programming_language',
"name",
"slug",
"language",
"programming_language",
]


Expand Down
6 changes: 6 additions & 0 deletions readthedocs/api/v3/tests/responses/projects-list-empty.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"count": 0,
"next": null,
"previous": null,
"results": []
}
43 changes: 43 additions & 0 deletions readthedocs/api/v3/tests/test_projects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,49 @@ def test_projects_list(self):
self._get_response_dict('projects-list'),
)

def test_projects_list_filter_full_hit(self):
self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
response = self.client.get(
reverse("projects-list"),
data={
"name": self.project.name,
},
)
self.assertEqual(response.status_code, 200)
self.assertDictEqual(
response.json(),
self._get_response_dict("projects-list"),
)

def test_projects_list_filter_partial_hit(self):
self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
response = self.client.get(
reverse("projects-list"),
data={
"name": self.project.name[0:3],
},
)
self.assertEqual(response.status_code, 200)
self.assertDictEqual(
response.json(),
self._get_response_dict("projects-list"),
)

def test_projects_list_filter_miss(self):
self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
response = self.client.get(
reverse("projects-list"),
data={
"name": "63dadecd5323d789cafe09f01cda85fd",
},
)
print(response.request)
self.assertEqual(response.status_code, 200)
self.assertDictEqual(
response.json(),
self._get_response_dict("projects-list-empty"),
)

def test_own_projects_detail(self):
self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
response = self.client.get(
Expand Down