From 9a368d70d8f83bdf67f32e917560880e821f015b Mon Sep 17 00:00:00 2001 From: Mira Date: Fri, 26 Jul 2024 17:14:39 +0200 Subject: [PATCH] Clarify API docs --- doc/api/resources/seats.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/resources/seats.rst b/doc/api/resources/seats.rst index 8753435679..22633f917f 100644 --- a/doc/api/resources/seats.rst +++ b/doc/api/resources/seats.rst @@ -78,7 +78,8 @@ Endpoints shown as a nested value instead of just an ID. The nested objects are identical to the respective resources, except that order positions will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make - matching easier. The parameter can be given multiple times. + matching easier, and won't include the `seat` attribute, as that would be redundant. + The parameter can be given multiple times. :param organizer: The ``slug`` field of the organizer to fetch :param event: The ``slug`` field of the event to fetch :param subevent_id: The ``id`` field of the subevent to fetch @@ -120,7 +121,8 @@ Endpoints shown as a nested value instead of just an ID. The nested objects are identical to the respective resources, except that order positions will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make - matching easier. The parameter can be given multiple times. + matching easier, and won't include the `seat` attribute, as that would be redundant. + The parameter can be given multiple times. :statuscode 200: no error :statuscode 401: Authentication failure :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.