Skip to content

Issue 6225: Allow multiple periods in Assignments API routes - #8128

Open
sophia-huynh wants to merge 3 commits into
masterfrom
issue-6225-api-nested-parameters
Open

Issue 6225: Allow multiple periods in Assignments API routes#8128
sophia-huynh wants to merge 3 commits into
masterfrom
issue-6225-api-nested-parameters

Conversation

@sophia-huynh

@sophia-huynh sophia-huynh commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Proposed Changes

Updated the POST /api/courses/:course_id/assignments and PUT /api/courses/:course_id/assignments/:id API routes to accept the parameters submission_rule_type and submission_rule_periods, the latter allowing for one or more submission rule periods.

While there was formerly an implementation that would allow for a single submission rule to be included with a single period, this did not work and was undocumented. When the related parameters were provided, no errors were raised, but no updates were made. The related parameters have been removed and replaced with submission_rule_periods, as they weren't documented or functional in the first place.

Closes #6225

Screenshots of your changes (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality) X
🐛 Bug fix (non-breaking change that fixes an issue) X
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
📖 Documentation update (change that updates documentation)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

Formerly, there were checks for submission_rule.valid? which never succeeded due to the relationships/dependencies between submission rules, periods, and assignments. Thus, the rules were never updated (and the code within the conditional also wouldn't work correctly), and then a success was returned afterwards.

@coveralls

coveralls commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 31405301677

Coverage increased (+0.04%) to 90.664%

Details

  • Coverage increased (+0.04%) from the base build.
  • Patch coverage: 2 uncovered changes across 1 file (89 of 91 lines covered, 97.8%).
  • No coverage regressions found.

Uncovered Changes

File Changed Covered %
app/controllers/api/assignments_controller.rb 27 25 92.59%
Total (2 files) 91 89 97.8%

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 51815
Covered Lines: 47997
Line Coverage: 92.63%
Relevant Branches: 2491
Covered Branches: 1239
Branch Coverage: 49.74%
Branches in Coverage %: Yes
Coverage Strength: 129.58 hits per line

💛 - Coveralls

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.

Allow Assignments API routes to accept nested parameters for SubmissionRules

2 participants