fix: corrige erros estruturais, identação, semânticos e de validação#5
Open
gfLobo wants to merge 2 commits into
Open
fix: corrige erros estruturais, identação, semânticos e de validação#5gfLobo wants to merge 2 commits into
gfLobo wants to merge 2 commits into
Conversation
- Resolve erro estrutural em `/eleicao/estados/{ano}/ano` definindo
corretamente `items` como um objeto com a propriedade `uf`, em vez de
passar a propriedade diretamente no array.
- Renomeia o schema `Eleição` para `Eleicao` em `components.schemas`,
pois nomes de componentes suportam apenas caracteres A-Z a-z 0-9 - . _
- Corrige os apontamentos de `$ref` em `/eleicao/ordinarias` e
`/eleicao/suplementares/{ano}/{uf}` para usar `#/components/schemas/Eleicao`,
resolvendo o erro de URI não compatível com a RFC3986 (remoção de caracteres especiais).
- Altera o `operationId` da rota `/eleicao/suplementares/{ano}/{uf}`
para garantir unicidade, resolvendo o conflito com a rota `/eleicao/estados/{ano}/ano`
que utilizava o mesmo id (`eleicoes_suplementares_estados`).
gfLobo
changed the title
gfLobo
changed the title
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
1 participant
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.
Atual
O swagger estava reclamando um pouco dos caracteres especiais e métodos com mesmo nome.
Structural error at paths./eleicao/estados/{ano}/ano.get.responses.200.content.application/json.schema.items
should NOT have additional properties
additionalProperty: uf
Jump to line 170
Semantic error at paths./eleicao/ordinarias.get.responses.200.content.application/json.schema.items.$ref
$ref values must be RFC3986-compliant percent-encoded URIs
Jump to line 251
Semantic error at paths./eleicao/suplementares/{ano}/{uf}.get.operationId
Operations must have unique operationIds.
Jump to line 261
Semantic error at paths./eleicao/suplementares/{ano}/{uf}.get.responses.200.content.application/json.schema.items.$ref
$ref values must be RFC3986-compliant percent-encoded URIs
Jump to line 285
Semantic error at components.schemas.Eleição
Component names can only contain the characters A-Z a-z 0-9 - . _
Jump to line 1051
Correções
/eleicao/estados/{ano}/anodefinindo corretamenteitemscomo um objeto com a propriedadeuf, em vez de passar a propriedade diretamente no array.EleiçãoparaEleicaoemcomponents.schemas, pois nomes de componentes suportam apenas caracteres A-Z a-z 0-9 - . _$refem/eleicao/ordinariase/eleicao/suplementares/{ano}/{uf}para usar#/components/schemas/Eleicao, resolvendo o erro de URI não compatível com a RFC3986 (remoção de caracteres especiais).operationIdda rota/eleicao/suplementares/{ano}/{uf}para garantir unicidade, resolvendo o conflito com a rota/eleicao/estados/{ano}/anoque utilizava o mesmo id (eleicoes_suplementares_estados).