Skip to content

doc: add the documents for state holidays#545

Open
VictorVendrera wants to merge 1 commit intoBrasilAPI:mainfrom
Regijur:doc/add-statewide-holydays-documentation
Open

doc: add the documents for state holidays#545
VictorVendrera wants to merge 1 commit intoBrasilAPI:mainfrom
Regijur:doc/add-statewide-holydays-documentation

Conversation

@VictorVendrera
Copy link
Copy Markdown

No description provided.

@vercel
Copy link
Copy Markdown

vercel bot commented Nov 30, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
brasilapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 30, 2023 8:56am

@sonarqubecloud
Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Copy Markdown
Collaborator

@RodriAndreotti RodriAndreotti left a comment

Choose a reason for hiding this comment

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

Esse PR depende de algum outro PR para ser poder subir?

},
"name": {
"type": "string",
"format": "int32"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

int32 não deveria ser usado só para tipos numéricos?

@lucianopf
Copy link
Copy Markdown
Member

Olá @VictorVendrera, documentar endpoints é muito bem-vindo! Mas há um problema: este PR documenta o endpoint /feriados/v1/{ano}/{uf} que ainda não existe na codebase.

A prática no projeto é que a documentação OpenAPI acompanhe o PR de implementação — não ser separada. Isso garante que docs e código permanecem sincronizados.

Sugestão: aguardar a implementação ser mergeada (ex: PR #552 que implementa feriados estaduais) e então contribuir com docs, ou abrir um PR que inclua tanto a implementação quanto a documentação.

Outros ajustes necessários:

  • Typo no nome do arquivo: statewideHolydays.jsonstatewideHolidays.json
  • "name": { "type": "string", "format": "int32" }format: int32 é para números, não strings. Remova o format ou mude para um valor correto.
  • Os exemplos de erro estão incompletos — falta o campo "name" (ex: "name": "BadRequestError"), que é padrão nas respostas de erro da BrasilAPI.

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