Update voyage/features endpoints to follow RESTful api naming convention #123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… ideations to include "teams" for better organization and clarity fix(features.controller.ts): update route path for creating and retrieving features to include "teams" for better organization and clarity fix(ideations.e2e-spec.ts): update route paths for creating, retrieving, updating, and deleting ideations to include "teams" for better organization and clarity fix(techs.e2e-spec.ts): update route paths for retrieving, creating, voting, and deleting techs to include "teams" for better organization and clarity The changes were made to update the route paths in the codebase to include "teams" for better organization and clarity. This improves the readability and maintainability of the code by clearly indicating that these routes are related to teams.
… to follow API naming convention The voyages endpoint paths have been refactored to follow the API naming convention. This improves consistency and readability of the codebase.
cherylli
reviewed
Mar 26, 2024
|
Hi, Tim! Read the files seems all good. I checkout to this branch to run the tests but I'm getting this error: Are you getting the same? |
yes, I did get something similar.it seems running |
…e userId as a route parameter instead of a query parameter feat(users.controller.ts): add POST route for getUserDetailsByEmail to allow looking up user details by email The route path for getUserDetailsById has been fixed to use the userId as a route parameter instead of a query parameter. This improves the semantics and makes the route more RESTful. Additionally, a new POST route has been added for getUserDetailsByEmail to allow looking up user details by email. The email is now passed in the request body instead of the route parameter. This change provides a more secure and flexible way of passing sensitive information.
…mprove clarity
The error message in the NotFoundException has been updated to provide a clearer description of the issue. Instead of mentioning "User (email: ${email} not found", it now says "User with ${email} not found". This change improves the readability and understanding of the error message.
cherylli
reviewed
Mar 27, 2024
feat(users): add HttpCode decorator to getUserDetailsByEmail endpoint to return 200 status code fix(users): fix error message in getUserDetailsByEmail endpoint feat(users): update getUserDetailsByEmail service method to accept UserLookupByEmailDto The UserLookupByEmailDto class is added to handle the request payload for looking up a user by email. The getUserDetailsByEmail endpoint is updated with the HttpCode decorator to return a 200 status code. The error message in the getUserDetailsByEmail endpoint is fixed to include the correct email syntax. The getUserDetailsByEmail service method is updated to accept the UserLookupByEmailDto object instead of just the email string.
… for isEmail from class-validator The import and function call for isEmail from class-validator have been removed as they are no longer used in the code. This improves code readability and removes unnecessary dependencies.
JoshuaHinman
approved these changes
Mar 27, 2024
Thank you |
cherylli
approved these changes
Mar 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
refactor(app.module.ts): update route paths for resources, techs, and ideations to include "teams" for better organization and clarity
fix(features.controller.ts): update route path for creating and retrieving features to include "teams" for better organization and clarity
fix(ideations.e2e-spec.ts): update route paths for creating, retrieving, updating, and deleting ideations to include "teams" for better organization and clarity
fix(techs.e2e-spec.ts): update route paths for retrieving, creating, voting, and deleting techs to include "teams" for better organization and clarity
The changes were made to update the voyages route paths in the codebase to include "teams" for better organization and clarity. This improves the readability and maintainability of the code by clearly indicating that these routes are related to teams.
Issue link
Fixes # (issue)
Type of change
How Has This Been Tested?
I have tested these changes with unit tests and e2e tests. Also I viewed the changes in swagger too.
Checklist:
Useful links
API Naming conventions
Voyage – Features
POST /api/v1/voyages/{teamId}/features => /api/v1/voyages/teams/{teamId}/features
GET /api/v1/voyages/{teamId}/features => /api/v1/voyages/teams/{teamId}/features
Voyage – Ideations
POST /api/v1/voyages/{teamId}/ideations => /api/v1/voyages/teams/{teamId}/ideations
GET /api/v1/voyages/{teamId}/ideations => /api/v1/voyages/teams/{teamId}/ideations
POST /api/v1/voyages/{teamId}/ideations/{ideationsId}/ideation-votes => /api/v1/voyages/teams/{teamId}/ideations/{ideationsId}/ideation-votes
DELETE /api/v1/voyages/{teamId}/ideations/{ideationsId}/ideation-votes => /api/v1/voyages/teams/{teamId}/ideations/{ideationsId}/ideation-votes
PATCH /api/v1/voyages/{teamId}/ideations/{ideationsId} => /api/v1/voyages/teams/{teamId}/ideations/{ideationsId}
DELETE /api/v1/voyages/{teamId}/ideations/{ideationsId} => /api/v1/voyages/teams/{teamId}/ideations/{ideationsId}
Voyage – Resources
POST /api/v1/voyages/{teamId}/resources => /api/v1/voyages/teams/{teamId}/resources
GET /api/v1/voyages/{teamId}/resources => /api/v1/voyages/teams/{teamId}/resources
PATCH /api/v1/voyages/{teamId}/resources/{resourceId} => /api/v1/voyages/teams/{teamId}/resources/{resourceId}
DELETE /api/v1/voyages/{teamId}/resources/{resourceId} => /api/v1/voyages/teams/{teamId}/resources/{resourceId}
Voyage – Techs
POST /api/v1/voyages/{teamId}/techs => /api/v1/voyages/teams/{teamId}/techs
GET /api/v1/voyages/{teamId}/techs=> /api/v1/voyages/teams/{teamId}/techs
POST /api/v1/voyages/{teamId}/techs/{teamTechId} => /api/v1/voyages/teams/{teamId}/techs/{teamTechId}
DELETE /api/v1/voyages/{teamId}/techs/{teamTechId} => /api/v1/voyages/teams/{teamId}/techs/{teamTechId}
users
GET /api/v1/users/id/{userId} => /api/v1/users/{userId}
GET /api/v1/users/email/{email} => POST /api/v1/users/lookup-by-email (email is in the request body)
here is Chingu voyages endpoints changes.docx