Section Create/Destroy API route #6873
Merged
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
Added a new api route for 'deleting' a section. This included creating a new sections_controller in the api sub-package, and specifying 'resources' line to the ~/config/routes.rb file (in the appropriate location so that the new api URI's look like .../courses/.../sections/...). I also created a new rspec_test testing the functionality of this new API route, e.g. for authorized vs unauthorized attempts.
Pull Request Test Coverage Report for Build 7236388337
💛 - Coveralls |
mimischly7
changed the title
There was a problem hiding this comment.
@mimischly7 @Bruce-8 good work. I left one inline comment. In addition to that, the Coveralls report suggests the need for an additional test case for the #delete route.
Added a rspec test for when an (authorized) instructor attempts to delete/destroy a 'non-empty' section (i.e. one that still has students). Includes slight correction in the controller for returning status codes. I used the :conflict status code for this scenario.
There was a problem hiding this comment.
@mimischly7 @Bruce-8 sorry one more thing, can you please make a PR to update the Wiki API page: https://github.com/MarkUsProject/Wiki/blob/master/RESTful-API.md
|
david-yz-liu
approved these changes
Dec 18, 2023
donny-wong
pushed a commit
to donny-wong/Markus
that referenced
this pull request
Jan 12, 2024
Co-authored-by: Bruce Liu <[email protected]>
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.
Motivation and Context
Currently, most models are associated with two different controllers, one "main" controller responsible for "business logic", and one api-controller mostly responsible for CRUD operations (on that model). The
Sectionmodel does not yet adhere to this pattern, hence this pull request, which includes a newapi/sections_controllercontroller, featuring a new api route responsible for creating and deleting a section.Your Changes
Description:
api/sections_controllerwith adestroyand 'create' action.~/config/routes.rbfile (in the appropriate location so that the new api URI's have the appropriate nested format, i.e. .../courses/.../sections/...).Type of change (select all that apply):
Testing
Created a new rspec file (
api/sections_controller_spec.rb) to test the functionality of this new API route, for authorized and unauthorized attempts.Questions and Comments (if applicable)
Checklist