Adiciona detalhamento do motivo_id nos endpoints de cancelamento (V1 e V2) - #25
Open
Mateus-Fernandes284 wants to merge 2 commits into
Open
Adiciona detalhamento do motivo_id nos endpoints de cancelamento (V1 e V2)#25Mateus-Fernandes284 wants to merge 2 commits into
Mateus-Fernandes284 wants to merge 2 commits into
Conversation
Mateus-Fernandes284
dismissed
gaudinho[bot]’s stale review
July 3, 2026 21:50
The base branch was changed.
Author
|
/gaudinho review |
|
✅ Review postada — #25 (review) job_id: |
There was a problem hiding this comment.
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.
Mateus-Fernandes284
requested review from
JRaphaelO,
Joao-Dutra-Gaudium,
byhugoleo-gaudium,
lucas-silva-gaudium and
marcos-marques-gaudium
July 6, 2026 11:40
lucas-silva-gaudium
approved these changes
Jul 6, 2026
Joao-Dutra-Gaudium
approved these changes
Jul 6, 2026
Contributor
|
@Mateus-Fernandes284 Ajusta os conflitos, por favor. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resumo
motivo_iddiretamente 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).motivo_idna V2, evitando envio de valores inválidos (V1 já possuía o enum, agora completo).motivo_idcomo camporequiredno endpoint de cancelamento de entregas da V2 (estava ausente do array required).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 campomotivo_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 tabelamotivo_cancelamento(20 linhas) foi usada como fonte de verdade para corrigir as quatro documentações.Arquivos alterados
pages/v1/openapi.jsonpages/v1/openapi-entregas.jsonpages/v2/openapi.jsonpages/v2/openapi-entregas.json