Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[api] Aplicar DRY principle nos arquivos da documentação #471

Closed
alessandrofeitoza opened this issue Jan 6, 2025 · 0 comments · Fixed by #541
Closed

[api] Aplicar DRY principle nos arquivos da documentação #471

alessandrofeitoza opened this issue Jan 6, 2025 · 0 comments · Fixed by #541
Assignees
@jeff-doliveira1

Comments

@alessandrofeitoza
Copy link
Member

WHAT

Atualmente a documentação dos endpoints (swagger) possui muito conteúdo repetido, seria bom identificar os casos e isolá-los a fim de reduzir a repetitividade.

HOW

Talvez criando arquivos incomum para serem reutilizados.

EXAMPLE

  • /public/docs/components/requestBodies/faq/FaqPatchItemRequest.yaml
  • /public/docs/components/requestBodies/faq/FaqPostItemRequest.yaml
@alessandrofeitoza alessandrofeitoza converted this from a draft issue Jan 6, 2025
@jeff-doliveira1 jeff-doliveira1 self-assigned this Jan 6, 2025
@jeff-doliveira1 jeff-doliveira1 moved this from SPRINT BACKLOG to TODO in Aurora Jan 6, 2025
@jeff-doliveira1 jeff-doliveira1 moved this from TODO to IN PROGRESS in Aurora Jan 14, 2025
@jeff-doliveira1 jeff-doliveira1 mentioned this issue Jan 15, 2025
Merged
@jeff-doliveira1 jeff-doliveira1 moved this from IN PROGRESS to REVIEW in Aurora Jan 17, 2025
@alessandrofeitoza alessandrofeitoza moved this from REVIEW to DONE in Aurora Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jeff-doliveira1 jeff-doliveira1

Labels
None yet
Projects
Aurora
Status: DONE
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation refactoring secultce/aurora
2 participants
@alessandrofeitoza @jeff-doliveira1