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.

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

[AFA-7] Add documentation #8

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[AFA-7] Add documentation #8

wants to merge 3 commits into from

Conversation

ricardopacheco
Copy link
Owner

Issue number: resolves #7

Summary 🔴

The idea is to be able to document endpoints following structure standards. For later ease and also to be well known and versatile, we will use swagger as a documentation standard for the endpoints, using the rswag dependency, also already integrated with integration tests (dispensing with current functional tests directly in the controllers).

Proposed / Possible solution 🔴

  • Install and configure rswag and its dependencies in the project.

Checklist

  • Install and configure rswag and its dependencies in the project.
  • Document existing endpoints;
  • Remove functional tests in controllers;

Additional

  • Configure git hooks with overcommit to run necessary actions before a commit;
  • Configure development setup to automatically install overcommit;
  • Configure overcommit with the necessary options.

@ricardopacheco ricardopacheco added priority:high High priority status:in-review In Review status type:improvement A suggestion for general improvements labels Apr 30, 2024
@ricardopacheco ricardopacheco self-assigned this Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:high High priority status:in-review In Review status type:improvement A suggestion for general improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation
1 participant