From d65149173845d1342100b558f9ecb9f899044a5b Mon Sep 17 00:00:00 2001 From: Roberto Cestari Date: Wed, 31 Jul 2024 10:54:45 -0300 Subject: [PATCH] =?UTF-8?q?adiciona=20pagina=C3=A7=C3=A3o=20na=20doc=20de?= =?UTF-8?q?=20jogos=20ol=C3=ADmpicos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/app/olympic-games-english/page.mdx | 5 ++++- src/app/olympic-games/page.mdx | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/app/olympic-games-english/page.mdx b/src/app/olympic-games-english/page.mdx index 93e9355..5e1bcea 100644 --- 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. @@ -50,6 +50,9 @@ This is the main endpoint of the API. Lists all events, with filtering options. Filter by competitor name or team name in case of team games. + + Page number. Default is 1. + diff --git a/src/app/olympic-games/page.mdx b/src/app/olympic-games/page.mdx index 3e529aa..1a74d95 100644 --- 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. @@ -50,6 +50,9 @@ Este é o endpoint principal da API. Lista todos os eventos, com opções de fil Filtra por nome do competidor ou nome da equipe em casos de jogos de equipes. + + Filtra por página. Padrão é 1. +