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

refactor: API response #344

Merged
merged 11 commits into from
Dec 18, 2023
Merged

refactor: API response #344

merged 11 commits into from
Dec 18, 2023

Conversation

pranalidhanavade
Copy link
Contributor

@pranalidhanavade pranalidhanavade commented Dec 13, 2023

What

  1. API response refactoring for the following APIs in Users module:
  • Fetch login user details.
  • Fetch organization invitations.
  1. Checked API response, dto validations and promise return type, for all API's in user module.

@nishad-ayanworks
Copy link
Contributor

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue 0 Security Hotspots No data about Coverage 0.0% Duplication on New Code

See analysis details on SonarCloud

@pranalidhanavade Check the sonar cloud issue.

@nishad-ayanworks
Copy link
Contributor

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue 0 Security Hotspots No data about Coverage 0.0% Duplication on New Code

See analysis details on SonarCloud

@pranalidhanavade Check the sonar cloud issue

Signed-off-by: pranalidhanavade <[email protected]>
Signed-off-by: pranalidhanavade <[email protected]>
@pranalidhanavade pranalidhanavade removed the enhancement New feature or request label Dec 14, 2023
apps/user/interfaces/user.interface.ts Outdated Show resolved Hide resolved
supabaseUserId?: string,
userOrgRoles?: object
export interface UInvitation {
orgRoles?: OrgRole[];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Every parameter in an interface can not be optional. Please have mandatory parameters by removing "?"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

}
export interface UpdateUserProfile {
id: string,
export interface UserI {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use meaningful names for interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

userOrgRoles?: object;
}

export interface InvitationsI {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use meaningful names for interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

password: string;
}

export interface UserWhereUniqueInput {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use meaningful names for interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

id?: string;
}

export interface UserWhereInput {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use meaningful names for interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

lastName: string;
isPublic: boolean;
}
export interface PlatformSettingsI {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's follow consistency in Interface naming convention. Please remove "I" at the end of interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

@@ -0,0 +1,9 @@
export interface User_Activity {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's follow consistency in Interface naming convention.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved.

@ajile-in
Copy link
Contributor

@pranalidhanavade , @nishad-ayanworks Let's stick to standard naming conventions.

Copy link

sonarcloud bot commented Dec 15, 2023

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@vivekayanworks vivekayanworks merged commit bf3c732 into develop Dec 18, 2023
2 checks passed
@pranalidhanavade pranalidhanavade deleted the refactor-api-response branch March 7, 2024 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants