Move documentation from /docs
into root /
#461
Merged
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
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 associatedApiOperation
andApiOkResponse
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