Skip to content

Adiciona detalhamento do motivo_id nos endpoints de cancelamento (V1 e V2) - #25

Open
Mateus-Fernandes284 wants to merge 2 commits into
mainfrom
hotfix/especifica-motivo-cancelamento
Open

Adiciona detalhamento do motivo_id nos endpoints de cancelamento (V1 e V2)#25
Mateus-Fernandes284 wants to merge 2 commits into
mainfrom
hotfix/especifica-motivo-cancelamento

Conversation

@Mateus-Fernandes284

@Mateus-Fernandes284 Mateus-Fernandes284 commented Jul 3, 2026

Copy link
Copy Markdown

Resumo

  • Documenta os 20 valores possíveis de motivo_id diretamente no schema do campo, cobrindo os endpoints de cancelamento de corridas (pages/v1/openapi.json, pages/v2/openapi.json) e entregas (pages/v1/openapi-entregas.json, pages/v2/openapi-entregas.json).
  • Corrige um gap na numeração (14, 15 e 20 estavam ausentes da descrição e do enum) presente tanto na V1 quanto na V2, pois, os seguintes motivos nunca haviam sido documentados:
    • 14: Despachado na plataforma do iFood
    • 15: Cancelado via iFood
    • 20: Cancelado por redistribuição
  • Adiciona enum com os 20 valores válidos de motivo_id na V2, evitando envio de valores inválidos (V1 já possuía o enum, agora completo).
  • Marca motivo_id como campo required no endpoint de cancelamento de entregas da V2 (estava ausente do array required).
  • Adiciona example (motivo_id: 3) no endpoint de cancelamento da V2 para entregas (corridas já possui) para facilitar o uso via "Try it".

Motivação

A documentação da V2 apenas indicava o tipo (integer) do campo motivo_id, sem explicar o significado de cada motivo, diferente da V1, que já detalhava os motivos de cancelamento tanto para corridas quanto para entregas. Ao portar o detalhamento da V1 para a V2, foi identificado que a própria V1 tinha um gap na sequência (13 -> 16, pulando 14, 15 e 20), então a tabela motivo_cancelamento (20 linhas) foi usada como fonte de verdade para corrigir as quatro documentações.

Arquivos alterados

  • pages/v1/openapi.json
  • pages/v1/openapi-entregas.json
  • pages/v2/openapi.json
  • pages/v2/openapi-entregas.json

@Mateus-Fernandes284 Mateus-Fernandes284 self-assigned this Jul 3, 2026
@Mateus-Fernandes284 Mateus-Fernandes284 added the documentation Improvements or additions to documentation label Jul 3, 2026
@gaudiumsoftware gaudiumsoftware deleted a comment from gaudinho Bot Jul 3, 2026
gaudinho[bot]
gaudinho Bot previously approved these changes Jul 3, 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.

PR de documentação bem executado: preenche o gap dos motivos 14, 15 e 20 nas 4 specs OpenAPI, alinha description + enum e usa a tabela motivo_cancelamento como fonte de verdade. Diff mínimo, JSONs válidos e mudanças coerentes com o PR body.

@Mateus-Fernandes284
Mateus-Fernandes284 changed the base branch from dev to main July 3, 2026 21:50
@Mateus-Fernandes284
Mateus-Fernandes284 dismissed gaudinho[bot]’s stale review July 3, 2026 21:50

The base branch was changed.

@Mateus-Fernandes284

Copy link
Copy Markdown
Author

/gaudinho review

@gaudinho

gaudinho Bot commented Jul 3, 2026

Copy link
Copy Markdown

✅ Review postada — #25 (review)

job_id: mintlify-docs-25-1783115443533-cec5

@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 OpenAPI consistente entre V1/V2 (corridas e entregas), preenche o gap real dos motivos 14, 15 e 20 usando a tabela motivo_cancelamento como fonte de verdade, adiciona enum + example na V2 e marca motivo_id como required no cancelamento de entregas V2. Diff mínimo, sem risco de segurança/correctness.

Comment thread pages/v2/openapi.json
Comment thread pages/v1/openapi.json
@jfelipends

Copy link
Copy Markdown
Contributor

@Mateus-Fernandes284 Ajusta os conflitos, por favor.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants