Skip to content

[codex] Atualiza limites da API de integração#4

Open
jfelipends wants to merge 4 commits into
mainfrom
codex/docs-rate-limit-integracao
Open

[codex] Atualiza limites da API de integração#4
jfelipends wants to merge 4 commits into
mainfrom
codex/docs-rate-limit-integracao

Conversation

@jfelipends

@jfelipends jfelipends commented Jun 8, 2026

Copy link
Copy Markdown

O que mudou

  • Atualiza a seção de rate limit das introduções v1 e v2.
  • Documenta os grupos de paths da API de integração conforme mchapigw/etc/mchapigw.d/ratelimit-rules.yml.
  • Explicita o agrupamento por api-key e a exceção por int-key para integrador externo.

Impacto

  • A documentação passa a refletir os limites de bloqueio configurados no gateway.
  • Grupos que apenas geram log são marcados como sem bloqueio configurado.

Validação

  • `ruby -e 'require "json"; JSON.parse(File.read("docs.json")); JSON.parse(File.read("pages/v1/openapi.json")); JSON.parse(File.read("pages/v2/openapi.json")); puts "json ok"'
  • ruby -e 'ARGV.each { |f| s=File.read(f); abort("missing title in #{f}") unless s.match?(/^title:/); abort("unclosed table in #{f}") unless s.include?("| Padrão | /api/integracao/*|api-key | 1000 requisições por minuto |") }; puts "mdx smoke ok"' pages/v1/referencia/introducao.mdx pages/v2/referencia/introducao.mdx
  • git diff --check
  • mint broken-links com Node 24: falhou por link quebrado existente em essentials/images.mdx para /writing-content/embed.
  • Preview local validado em http://localhost:3000/pages/v2/referencia/introducao#rate-limit e http://localhost:3000/pages/v1/referencia/introducao#rate-limit.

@jfelipends jfelipends self-assigned this Jun 8, 2026
@jfelipends jfelipends marked this pull request as ready for review June 8, 2026 14:31
@gaudinho

gaudinho Bot commented Jun 8, 2026

Copy link
Copy Markdown

✅ Review postada — #4 (review)

job_id: mintlify-docs-4-1780929068142-f7fa

gaudinho[bot]
gaudinho Bot previously approved these changes Jun 8, 2026

@gaudinho gaudinho Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentação dos rate limits da API de integração foi atualizada para refletir os grupos configurados em mchapigw/etc/mchapigw.d/ratelimit-rules.yml, incluindo agrupamento por api-key/int-key e a nota sobre fatores multiplicadores. Diff mínimo, escopo claro e idêntico entre v1 e v2.

Comment thread pages/v2/referencia/introducao.mdx Outdated
Comment thread pages/v1/referencia/introducao.mdx
Comment thread pages/v1/referencia/introducao.mdx Outdated
Comment thread pages/v2/referencia/introducao.mdx Outdated
Comment thread pages/v1/referencia/introducao.mdx
@jfelipends

Copy link
Copy Markdown
Author

/gaudinho review

@gaudinho

gaudinho Bot commented Jun 8, 2026

Copy link
Copy Markdown

✅ Review postada — #4 (review)

job_id: mintlify-docs-4-1780932735622-ab66

@gaudinho gaudinho Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Atualização de documentação coerente com ratelimit-rules.yml do gateway: detalha grupos, agrupamento por api-key/int-key, multiplicadores e janela deslizante na v1; marca v2 como WIP. Diff mínimo, sem efeitos colaterais em código.

| -------- | -------- | -------- | -------- |
| Crítico | `/api/integracao/solicitacao`<br />`/api/integracao/solicitacaoStatus` | `api-key` | 800 requisições por minuto |
| Crítico por integrador externo | `/api/integracao/solicitacao`<br />`/api/integracao/solicitacaoStatus` | `int-key` | 800 requisições por minuto |
| Condutores e créditos | `/api/integracao/saldoCreditosCondutor`<br />`/api/integracao/saldoCreditosCondutor/`<br />`/api/integracao/condutor`<br />`/api/integracao/taxista` | `api-key` | 80 requisições por minuto |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit (Readability) — a entrada /api/integracao/saldoCreditosCondutor/ (com barra final) ao lado de /api/integracao/saldoCreditosCondutor parece redundante para o leitor humano da doc, mesmo que reflita literalmente o YAML do gateway. Considere consolidar em uma única linha (ex.: /api/integracao/saldoCreditosCondutor[/...]) ou adicionar nota curta explicando por que ambos aparecem, evitando dúvida sobre se é typo.

| Crítico por integrador externo | `/api/integracao/solicitacao`<br />`/api/integracao/solicitacaoStatus` | `int-key` | 800 requisições por minuto |
| Condutores e créditos | `/api/integracao/saldoCreditosCondutor`<br />`/api/integracao/saldoCreditosCondutor/`<br />`/api/integracao/condutor`<br />`/api/integracao/taxista` | `api-key` | 80 requisições por minuto |
| Posição do condutor | `/api/integracao/posicaoCondutor` | `api-key` | 1000 requisições por minuto |
| Categorias | `/integracao/v1/categoria*` | `api-key` | Sem bloqueio configurado. O gateway registra log a partir de 10 requisições por minuto. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit (Readability) — as duas linhas com Sem bloqueio configurado. O gateway registra log a partir de 10 requisições por minuto. repetem texto longo dentro da coluna Limite. Sugestão informativa: extrair como nota de rodapé abaixo da tabela e referenciar via marcador (ex.: Somente log¹), reduzindo ruído visual na tabela e facilitando manutenção quando o limiar mudar.

Os grupos mais específicos têm prioridade sobre o grupo padrão.
Os valores da tabela são limites base e podem variar por fatores multiplicadores configurados para cada chave e categoria.
O limite efetivo é calculado como `limite base * fator multiplicador`.
Quando não há fator específico, o fator padrão é `1`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sugestão (Readability) — o bloco explicativo sobre multiplicadores é útil, mas pode confundir integradores que não têm visibilidade dos fatores configurados. Vale uma frase curta dizendo onde/como o cliente consulta o multiplicador efetivo da chave dele (ou que o suporte deve ser contatado), para o leitor não ficar com a impressão de que o limite da tabela é o efetivo.

| -------- | -------- |
| `/api/integracao/cliente`<br />`/api/integracao/solicitacao`<br />`/api/integracao/posicaoCondutor`<br />`/api/integracao/posicaoMotorista`<br />`/api/integracao/abrirSolicitacao` | 100 requests por minuto |
| `/api/integracao/consultarProgramada`<br />`/api/integracao/condutor` | 200 requests por minuto |
As políticas e limites específicos de rate limit para os endpoints da v2 estão atualmente em desenvolvimento (*Work in Progress*). Esta seção será atualizada assim que as regras definitivas forem estabelecidas.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sugestão (Readability) — marcar a seção como WIP é honesto, mas remover a tabela antiga deixa integradores v2 sem nenhuma referência de limite até a definição final. Considere manter um limite default genérico ou apontar explicitamente para a tabela da v1 enquanto a v2 não tem regras próprias, evitando regressão de informação útil.

@marcos-marques-gaudium marcos-marques-gaudium left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho relevante deixar um quadro de Rate Limit na V2 baseado no da V1, enquanto estiver em WIP, pq o rate limit da V2 atualmente tem como teto os rate limits dos endpoints de V1, já que internamente é feito o redirecionamento das requests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants