Paginação

Os endpoints que possuem paginação retornam respostas no seguinte padrão:

{
  "{colecao}": [Item],
  "pagina-seguinte": string (opcional),
  "pagina-anterior": string (opcioanl)
}

E aceitam, pelo menos, os URL query parameters pagina-seguinte, pagina-anterior e limite.

O nome do parâmetro de cada coleção varia e deve ser consultado para cada endpoint.

Os valores em pagina-seguinte e pagina-anterior são strings que devem ser informadas como URL query parameters para realizar a paginação no sentido desejado. Quando um deles não está presente na resposta, significa que, momentaneamente, não existem mais resultados naquela direção.

Exemplo

GET /sagas/v1/endpoint-com-paginacao?limite=3
{
  "itens": [1, 2, 3],
  "pagina-seguinte": "abc"
}

// avançando na paginação
GET /sagas/v1/endpoint-com-paginacao?limite=3&pagina-seguinte=abc
{
  "itens": [4, 5, 6],
  "pagina-seguinte": "def",
  "pagina-anterior": "cba"
}

// retornando na paginação
GET /sagas/v1/endpoint-com-paginacao?limite=3&pagina-anterior=cba
{
  "itens": [1, 2, 3],
  "pagina-seguinte": "abc"
}