CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-18 17:24:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

API: Allow to filter enabled webhooks (Z#23160605)

Browse Source
This commit is contained in:
Raphael Michel
2024-07-25 10:48:56 +02:00
parent f055a598ce
commit 8fe136b374
3 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/resources/webhooks.rst
View File

@@ -116,6 +116,7 @@ Endpoints
} }
:query integer page: The page number in case of a multi-page result set, default is 1 :query integer page: The page number in case of a multi-page result set, default is 1
:query boolean enabled: Only show webhooks that are or are not enabled
:param organizer: The ``slug`` field of the organizer to fetch :param organizer: The ``slug`` field of the organizer to fetch
:statuscode 200: no error :statuscode 200: no error
:statuscode 401: Authentication failure :statuscode 401: Authentication failure

8
src/pretix/api/views/webhooks.py
View File

@@ -19,6 +19,8 @@
# You should have received a copy of the GNU Affero General Public License along with this program. If not, see # You should have received a copy of the GNU Affero General Public License along with this program. If not, see
# <https://www.gnu.org/licenses/>. # <https://www.gnu.org/licenses/>.
# #
import django_filters
from django_filters.rest_framework import FilterSet, DjangoFilterBackend
from rest_framework import viewsets from rest_framework import viewsets
from pretix.api.models import WebHook from pretix.api.models import WebHook
@@ -26,11 +28,17 @@ from pretix.api.serializers.webhooks import WebHookSerializer
from pretix.helpers.dicts import merge_dicts from pretix.helpers.dicts import merge_dicts
class EventFilter(FilterSet):
enabled = django_filters.rest_framework.BooleanFilter()
class WebHookViewSet(viewsets.ModelViewSet): class WebHookViewSet(viewsets.ModelViewSet):
serializer_class = WebHookSerializer serializer_class = WebHookSerializer
queryset = WebHook.objects.none() queryset = WebHook.objects.none()
permission = 'can_change_organizer_settings' permission = 'can_change_organizer_settings'
write_permission = 'can_change_organizer_settings' write_permission = 'can_change_organizer_settings'
filter_backends = (DjangoFilterBackend,)
filterset_class = EventFilter
def get_queryset(self): def get_queryset(self):
return self.request.organizer.webhooks.prefetch_related('listeners') return self.request.organizer.webhooks.prefetch_related('listeners')

5
src/tests/api/test_webhooks.py
View File

@@ -60,6 +60,11 @@ def test_hook_list(token_client, organizer, event, webhook):
assert resp.status_code == 200 assert resp.status_code == 200
assert [res] == resp.data['results'] assert [res] == resp.data['results']
resp = token_client.get('/api/v1/organizers/{}/webhooks/?enabled=true'.format(organizer.slug))
assert [res] == resp.data['results']
resp = token_client.get('/api/v1/organizers/{}/webhooks/?enabled=false'.format(organizer.slug))
assert [] == resp.data['results']
@pytest.mark.django_db @pytest.mark.django_db
def test_hook_detail(token_client, organizer, event, webhook): def test_hook_detail(token_client, organizer, event, webhook):