From 53a1ecf96443ffbbfbd2e4538f5261f6ffbe4b16 Mon Sep 17 00:00:00 2001
From: Carlos Santos <4a.santos@gmail.com>
Date: Fri, 11 Apr 2025 11:23:52 +0200
Subject: [PATCH] backend: Add maxItems field to success-get-rooms response for
 pagination control

---
 .../openapi/components/responses/success-get-rooms.yaml  | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/backend/openapi/components/responses/success-get-rooms.yaml b/backend/openapi/components/responses/success-get-rooms.yaml
index d051aff..655d9e8 100644
--- a/backend/openapi/components/responses/success-get-rooms.yaml
+++ b/backend/openapi/components/responses/success-get-rooms.yaml
@@ -17,6 +17,11 @@ content:
                         nextPageToken:
                             type: [string, 'null']
                             description: The token to retrieve the next page of rooms.
+                        maxItems:
+                            type: integer
+                            description: >
+                                Maximum number of rooms returned in a single response page.
+                                Corresponds to the `maxItems` query parameter in the request.
 
         examples:
             complete_room_details:
@@ -51,6 +56,7 @@ content:
                           publisherURL: 'http://localhost:6080/room/room-456/?secret=tok_789012'
                     pagination:
                         isTruncated: false
+                        maxItems: 10
             roomId_fields_only:
                 summary: Response with only roomId for each room
                 value:
@@ -59,6 +65,7 @@ content:
                         - roomId: 'room-456'
                     pagination:
                         isTruncated: false
+                        maxItems: 10
 
             no_urls:
                 summary: Room details including preferences but no URLs
@@ -89,6 +96,7 @@ content:
                     pagination:
                         isTruncated: true
                         nextPageToken: 'abc123'
+                        maxItems: 10
 
             urls_only:
                 summary: Response containing only moderator and publisher URLs
@@ -100,3 +108,4 @@ content:
                           publisherURL: 'http://localhost:6080/room/room-456/?secret=tok_789012'
                     pagination:
                         isTruncated: false
+                        maxItems: 10