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

Backend REST API Consistency Restructure #162

Merged
merged 6 commits into from
Feb 27, 2024

Conversation

SeriousHorncat
Copy link
Collaborator

@SeriousHorncat SeriousHorncat commented Feb 16, 2024

Checklist before requesting a review

  • I have performed a self-review of my code.
  • My code follows the style guidelines enforced by static analysis tools.
  • If it is a core feature, I have added thorough tests.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • Will this be part of a product update? If yes, please write one phrase about this update.

Pull Request Details

Wrike Ticket - Revise API Routes according to proposal to better define resources and sub-resources and their relationships

Changes made:

  • Restructured the REST API to consistently establish relationships with a resource and its sub-resources.
  • Delete methods no longer have a 'body' within them
  • Backend unit testing completely relies on fixtures from the backend fixtures; Removed dependency of the initial database seed
  • Each analysis fixture used for unit testing in the backend is collected to build the collections; this way it is easier to find the correct analysis the unit test is using
  • System tests rely on fixtures within the system tests for images and documents

Updates affected the full stack from unit to system-level testing.

To Review:

  • Static Analysis by Reviewer
  • Run Unit Tests for front and backend locally
  • Run E2E System Tests locally
  • Review the new organization with the API Docs Rosalution API Docs Local Deployment
  • All GitHub Actions checks have passed

Screenshots

image

image

@SeriousHorncat SeriousHorncat marked this pull request as ready for review February 16, 2024 21:12
@fatimarabab
Copy link
Collaborator

All tests passed - frontend unit tests, backend unit and integration tests, system tests.
Screenshot 2024-02-22 at 2 51 02 PM
Screenshot 2024-02-22 at 2 51 13 PM
Screenshot 2024-02-22 at 2 51 25 PM
Screenshot 2024-02-22 at 2 52 04 PM

Copy link
Collaborator

@fatimarabab fatimarabab left a comment

Choose a reason for hiding this comment

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

Looks great! Excited to get this in! :)

@JmScherer
Copy link
Collaborator

System Tests

Screenshot 2024-02-22 at 3 30 00 PM

Frontend Unit Tests

Screenshot 2024-02-22 at 3 26 46 PM

Backend Unit Tests

Screenshot 2024-02-22 at 3 25 35 PM

Backend Integration Tests

Screenshot 2024-02-22 at 3 26 12 PM

@JmScherer
Copy link
Collaborator

Screenshot 2024-02-22 at 3 37 08 PM

Screenshot 2024-02-22 at 3 37 17 PM

Screenshot 2024-02-22 at 3 37 26 PM

Screenshot 2024-02-22 at 3 37 34 PM

Copy link
Collaborator

@JmScherer JmScherer left a comment

Choose a reason for hiding this comment

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

Nothing sticks out and everything runs as it should. This PR was massive!

@SeriousHorncat SeriousHorncat merged commit e0acc4a into main Feb 27, 2024
8 checks passed
@SeriousHorncat SeriousHorncat deleted the backend-api-analysis-restructure branch February 27, 2024 19:26
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.

3 participants