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

Move documentation from /docs into root / #461

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Move documentation from /docs into root / #461

merged 2 commits into from
Nov 20, 2024

Conversation

fityannugroho
Copy link
Owner

PR Checklist

Please check if your PR fulfills the following requirements:

Put [x] to check

  • The commit message follows our Contributing Guidelines
  • Tests for the changes have been added (optional, for bug fixes or features)
  • Docs have been added / updated (optional, for bug fixes or features)

PR Type

What kind of change does this PR introduce?

Please check any kind of changes that applies to this PR using [x]

  • Bug fix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes

What is the current behavior?

Please describe the current behavior that you are modifying, or link to a relevant issue.

Issue Number: N/A

Move the documentation to the root to make it more accessible.

What is the new behavior?

This pull request includes several changes to the API's base route and health check, as well as updates to the API documentation and tests. The most important changes include the removal of the base route endpoint, modification of the API documentation path, and updates to the test cases.

Removal of base route endpoint:

  • src/app.controller.ts: Removed the base route endpoint and its associated ApiOperation and ApiOkResponse decorators.

Modification of API documentation path:

  • src/main.ts: Changed the API documentation path from /docs to /.

Updates to test cases:

  • test/app.e2e-spec.ts: Replaced the test case for the base route (/) with a test case for the health check endpoint (/health).

Other information

This is BREAKING CHANGES

@fityannugroho fityannugroho added documentation Improvements or additions to documentation breaking changes Changes that will break the current app labels Nov 20, 2024
@fityannugroho fityannugroho merged commit 6295ee9 into main Nov 20, 2024
11 checks passed
@fityannugroho fityannugroho deleted the move-docs branch November 20, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking changes Changes that will break the current app documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant