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

fix: standardized response parameter #345

Merged

Conversation

Ajinx1
Copy link
Contributor

@Ajinx1 Ajinx1 commented Aug 10, 2024

Description

This PR updates the response body structure of the request to ensure consistency and conformity across the entire application. The changes aim to standardize how responses are formatted, making them easier to understand, consume, and same format with other teams.

Key Changes:

  • Unified Response Structure: The response body now follows a standardized format, ensuring that all responses include status_code, message, and data fields.
  • Consistent Status Codes: Updated the response status codes to align with other teams response body.

Related Issue (Link to Github issue)

No related issue link provided.

How Has This Been Tested?

The updated response structure was tested across various endpoints to ensure consistency with other teams

Tests Performed:

  • Unit Tests: Validated that all endpoints return the updated response structure.
  • Integration Tests: Ensured that the new response format works seamlessly across different modules and services.
  • Manual Testing: Verified the changes in a staging environment, checking for correct implementation and no unintended side effects.

Screenshots (if appropriate - Postman, etc):

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@Cyberguru1 Cyberguru1 merged commit 9060a21 into hngprojects:dev Aug 10, 2024
4 of 5 checks passed
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.

2 participants