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

Event API: Add search parameter (#2088)

Browse Source 
The events API is paginated with 50 events. When searching for a
specific event within a large Pretix installations UX becomes very bad.
Using this filter users are able to quickly find their event by slug or
their name/location in any language.
This commit is contained in:
Maico Timmerman
2021-06-03 09:25:45 +02:00
committed by GitHub
parent 47df6fe2bc
commit 71e7df3038
3 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/api/resources/events.rst
View File

@@ -88,6 +88,8 @@ Endpoints
The ``with_availability_for`` parameter has been added.
The ``search`` query parameter has been added to filter events by their slug, name, or location in any language.
.. http:get:: /api/v1/organizers/(organizer)/events/
Returns a list of all events within a given organizer the authenticated user/token has access to.
@@ -170,6 +172,7 @@ Endpoints
attribute with values of 100 for "tickets available", values less than 100 for "tickets sold out or reserved",
and ``null`` for "status unknown". These values might be served from a cache. This parameter can make the response
slow.
:query search: Only return events matching a given search query.
:param organizer: The ``slug`` field of a valid organizer
:statuscode 200: no error
:statuscode 401: Authentication failure