adiciona paginação na doc de jogos olímpicos

codante-io · Jul 31, 2024 · d651491 · d651491
1 parent e385fed
commit d651491
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/app/olympic-games-english/page.mdx b/src/app/olympic-games-english/page.mdx
@@ -27,7 +27,7 @@ The base URL for the Codante.io request API is `https://apis.codante.io/olympic-
 
 ## List of Games/Events {{ tag: 'GET', label: '/events' }}
 
-This is the main endpoint of the API. Lists all events, with filtering options. It brings, for each event, the competitors, the venue, the date, the name of the event, the flag if the event is happening now, among others.
+This is the main endpoint of the API. Lists all events, with filtering options. It brings, for each event, the competitors, the venue, the date, the name of the event, the flag if the event is happening now, among others. The list is paginated and can be filtered by country, discipline, venue, date, competitor and page.
 
 <Row>
   <Col>
@@ -50,6 +50,9 @@ This is the main endpoint of the API. Lists all events, with filtering options.
     <Property name="competitor" type="string">
       Filter by competitor name or team name in case of team games.
     </Property>
+    <Property name="page" type="integer">
+      Page number. Default is 1.
+    </Property>
   </Properties>
 
   </Col>

diff --git a/src/app/olympic-games/page.mdx b/src/app/olympic-games/page.mdx
@@ -27,7 +27,7 @@ A URL base para a API de pedidos do Codante.io é `https://apis.codante.io/olymp
 
 ## Lista de Jogos/Eventos {{ tag: 'GET', label: '/events' }}
 
-Este é o endpoint principal da API. Lista todos os eventos, com opções de filtro. Traz, para cada evento os competidores, o local, a data, o nome do evento, a flag se o evento está acontecendo agora, dentre outros. 
+Este é o endpoint principal da API. Lista todos os eventos, com opções de filtro. Traz, para cada evento os competidores, o local, a data, o nome do evento, a flag se o evento está acontecendo agora, dentre outros. Esse endpoint é paginado e traz 10 eventos por página.
 
 <Row>
   <Col>
@@ -50,6 +50,9 @@ Este é o endpoint principal da API. Lista todos os eventos, com opções de fil
     <Property name="competitor" type="string">
       Filtra por nome do competidor ou nome da equipe em casos de jogos de equipes.
     </Property>
+      <Property name="page" type="number">
+      Filtra por página. Padrão é 1.
+    </Property>
   </Properties>
 
   </Col>